gozer 2004/09/13 12:01:53
Modified: src/docs/2.0/api/Apache Command.pod
Log:
Small improvements on the documentation
Revision Changes Path
1.9 +19 -17 modperl-docs/src/docs/2.0/api/Apache/Command.pod
Index: Command.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Command.pod,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Command.pod 18 Aug 2004 06:34:58 -0000 1.8
+++ Command.pod 13 Sep 2004 19:01:53 -0000 1.9
@@ -15,6 +15,7 @@
while ($cmd) {
$cmd->args_how();
$cmd->errmsg();
+ $cmd->name();
$cmd->req_override();
$cmd = $cmd->next();
}
@@ -26,12 +27,8 @@
=head1 Description
-Each Apache module can define a list of configuration commands it
-offers. This interface gives access to information about these
-configuration commands. Each module contains a chained-list of
-C<Apache::Command> objects, each representing a single directive.
-
-For example, C<PerlRequire> is a command offered by mod_perl.
+C<Apache::Command> provides the Perl API for accessing Apache module
+command information
@@ -51,16 +48,17 @@
What the command expects as arguments
- $obj->args_how();
+ $how = $obj->args_how();
=over 4
=item obj: C<$obj>
( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item ret: ( integer )
+=item ret: C<$how> ( C<L<Apache::Const :cmd_how
+constant|docs::2.0::api::Apache::Const/C__cmd_how_>> )
-The flag value representing the type of command (i.e. ITERATE/TAKE2)
+The flag value representing the type of this command (i.e. ITERATE/TAKE2)
=item since: 1.99_12
@@ -74,14 +72,14 @@
'usage' message for that command, in case of syntax errors
- $obj->errmsg();
+ $error = $obj->errmsg();
=over 4
=item obj: C<$obj>
( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item ret: ( string )
+=item ret: C<$error> ( string )
The error message
@@ -99,14 +97,14 @@
Name of this command
- $name = $obj->name();
+ $name = $obj->name();
=over 4
=item obj: C<$obj>
( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item ret: ( string )
+=item ret: C<$name> ( string )
The command name
@@ -122,16 +120,19 @@
The next command in the chain of commands for this module
- $ret = $cmd->next();
+ $next = $cmd->next();
=over 4
=item obj: C<$cmd>
( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item ret: C<$ret>
+=item ret: C<$next>
( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
+Returns the next command in the chain for this module, undef for
+the last command.
+
=item since: 1.99_12
=back
@@ -147,14 +148,15 @@
What overrides need to be allowed to enable this command.
- $obj->req_override
+ $override = $obj->req_override
=over 4
=item obj: C<$obj>
( C<L<Apache::Command object|docs::2.0::api::Apache::Command>> )
-=item ret: ( integer )
+=item ret: C<$override> ( C<L<Apache::Const :override
+constant|docs::2.0::api::Apache::Const/C__override_>> )
The bit mask representing the overrides this command is allowed in (i.e
OR_ALL/ACCESS_CONF)
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
