POD fixes.

rcaputo · May 25, 2011 · 087d339 · 087d339
1 parent c3c9eb9
commit 087d339
Show file tree

Hide file tree

Showing 29 changed files with 68 additions and 25 deletions.
diff --git a/README b/README
@@ -84,4 +84,4 @@ COPYRIGHT and LICENSE
 
 
 
-perl v5.10.0                      2011‐05‐23                App::PipeFilter(3)
+perl v5.10.0                      2011‐05‐24                App::PipeFilter(3)
diff --git a/bin/jcat b/bin/jcat
@@ -4,6 +4,8 @@ exit App::PipeFilter::JsonCat->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 jcat - concatenate and print JSON files

diff --git a/bin/jcut b/bin/jcut
@@ -4,6 +4,8 @@ exit App::PipeFilter::JsonCut->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 jcut - cut out selected portions of each JSON object in a file

diff --git a/bin/jmap b/bin/jmap
@@ -4,6 +4,8 @@ exit App::PipeFilter::JsonMap->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 jmap - map input JSON fields to output JSON fields by renaming them

diff --git a/bin/json2yaml b/bin/json2yaml
@@ -4,6 +4,8 @@ exit App::PipeFilter::JsonToYaml->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 json2yaml - convert files of JSON objects into a stream of YAML objects

diff --git a/bin/jsonpath b/bin/jsonpath
@@ -4,6 +4,8 @@ exit App::PipeFilter::JsonPath->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 jsonpath - use JSON::Path to cut out selected portions of JSON objects

diff --git a/bin/jsort b/bin/jsort
@@ -4,6 +4,8 @@ exit App::PipeFilter::JsonSort->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 jsort - sort input files of JSON objects on key fields

diff --git a/bin/mysql2json b/bin/mysql2json
@@ -4,6 +4,8 @@ exit App::PipeFilter::MysqlToJson->new_with_options()->run();
 
 __END__
 
+=pod
+
 =head1 NAME
 
 mysql2json - convert mysql -B output to JSON object streams

diff --git a/dist.ini b/dist.ini
@@ -1,5 +1,5 @@
-name              = App-PipeFilters
-version           = 0.001
+name              = App-PipeFilter
+version           = 0.002
 author            = Rocco Caputo <rcaputo@cpan.org>
 license           = Perl_5
 copyright_holder  = Rocco Caputo

diff --git a/lib/App/PipeFilter.pm b/lib/App/PipeFilter.pm
@@ -1,3 +1,5 @@
+=pod
+
 =head1 NAME
 
 App::PipeFilter

