httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r..@locus.apache.org
Subject cvs commit: apache-2.0/src/include util_cfgtree.h
Date Sun, 06 Aug 2000 04:23:39 GMT
rbb         00/08/05 21:23:39

  Modified:    src/include util_cfgtree.h
  Log:
  Document util_cfgtree using ScanDoc
  
  Revision  Changes    Path
  1.3       +38 -5     apache-2.0/src/include/util_cfgtree.h
  
  Index: util_cfgtree.h
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/include/util_cfgtree.h,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- util_cfgtree.h	2000/04/24 12:00:43	1.2
  +++ util_cfgtree.h	2000/08/06 04:23:39	1.3
  @@ -55,22 +55,55 @@
   #ifndef AP_CONFTREE_H
   #define AP_CONFTREE_H
   
  -typedef struct ap_directive_t {
  +/**
  + * @package Config Tree Package
  + */
  +
  +typedef struct ap_directive_t ap_directive_t;
  +
  +/**
  + * Structure used to build the config tree.  The config tree only stores
  + * the directives that will be active in the running server.  Directives
  + * that contain other directions, such as <Directory ...> cause a sub-level
  + * to be created, where the included directives are stored.  The closing
  + * directive (</Directory>) is not stored in the tree.
  + */
  +struct ap_directive_t {
  +    /** The current directive */
       const char *directive;
  +    /** The arguments for the current directive, stored as a space 
  +     *  separated list */
       const char *args;
  +    /** The next directive node in the tree
  +     *  @defvar ap_directive_t *next */
       struct ap_directive_t *next;
  +    /** The first child node of this directive 
  +     *  @defvar ap_directive_t *first_child */
       struct ap_directive_t *first_child;
  +    /** The parent node of this directive 
  +     *  @defvar ap_directive_t *parent */
       struct ap_directive_t *parent;
   
  -    void *data;		/* directive's module can store add'l data here */
  +    /** directive's module can store add'l data here */
  +    void *data;
   
       /* ### these may go away in the future, but are needed for now */
  +    /** The name of the file this directive was found in */
       const char *filename;
  +    /** The line number the directive was on */
       int line_num;
  -
  -} ap_directive_t;
  +};
   
  +/**
  + * Add a node to the configuration tree.
  + * @param parent The current parent node.  If the added node is a first_child,
  +                 then this is changed to the current node
  + * @param current The current node
  + * @param toadd The node to add to the tree
  + * @param child Is the node to add a child node
  + * @return the added node
  + */
   ap_directive_t *ap_add_node(ap_directive_t **parent, ap_directive_t *current, 
  -                            ap_directive_t *todadd, int child);
  +                            ap_directive_t *toadd, int child);
   
   #endif
  
  
  

Mime
View raw message