perl-docs-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject cvs commit: modperl-docs/src/docs/2.0/api/Apache Directive.pod
Date Mon, 13 Sep 2004 23:22:18 GMT
stas        2004/09/13 16:22:18

  Modified:    src/docs/2.0/api/Apache Directive.pod
  Log:
  various fixes
  
  Revision  Changes    Path
  1.9       +57 -44    modperl-docs/src/docs/2.0/api/Apache/Directive.pod
  
  Index: Directive.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Directive.pod,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -u -r1.8 -r1.9
  --- Directive.pod	13 Sep 2004 18:42:55 -0000	1.8
  +++ Directive.pod	13 Sep 2004 23:22:18 -0000	1.9
  @@ -17,7 +17,7 @@
     my $servername = $vhost->{'ServerName'};
     
     use Data::Dumper;
  -  print Dumper($tree->as_hash);
  +  print Dumper $tree->as_hash;
     
     my $node = $tree;
     while ($node) {
  @@ -32,7 +32,7 @@
     
         if (my $kid = $node->first_child) {
             $node = $kid;
  -      } 
  +      }
         elsif (my $next = $node->next) {
             $node = $next;
         }
  @@ -67,12 +67,11 @@
   
   
   
  -=head2 C<args> 
  +=head2 C<args>
   
  -The arguments for the current directive, stored as a space separated
  -list
  +Get the arguments for the current directive:
   
  -  $args      = $node->args();
  +  $args = $node->args();
   
   =over 4
   
  @@ -81,15 +80,20 @@
   
   =item ret: C<$args> ( string )
   
  +Arguments are separated by a whitespace in the string.
  +
   =item since: 1.99_12
   
   =back
   
   
   
  +
  +
  +
   =head2 C<as_hash>
   
  -Returns a hash representation of the configuration tree, in a format
  +Get a hash representation of the configuration tree, in a format
   suitable for inclusion in E<lt>PerlE<gt> sections.
   
      $config_hash = $conftree->as_hash();
  @@ -101,7 +105,7 @@
   
   The config tree to stringify
   
  -=item ret: C<$config_hash> (HASH)
  +=item ret: C<$config_hash> ( HASH reference )
   
   =item since: 1.99_12
   
  @@ -112,9 +116,10 @@
   
   
   
  +
   =head2 C<as_string>
   
  -Returns a string representation of the configuration node, in
  +Get a string representation of the configuration node, in
   F<httpd.conf> format. This does not traverse down to sub-trees.
   
      $string = $node->as_string();
  @@ -134,17 +139,23 @@
   
   
   
  +
  +
  +
  +
  +
   =head2 C<conftree>
   
  -Returns the root of the configuration tree.
  +Get the root of the configuration tree:
   
  -  $tree = Apache::Directive->conftree();
  +  $conftree = Apache::Directive->conftree();
   
   =over 4
   
  -=item obj: C<Apache::Directive> (class name)
  +=item obj: C<Apache::Directive> ( class name )
   
  -=item ret: C<$tree> ( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>>
)
  +=item ret: C<$conftree>
  +( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
   
   =item since: 1.99_12
   
  @@ -154,9 +165,11 @@
   
   
   
  +
  +
   =head2 C<directive>
   
  -Returns the name of the directive in C<$node>.
  +Get the name of the directive in C<$node>:
   
     $name = $node->directive();
   
  @@ -165,7 +178,7 @@
   =item obj: C<$node>
   ( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
   
  -=item ret: C<$directive> ( string )
  +=item ret: C<$name> ( string )
   
   =item since: 1.99_12
   
  @@ -175,9 +188,11 @@
   
   
   
  +
  +
   =head2 C<filename>
   
  -Returns the filename the configuration node was created from
  +Get the F<filename> the configuration node was created from:
   
     $filename = $node->filename();
   
  @@ -196,11 +211,13 @@
   
   
   
  +
  +
   =head2 C<first_child>
   
  -The first child node of this directive
  +Get the first child node of this directive:
   
  -  $subtree = $node->first_child;
  +  $child_node = $node->first_child;
   
   =over 4
   
  @@ -219,9 +236,13 @@
   
   
   
  +
  +
  +
  +
   =head2 C<line_num>
   
  -Returns the line number in C<filename> this node was created from
  +Get the line number in a F<filename> this node was created at:
   
     $lineno = $node->line_num();
   
  @@ -239,9 +260,13 @@
   
   
   
  +
  +
  +
  +
   =head2 C<lookup>
   
  -Returns node(s) matching a certain value.
  +Get the node(s) matching a certain value.
   
     $node  = $conftree->lookup($directive, $args);
     @nodes = $conftree->lookup($directive, $args);
  @@ -261,21 +286,21 @@
   
   Optional args to the directive to filter for
   
  -=item ret: C<$string> ( string / ARRAY of HASHES )
  +=item ret: C<$string> ( string / ARRAY of HASH refs )
   
  -In list context, it will return all matching nodes.
  +In LIST context, it returns all matching nodes.
   
  -In scalar context, it will return only the first matching node.
  +In SCALAR context, it returns only the first matching node.
   
  -If called with only C<$directive> value, this will return all nodes
  +If called with only C<$directive> value, this method returns all nodes
   from that directive. For example:
   
     @Alias = $conftree->lookup('Alias');
   
  -would return all nodes for Alias directives.
  +returns all nodes for C<Alias> directives.
   
  -If called with an extra C<$args> argument, this will return only nodes
  -where both the directive and the args matched. For example:
  +If called with an extra C<$args> argument, it returns only nodes where
  +both the directive and the args matched. For example:
   
     $VHost = $tree->lookup('VirtualHost', '_default_:8000');
   
  @@ -283,20 +308,6 @@
   
   =back
   
  -If called with only one C<$directive> value, this will return all
  -nodes from that directive:
  -
  -  @Alias = $tree->lookup('Alias');
  -
  -Would return all nodes for Alias directives.
  -
  -If called with an extra C<$args> argument, this will return only nodes
  -where both the directive and the args matched:
  -
  -  $VHost = $tree->lookup('VirtualHosts', '_default_:8000');
  -
  -
  -
   
   
   
  @@ -308,7 +319,7 @@
   
   =head2 C<next>
   
  -The next directive node in the tree
  +Get the next directive node in the tree:
   
     $next_node = $node->next();
   
  @@ -333,13 +344,14 @@
   
   =head2 C<parent>
   
  -The parent node of this directive
  +Get the parent node of this directive:
   
     $parent_node = $node->parent();
   
   =over 4
   
  -=item obj: C<$node> ( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>>
)
  +=item obj: C<$node>
  +( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
   
   =item ret: C<parent_node>
   ( C<L<Apache::Directive object|docs::2.0::api::Apache::Directive>> )
  @@ -349,6 +361,7 @@
   =item since: 1.99_12
   
   =back
  +
   
   
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org


Mime
View raw message