[libhttp-entity-parser-perl] 05/11: doc

[gregor herrmann]

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

gregoa pushed a commit to tag 0.01
in repository libhttp-entity-parser-perl.

commit 057f3dbecf8a867634f0abacb0ab924b874cafba
Author: Masahiro Nagano <kazeburo at gmail.com>
Date:   Wed Feb 5 03:34:23 2014 +0900

    doc
---
 lib/HTTP/Entity/Parser/JSON.pm        | 31 ++++++++++++++++++++++++++++
 lib/HTTP/Entity/Parser/MultiPart.pm   | 37 ++++++++++++++++++++++++++++++++++
 lib/HTTP/Entity/Parser/OctetStream.pm | 38 +++++++++++++++++++++++++++++++++++
 lib/HTTP/Entity/Parser/UrlEncoded.pm  | 35 ++++++++++++++++++++++++++++++++
 4 files changed, 141 insertions(+)

diff --git a/lib/HTTP/Entity/Parser/JSON.pm b/lib/HTTP/Entity/Parser/JSON.pm
index 214e526..665a9c8 100644
--- a/lib/HTTP/Entity/Parser/JSON.pm
+++ b/lib/HTTP/Entity/Parser/JSON.pm
@@ -36,3 +36,34 @@ sub finalize {
 
 1;
 
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+HTTP::Entity::Parser::JSON - parser for application/json
+
+=head1 SYNOPSIS
+
+    use HTTP::Entity::Parser;
+    
+    my $parser = HTTP::Entity::Parser->new;
+    $parser->register('application/json','HTTP::Entity::Parser::JSON');
+
+=head1 LICENSE
+
+Copyright (C) Masahiro Nagano.
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Masahiro Nagano E<lt>kazeburo at gmail.comE<gt>
+
+Tokuhiro Matsuno E<lt>tokuhirom at gmail.comE<gt>
+
+=cut
+
+
diff --git a/lib/HTTP/Entity/Parser/MultiPart.pm b/lib/HTTP/Entity/Parser/MultiPart.pm
index 021a08b..c227d40 100644
--- a/lib/HTTP/Entity/Parser/MultiPart.pm
+++ b/lib/HTTP/Entity/Parser/MultiPart.pm
@@ -122,3 +122,40 @@ sub finalize {
 
 1;
 
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+HTTP::Entity::Parser::MultiPart - parser for multipart/form-data
+
+=head1 SYNOPSIS
+
+    use HTTP::Entity::Parser;
+    
+    my $parser = HTTP::Entity::Parser->new;
+    $parser->register('multipart/form-data','HTTP::Entity::Parser::MultiPart');
+
+=head1 DESCRIPTION
+
+This is a parser class for multipart/form-data.
+
+MultiPart parser use L<HTTP::MultiPartParser>.
+
+=head1 LICENSE
+
+Copyright (C) Masahiro Nagano.
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Masahiro Nagano E<lt>kazeburo at gmail.comE<gt>
+
+Tokuhiro Matsuno E<lt>tokuhirom at gmail.comE<gt>
+
+=cut
+
+
diff --git a/lib/HTTP/Entity/Parser/OctetStream.pm b/lib/HTTP/Entity/Parser/OctetStream.pm
index 4c6f119..770067f 100644
--- a/lib/HTTP/Entity/Parser/OctetStream.pm
+++ b/lib/HTTP/Entity/Parser/OctetStream.pm
@@ -16,3 +16,41 @@ sub finalize {
 
 1;
 
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+HTTP::Entity::Parser::OctetStream - parser for application/octet-stream
+
+=head1 SYNOPSIS
+
+    use HTTP::Entity::Parser;
+    
+    my $parser = HTTP::Entity::Parser->new;
+    my ($params, $uplaods) = $parser->parse($env); # [] , []
+
+=head1 DESCRIPTION
+
+This is a parser class for application/octet-stream and other.
+This is used as default parser.
+
+OctetStream always returns empty list.
+
+=head1 LICENSE
+
+Copyright (C) Masahiro Nagano.
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Masahiro Nagano E<lt>kazeburo at gmail.comE<gt>
+
+Tokuhiro Matsuno E<lt>tokuhirom at gmail.comE<gt>
+
+=cut
+
+
diff --git a/lib/HTTP/Entity/Parser/UrlEncoded.pm b/lib/HTTP/Entity/Parser/UrlEncoded.pm
index dba3fae..718705d 100644
--- a/lib/HTTP/Entity/Parser/UrlEncoded.pm
+++ b/lib/HTTP/Entity/Parser/UrlEncoded.pm
@@ -46,3 +46,38 @@ sub finalize {
 }
 
 1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+HTTP::Entity::Parser::MultiPart - parser for application/x-www-form-urlencoded
+
+=head1 SYNOPSIS
+
+    use HTTP::Entity::Parser;
+    
+    my $parser = HTTP::Entity::Parser->new;
+    $parser->register('application/x-www-form-urlencoded','HTTP::Entity::Parser::UrlEncoded');
+
+=head1 DESCRIPTION
+
+This is a parser class for application/x-www-form-urlencoded.
+
+=head1 LICENSE
+
+Copyright (C) Masahiro Nagano.
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Masahiro Nagano E<lt>kazeburo at gmail.comE<gt>
+
+Tokuhiro Matsuno E<lt>tokuhirom at gmail.comE<gt>
+
+=cut
+
+

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