improved pod a little.
Marcus Ramberg [Mon, 5 Sep 2005 22:02:15 +0000 (22:02 +0000)]
lib/HTTP/Body.pm

index f0a75e1..8f9b482 100644 (file)
@@ -50,7 +50,12 @@ HTTP Body Parser.
 
 =head1 METHODS
 
-=over 4
+=over 4 
+
+=item new 
+
+Constructor. Takes content type and content length as parameters,
+returns a L<HTTP::Body> object.
 
 =cut
 
@@ -88,6 +93,9 @@ sub new {
 
 =item add
 
+Add string to itnernal buffer. Will call spin unless done. returns
+length before adding self.
+
 =cut
 
 sub add {
@@ -107,6 +115,8 @@ sub add {
 
 =item body
 
+accessor for the body.
+
 =cut
 
 sub body {
@@ -117,6 +127,8 @@ sub body {
 
 =item buffer
 
+read only accessor for the buffer.
+
 =cut
 
 sub buffer {
@@ -125,6 +137,8 @@ sub buffer {
 
 =item content_length
 
+read only accessor for content length
+
 =cut
 
 sub content_length {
@@ -133,6 +147,8 @@ sub content_length {
 
 =item content_type
 
+ready only accessor for the content type
+
 =cut
 
 sub content_type {
@@ -141,6 +157,8 @@ sub content_type {
 
 =item init
 
+return self.
+
 =cut
 
 sub init {
@@ -149,6 +167,8 @@ sub init {
 
 =item length
 
+read only accessor for body length.
+
 =cut
 
 sub length {
@@ -157,6 +177,8 @@ sub length {
 
 =item spin
 
+Abstract method to spin the io handle.
+
 =cut
 
 sub spin {
@@ -165,6 +187,8 @@ sub spin {
 
 =item state
 
+accessor for body state.
+
 =cut
 
 sub state {
@@ -175,6 +199,8 @@ sub state {
 
 =item param
 
+accesor for http parameters.
+
 =cut
 
 sub param {