[libcatmandu-perl] 82/85: Adding documentation on fh and fixes

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to tag 0.91
in repository libcatmandu-perl.

commit e43c659b684d7aa89450833c059f4217ffd21be5
Author: Patrick Hochstenbach <patrick.hochstenbach at ugent.be>
Date:   Tue May 20 06:41:19 2014 +0200

    Adding documentation on fh and fixes
---
 lib/Catmandu/Importer/CSV.pm  | 5 ++++-
 lib/Catmandu/Importer/JSON.pm | 7 +++++--
 lib/Catmandu/Importer/Mock.pm | 5 ++++-
 lib/Catmandu/Importer/YAML.pm | 5 ++++-
 4 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/lib/Catmandu/Importer/CSV.pm b/lib/Catmandu/Importer/CSV.pm
index fd70a00..bffd48f 100644
--- a/lib/Catmandu/Importer/CSV.pm
+++ b/lib/Catmandu/Importer/CSV.pm
@@ -72,12 +72,15 @@ Catmandu::Importer::CSV - Package that imports CSV data
 
 =head1 METHODS
 
-=head2 new(file => $filename, fields => \@fields, quote_char => "\"", sep_char => ",")
+=head2 new(file => $filename, fh = $fh, fields => \@fields, quote_char => "\"", sep_char => ",", fix => [...])
 
 Create a new CSV importer for $filename. Use STDIN when no filename is given. The
 object fields are read from the CSV header line or given via the 'fields' parameter.
 Strings in CSV are quoted by 'quote_char' and fields are separated by 'sep_char'.
 
+The constructor inherits the fix parameter from L<Catmandu::Fixable>. When given,
+then ech fix or fix script will be applied to imported items.
+
 =head2 count
 
 =head2 each(&callback)
diff --git a/lib/Catmandu/Importer/JSON.pm b/lib/Catmandu/Importer/JSON.pm
index 8486309..41b7256 100644
--- a/lib/Catmandu/Importer/JSON.pm
+++ b/lib/Catmandu/Importer/JSON.pm
@@ -79,12 +79,15 @@ Use the C<multiline> option to parse pretty-printed JSON or JSON arrays.
 
 =head1 METHODS
 
-=head2 new([file => $filename, multiline => 0|1])
+=head2 new(file => $filename , fh => $fh , multiline => 0|1 ,fix => [...])
 
 Create a new JSON importer for C<$filename>. Uses STDIN when no filename is given.
-C<multiline> switches between line-delimited JSON and multiline JSON or arrays.
+C<multiline> switches optionally between line-delimited JSON and multiline JSON or arrays.
 the default is line-delimited JSON.
 
+The constructor inherits the fix parameter from L<Catmandu::Fixable>. When given,
+then each fix or fix script will be applied to imported items.
+
 =head2 count
 
 =head2 each(&callback)
diff --git a/lib/Catmandu/Importer/Mock.pm b/lib/Catmandu/Importer/Mock.pm
index aa1e9e0..5606c2d 100644
--- a/lib/Catmandu/Importer/Mock.pm
+++ b/lib/Catmandu/Importer/Mock.pm
@@ -34,10 +34,13 @@ Catmandu::Importer::Mock - Mock importer used for testing purposes
 
 =head1 METHODS
 
-=head2 new(size => $n)
+=head2 new(size => $n, fix => [...])
 
 Create a new Mock importer. Optionally provide a size parameter.
 
+The constructor inherits the fix parameter from L<Catmandu::Fixable>. When given,
+then each fix or fix script will be applied to imported items.
+
 =head2 count
 
 =head2 each(&callback)
diff --git a/lib/Catmandu/Importer/YAML.pm b/lib/Catmandu/Importer/YAML.pm
index d94a04c..860c51f 100644
--- a/lib/Catmandu/Importer/YAML.pm
+++ b/lib/Catmandu/Importer/YAML.pm
@@ -68,10 +68,13 @@ Catmandu::Importer::YAML - Package that imports YAML data
 
 =head1 METHODS
 
-=head2 new([file => $filename])
+=head2 new(file => $filename, fh => $fh , fix => [...])
 
 Create a new YAML importer for $filename. Use STDIN when no filename is given.
 
+The constructor inherits the fix parameter from L<Catmandu::Fixable>. When given,
+then any fix or fix script will be applied to imported items.
+
 =head2 count
 
 =head2 each(&callback)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libcatmandu-perl.git