diff --git a/lib/App/PipeFilter/Generic.pm b/lib/App/PipeFilter/Generic.pm
@@ -36,6 +36,8 @@ sub filter_file {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::Generic - a generic pipeline filter

diff --git a/lib/App/PipeFilter/Generic/Json.pm b/lib/App/PipeFilter/Generic/Json.pm
@@ -14,6 +14,8 @@ with qw(
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::Generic::Json - a generic JSON pipeline filter

diff --git a/lib/App/PipeFilter/JsonCat.pm b/lib/App/PipeFilter/JsonCat.pm
@@ -8,6 +8,8 @@ with 'App::PipeFilter::Role::Transform::None';
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::JsonCat - useless use of cat(1) for JSON streams

diff --git a/lib/App/PipeFilter/JsonCut.pm b/lib/App/PipeFilter/JsonCut.pm
@@ -28,6 +28,8 @@ sub transform {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::JsonCut - return specified fields from a JSON stream

diff --git a/lib/App/PipeFilter/JsonMap.pm b/lib/App/PipeFilter/JsonMap.pm
@@ -44,10 +44,11 @@ sub transform {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::JsonMap - map input fields to output fields by
-renaming them
+App::PipeFilter::JsonMap - map input fields to output fields by renaming them
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/JsonPath.pm b/lib/App/PipeFilter/JsonPath.pm
@@ -46,10 +46,11 @@ sub transform {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::JsonPath - return JSON::Path-specified fields from a
-JSON stream
+App::PipeFilter::JsonPath - return JSON::Path-specified fields from a JSON stream
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/JsonSort.pm b/lib/App/PipeFilter/JsonSort.pm
@@ -69,10 +69,11 @@ sub encode_output {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::JsonSort - a sort(1)-like filter that understands
-JSON fields
+App::PipeFilter::JsonSort - a sort(1)-like filter that understands JSON fields
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/JsonToYaml.pm b/lib/App/PipeFilter/JsonToYaml.pm
@@ -15,10 +15,11 @@ with qw(
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::JsonToYaml - translate streams of JSON objects into
-YAML
+App::PipeFilter::JsonToYaml - translate streams of JSON objects into YAML
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/MysqlToJson.pm b/lib/App/PipeFilter/MysqlToJson.pm
@@ -36,6 +36,8 @@ sub decode_input {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::MysqlToJson - translate mysql batch output to JSON

diff --git a/lib/App/PipeFilter/Role/Flags/Standard.pm b/lib/App/PipeFilter/Role/Flags/Standard.pm
@@ -31,10 +31,11 @@ has verbose => (
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Flags::Standard - provide attributes and getopt
-parsing for standard pipeline filter flags
+App::PipeFilter::Role::Flags::Standard - standard flag attributes and getopt
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Input/Json.pm b/lib/App/PipeFilter/Role/Input/Json.pm
@@ -22,6 +22,8 @@ sub decode_input {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::Role::Input::Json - parse input as a stream of JSON records

diff --git a/lib/App/PipeFilter/Role/Opener/GenericIO.pm b/lib/App/PipeFilter/Role/Opener/GenericIO.pm
@@ -11,10 +11,11 @@ with qw(
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Opener::GenericIO - generic methods to open
-input and output filesj
+App::PipeFilter::Role::Opener::GenericIO - generic methods to open input and output files
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Opener/GenericInput.pm b/lib/App/PipeFilter/Role/Opener/GenericInput.pm
@@ -19,10 +19,11 @@ sub open_input {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Opener::GenericInput - a common method to open
-input files
+App::PipeFilter::Role::Opener::GenericInput - common method to open input files
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Opener/GenericOutput.pm b/lib/App/PipeFilter/Role/Opener/GenericOutput.pm
@@ -19,10 +19,11 @@ sub open_output {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Opener::GenericOutput - a generic method to
-open output files
+App::PipeFilter::Role::Opener::GenericOutput - a generic method to open output files
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Output/Json.pm b/lib/App/PipeFilter/Role/Output/Json.pm
@@ -13,10 +13,11 @@ sub encode_output {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Output::Json - serialize output as one JSON
-object per line
+App::PipeFilter::Role::Output::Json - serialize output as one JSON object per line
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Output/Yaml.pm b/lib/App/PipeFilter/Role/Output/Yaml.pm
@@ -13,6 +13,8 @@ sub encode_output {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::Role::Output::Yaml - serialize output as YAML

diff --git a/lib/App/PipeFilter/Role/Reader/LineByLine.pm b/lib/App/PipeFilter/Role/Reader/LineByLine.pm
@@ -12,10 +12,11 @@ sub read_input {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Reader::LineByLine - read input streams one
-line at a time
+App::PipeFilter::Role::Reader::LineByLine - read input streams one line at a time
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Reader/Sysread.pm b/lib/App/PipeFilter/Role/Reader/Sysread.pm
@@ -11,10 +11,11 @@ sub read_input {
 
 __END__
 
+=pod
+
 =head1 NAME
 
-App::PipeFilter::Role::Reader::Sysread - read input streams in large
-chunks for speed
+App::PipeFilter::Role::Reader::Sysread - read input streams in large chunks for speed
 
 =head1 SYNOPSIS
 

diff --git a/lib/App/PipeFilter/Role/Transform/None.pm b/lib/App/PipeFilter/Role/Transform/None.pm
@@ -11,6 +11,8 @@ sub transform {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 App::PipeFilter::Role::Transform::None - don't transform data at all