stas 2003/10/02 09:28:47
Modified: perl-framework/Apache-Test/lib/Apache TestRequest.pm
Log:
turn =item into =head3, so they will end up in TOC in the htmlify doc
Submitted by: David Wheeler <[EMAIL PROTECTED]>
Revision Changes Path
1.87 +32 -37
httpd-test/perl-framework/Apache-Test/lib/Apache/TestRequest.pm
Index: TestRequest.pm
===================================================================
RCS file:
/home/cvs/httpd-test/perl-framework/Apache-Test/lib/Apache/TestRequest.pm,v
retrieving revision 1.86
retrieving revision 1.87
diff -u -u -r1.86 -r1.87
--- TestRequest.pm 17 Sep 2003 19:06:30 -0000 1.86
+++ TestRequest.pm 2 Oct 2003 16:28:47 -0000 1.87
@@ -768,24 +768,22 @@
=head2 The Functions
-=over 4
-
-=item GET
+=head3 GET
my $res = GET $uri;
Sends a simple GET request to the Apache test server. Returns an
C<HTTP::Response> object.
-=item GET_STR
+=head3 GET_STR
A shortcut function for C<< GET($uri)->as_string >>.
-=item GET_BODY
+=head3 GET_BODY
A shortcut function for C<< GET($uri)->content >>.
-=item GET_BODY_ASSERT
+=head3 GET_BODY_ASSERT
Use this function when your test is outputting content that you need
to check, and you want to make sure that the request was successful
@@ -794,15 +792,15 @@
message. Otherwise it will simply return the content of the request
just as C<GET_BODY> would.
-=item GET_OK
+=head3 GET_OK
A shortcut function for C<< GET($uri)->is_success >>.
-=item GET_RC
+=head3 GET_RC
A shortcut function for C<< GET($uri)->code >>.
-=item GET_HEAD
+=head3 GET_HEAD
Throws out the content of the request, and returns the string
representation of the request. Since the body has been thrown out, the
@@ -812,23 +810,23 @@
during your tests without interfering with the workings of
C<Test::Harness>.
-=item HEAD
+=head3 HEAD
my $res = HEAD $uri;
Sends a HEAD request to the Apache test server. Returns an
C<HTTP::Response> object.
-=item HEAD_STR
+=head3 HEAD_STR
A shortcut function for C<< HEAD($uri)->as_string >>.
-=item HEAD_BODY
+=head3 HEAD_BODY
A shortcut function for C<< HEAD($uri)->content >>. Of course, this
means that it will likely return nothing.
-=item HEAD_BODY_ASSERT
+=head3 HEAD_BODY_ASSERT
Use this function when your test is outputting content that you need
to check, and you want to make sure that the request was successful
@@ -837,15 +835,15 @@
message. Otherwise it will simply return the content of the request
just as C<HEAD_BODY> would.
-=item HEAD_OK
+=head3 HEAD_OK
A shortcut function for C<< GET($uri)->is_success >>.
-=item HEAD_RC
+=head3 HEAD_RC
A shortcut function for C<< GET($uri)->code >>.
-=item HEAD_HEAD
+=head3 HEAD_HEAD
Throws out the content of the request, and returns the string
representation of the request. Since the body has been thrown out, the
@@ -855,22 +853,22 @@
during your tests without interfering with the workings of
C<Test::Harness>.
-=item PUT
+=head3 PUT
my $res = PUT $uri;
Sends a simple PUT request to the Apache test server. Returns an
C<HTTP::Response> object.
-=item PUT_STR
+=head3 PUT_STR
A shortcut function for C<< PUT($uri)->as_string >>.
-=item PUT_BODY
+=head3 PUT_BODY
A shortcut function for C<< PUT($uri)->content >>.
-=item PUT_BODY_ASSERT
+=head3 PUT_BODY_ASSERT
Use this function when your test is outputting content that you need
to check, and you want to make sure that the request was successful
@@ -879,15 +877,15 @@
message. Otherwise it will simply return the content of the request
just as C<PUT_BODY> would.
-=item PUT_OK
+=head3 PUT_OK
A shortcut function for C<< PUT($uri)->is_success >>.
-=item PUT_RC
+=head3 PUT_RC
A shortcut function for C<< PUT($uri)->code >>.
-=item PUT_HEAD
+=head3 PUT_HEAD
Throws out the content of the request, and returns the string
representation of the request. Since the body has been thrown out, the
@@ -897,7 +895,7 @@
during your tests without interfering with the workings of
C<Test::Harness>.
-=item POST
+=head3 POST
my $res = POST $uri, arg => $val, arg2 => $val;
@@ -907,15 +905,15 @@
Parameters> will be submitted to the Apache test server as the POST
content.
-=item POST_STR
+=head3 POST_STR
A shortcut function for C<< POST($uri, @args)->content >>.
-=item POST_BODY
+=head3 POST_BODY
A shortcut function for C<< POST($uri, @args)->content >>.
-=item POST_BODY_ASSERT
+=head3 POST_BODY_ASSERT
Use this function when your test is outputting content that you need
to check, and you want to make sure that the request was successful
@@ -924,15 +922,15 @@
message. Otherwise it will simply return the content of the request
just as C<POST_BODY> would.
-=item POST_OK
+=head3 POST_OK
A shortcut function for C<< POST($uri, @args)->is_success >>.
-=item POST_RC
+=head3 POST_RC
A shortcut function for C<< POST($uri, @args)->code >>.
-=item POST_HEAD
+=head3 POST_HEAD
Throws out the content of the request, and returns the string
representation of the request. Since the body has been thrown out, the
@@ -942,7 +940,7 @@
during your tests without interfering with the workings of
C<Test::Harness>.
-=item UPLOAD
+=head3 UPLOAD
my $res = UPLOAD $uri, [EMAIL PROTECTED], filename => $filename;
@@ -962,11 +960,11 @@
in this case, you cannot pass other POST arguments to C<UPLOAD()> --
they would be ignored.
-=item UPLOAD_BODY
+=head3 UPLOAD_BODY
A shortcut function for C<< UPLOAD($uri, @params)->content >>.
-=item UPLOAD_BODY_ASSERT
+=head3 UPLOAD_BODY_ASSERT
Use this function when your test is outputting content that you need
to check, and you want to make sure that the request was successful
@@ -975,7 +973,7 @@
message. Otherwise it will simply return the content of the request
just as C<UPLOAD_BODY> would.
-=item OPTIONS
+=head3 OPTIONS
my $res = OPTIONS $uri;
@@ -986,9 +984,6 @@
testing what options the Apache server supports. Consult the HTTPD 1.1
specification, section 9.2, at
I<http://www.faqs.org/rfcs/rfc2616.html> for more information.
-
-=back
-
=head1 ENVIRONMENT VARIABLES
