apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wr...@apache.org
Subject cvs commit: apr-util/include apr_date.h apr_dbm.h apr_optional.h apr_uri.h apr_xlate.h apr_xml.h
Date Mon, 03 Mar 2003 23:41:12 GMT
wrowe       2003/03/03 15:41:12

  Modified:    docs     doxygen.conf
               include  apr_date.h apr_dbm.h apr_optional.h apr_uri.h
                        apr_xlate.h apr_xml.h
  Log:
    Fix a number of doxygenation errors, including bad keywords, escaping
    literal amps and ats, etc.  Still much work to do.
  
  Revision  Changes    Path
  1.3       +2 -0      apr-util/docs/doxygen.conf
  
  Index: doxygen.conf
  ===================================================================
  RCS file: /home/cvs/apr-util/docs/doxygen.conf,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- doxygen.conf	8 May 2002 21:22:39 -0000	1.2
  +++ doxygen.conf	3 Mar 2003 23:41:11 -0000	1.3
  @@ -13,9 +13,11 @@
   # not sure why this doesn't work as EXPAND_AS_DEFINED, it should!
   PREDEFINED="APU_DECLARE(x)=x" \
              "APU_DECLARE_NONSTD(x)=x" \
  +           "APU_DECLARE_DATA" \
              "APR_HAS_MMAP" \
              "APR_HAS_THREADS" \
              "APR_HAS_XLATE" \
  +           "__attribute__(x)=" \
              DOXYGEN=
   
   OPTIMIZE_OUTPUT_FOR_C=YES
  
  
  
  1.11      +6 -6      apr-util/include/apr_date.h
  
  Index: apr_date.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_date.h,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- apr_date.h	1 Jan 2003 00:02:20 -0000	1.10
  +++ apr_date.h	3 Mar 2003 23:41:11 -0000	1.11
  @@ -89,13 +89,13 @@
    * @param data The string to compare
    * @param mask Mask characters (arbitrary maximum is 256 characters):
    * <PRE>
  - *   @ - uppercase letter
  - *   $ - lowercase letter
  - *   & - hex digit
  + *   \@ - uppercase letter
  + *   \$ - lowercase letter
  + *   \& - hex digit
    *   # - digit
    *   ~ - digit or space
    *   * - swallow remaining characters
  - *  <x> - exact match for any other character
  + *  \<x\> - exact match for any other character
    * </PRE>
    * @return 1 if the string matches, 0 otherwise
    */
  @@ -128,8 +128,8 @@
    *     Sun, 6 Nov 1994 08:49:37 GMT   ; RFC 822, updated by RFC 1123
    *     Sun, 06 Nov 94 08:49:37 GMT    ; RFC 822
    *     Sun, 6 Nov 94 08:49:37 GMT     ; RFC 822
  - *     Sun, 06 Nov 94 08:49 GMT       ; Unknown [drtr@ast.cam.ac.uk] 
  - *     Sun, 6 Nov 94 08:49 GMT        ; Unknown [drtr@ast.cam.ac.uk]
  + *     Sun, 06 Nov 94 08:49 GMT       ; Unknown [drtr\@ast.cam.ac.uk] 
  + *     Sun, 6 Nov 94 08:49 GMT        ; Unknown [drtr\@ast.cam.ac.uk]
    *     Sun, 06 Nov 94 8:49:37 GMT     ; Unknown [Elm 70.85]
    *     Sun, 6 Nov 94 8:49:37 GMT      ; Unknown [Elm 70.85] 
    * </PRE>
  
  
  
  1.21      +5 -5      apr-util/include/apr_dbm.h
  
  Index: apr_dbm.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_dbm.h,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- apr_dbm.h	1 Jan 2003 00:02:20 -0000	1.20
  +++ apr_dbm.h	3 Mar 2003 23:41:11 -0000	1.21
  @@ -117,7 +117,7 @@
    * </PRE>
    * @param perm Permissions to apply to if created
    * @param cntxt The pool to use when creating the dbm
  - * @tip The dbm name may not be a true file name, as many dbm packages
  + * @remark The dbm name may not be a true file name, as many dbm packages
    * append suffixes for seperate data and index files.
    */
   
  @@ -140,7 +140,7 @@
    * </PRE>
    * @param perm Permissions to apply to if created
    * @param cntxt The pool to use when creating the dbm
  - * @tip The dbm name may not be a true file name, as many dbm packages
  + * @remark The dbm name may not be a true file name, as many dbm packages
    * append suffixes for seperate data and index files.
    */
   APU_DECLARE(apr_status_t) apr_dbm_open(apr_dbm_t **dbm, const char *name, 
  @@ -174,7 +174,7 @@
    * Delete a dbm record value by key
    * @param dbm The database 
    * @param key The key datum of the record to delete
  - * @tip It is not an error to delete a non-existent record.
  + * @remark It is not an error to delete a non-existent record.
    */
   APU_DECLARE(apr_status_t) apr_dbm_delete(apr_dbm_t *dbm, apr_datum_t key);
   
  @@ -228,7 +228,7 @@
    * @param used2 The second pathname used by apr_dbm. If only one file is
    *              used by the specific implementation, this will be set to NULL.
    * @return An error if the specified type is invalid.
  - * @tip The dbm file(s) don't need to exist. This function only manipulates
  + * @remark The dbm file(s) don't need to exist. This function only manipulates
    *      the pathnames.
    */
   APU_DECLARE(apr_status_t) apr_dbm_get_usednames_ex(apr_pool_t *pool,
  @@ -246,7 +246,7 @@
    * @param used1 The first pathname used by the apr_dbm implementation.
    * @param used2 The second pathname used by apr_dbm. If only one file is
    *              used by the specific implementation, this will be set to NULL.
  - * @tip The dbm file(s) don't need to exist. This function only manipulates
  + * @remark The dbm file(s) don't need to exist. This function only manipulates
    *      the pathnames.
    */
   APU_DECLARE(void) apr_dbm_get_usednames(apr_pool_t *pool,
  
  
  
  1.11      +2 -2      apr-util/include/apr_optional.h
  
  Index: apr_optional.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_optional.h,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- apr_optional.h	1 Jan 2003 00:02:20 -0000	1.10
  +++ apr_optional.h	3 Mar 2003 23:41:11 -0000	1.11
  @@ -99,7 +99,7 @@
   APU_DECLARE_NONSTD(void) apr_dynamic_fn_register(const char *szName, 
                                                     apr_opt_fn_t *pfn);
       
  -/** @deprecated @see apr_dynamic_fn_register */
  +/** @internal deprecated function, see apr_dynamic_fn_register */
   APU_DECLARE_NONSTD(void) apr_register_optional_fn(const char *szName, 
                                                     apr_opt_fn_t *pfn);
   
  @@ -118,7 +118,7 @@
    */
   APU_DECLARE(apr_opt_fn_t *) apr_dynamic_fn_retrieve(const char *szName);
   
  -/** @deprecated @see apr_dynamic_fn_retrieve */
  +/** @internal deprecated function, see apr_dynamic_fn_retrieve */
   APU_DECLARE(apr_opt_fn_t *) apr_retrieve_optional_fn(const char *szName);
   
   /**
  
  
  
  1.16      +10 -11    apr-util/include/apr_uri.h
  
  Index: apr_uri.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_uri.h,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- apr_uri.h	1 Jan 2003 00:02:20 -0000	1.15
  +++ apr_uri.h	3 Mar 2003 23:41:11 -0000	1.16
  @@ -102,18 +102,18 @@
   #define APR_URI_SIP_DEFAULT_PORT       5060 /**< default SIP port */
   
   /** Flags passed to unparse_uri_components(): */
  -/** suppress "scheme://user@site:port" */
  +/** suppress "scheme://user\@site:port" */
   #define APR_URI_UNP_OMITSITEPART    (1U<<0)
   /** Just omit user */
   #define APR_URI_UNP_OMITUSER        (1U<<1)
   /** Just omit password */
   #define APR_URI_UNP_OMITPASSWORD    (1U<<2)
  -/** omit "user:password@" part */
  +/** omit "user:password\@" part */
   #define APR_URI_UNP_OMITUSERINFO    (APR_URI_UNP_OMITUSER | \
                                        APR_URI_UNP_OMITPASSWORD)
   /** Show plain text password (default: show XXXXXXXX) */
   #define APR_URI_UNP_REVEALPASSWORD  (1U<<3)
  -/** Show "scheme://user@site:port" only */
  +/** Show "scheme://user\@site:port" only */
   #define APR_URI_UNP_OMITPATHINFO    (1U<<4)
   /** Omit the "?queryarg" from the path */
   #define APR_URI_UNP_OMITQUERY       (1U<<5)
  @@ -127,11 +127,11 @@
   struct apr_uri_t {
       /** scheme ("http"/"ftp"/...) */
       char *scheme;
  -    /** combined [user[:password]@]host[:port] */
  +    /** combined [user[:password]\@]host[:port] */
       char *hostinfo;
  -    /** user name, as in http://user:passwd@host:port/ */
  +    /** user name, as in http://user:passwd\@host:port/ */
       char *user;
  -    /** password, as in http://user:passwd@host:port/ */
  +    /** password, as in http://user:passwd\@host:port/ */
       char *password;
       /** hostname from URI (or from Host: header) */
       char *hostname;
  @@ -144,8 +144,7 @@
       /** Trailing "#fragment" string, if present */
       char *fragment;
   
  -    /** structure returned from gethostbyname() 
  -     *  @defvar struct hostent *hostent */
  +    /** structure returned from gethostbyname() */
       struct hostent *hostent;
   
       /** The port number, numeric, valid only if port_str != NULL */
  @@ -179,12 +178,12 @@
    * @param uptr All of the parts of the uri
    * @param flags How to unparse the uri.  One of:
    * <PRE>
  - *    APR_URI_UNP_OMITSITEPART        Suppress "scheme://user@site:port" 
  + *    APR_URI_UNP_OMITSITEPART        Suppress "scheme://user\@site:port" 
    *    APR_URI_UNP_OMITUSER            Just omit user 
    *    APR_URI_UNP_OMITPASSWORD        Just omit password 
  - *    APR_URI_UNP_OMITUSERINFO        Omit "user:password@" part
  + *    APR_URI_UNP_OMITUSERINFO        Omit "user:password\@" part
    *    APR_URI_UNP_REVEALPASSWORD      Show plain text password (default: show XXXXXXXX)
  - *    APR_URI_UNP_OMITPATHINFO        Show "scheme://user@site:port" only 
  + *    APR_URI_UNP_OMITPATHINFO        Show "scheme://user\@site:port" only 
    *    APR_URI_UNP_OMITQUERY           Omit "?queryarg" or "#fragment" 
    * </PRE>
    * @return The uri as a string
  
  
  
  1.7       +0 -1      apr-util/include/apr_xlate.h
  
  Index: apr_xlate.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_xlate.h,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- apr_xlate.h	1 Jan 2003 00:02:20 -0000	1.6
  +++ apr_xlate.h	3 Mar 2003 23:41:11 -0000	1.7
  @@ -100,7 +100,6 @@
    *  Return APR_EINVAL if unable to procure a convset, or APR_ENOTIMPL
    *  if charset transcoding is not available in this instance of
    *  apr-util at all (i.e., APR_HAS_XLATE is undefined).
  - * </PRE>
    */
   APU_DECLARE(apr_status_t) apr_xlate_open(apr_xlate_t **convset, 
                                            const char *topage, 
  
  
  
  1.21      +8 -16     apr-util/include/apr_xml.h
  
  Index: apr_xml.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_xml.h,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- apr_xml.h	1 Jan 2003 00:02:20 -0000	1.20
  +++ apr_xml.h	3 Mar 2003 23:41:11 -0000	1.21
  @@ -88,8 +88,7 @@
   struct apr_text {
       /** The current piece of text */
       const char *text;
  -    /** a pointer to the next piece of text 
  -     *  @defvar apr_text *next */
  +    /** a pointer to the next piece of text */
       struct apr_text *next;
   };
   
  @@ -190,8 +189,7 @@
       /** attribute value */
       const char *value;
   
  -    /** next attribute
  -     *  @defvar apr_xml_attr *next */
  +    /** next attribute
 */
       struct apr_xml_attr *next;
   };
   
  @@ -209,25 +207,19 @@
       /** cdata after MY end tag */
       apr_text_header following_cdata;
   
  -    /** parent element 
  -     *  @defvar apr_xml_elem *parent */
  +    /** parent element 
*/
       struct apr_xml_elem *parent;	
  -    /** next (sibling) element 
  -     *  @defvar apr_xml_elem *next */
  +    /** next (sibling) element */
       struct apr_xml_elem *next;	
  -    /** first child element 
  -     *  @defvar apr_xml_elem *first_child */
  +    /** first child element */
       struct apr_xml_elem *first_child;
  -    /** first attribute 
  -     *  @defvar apr_xml_attr *attr */
  +    /** first attribute */
       struct apr_xml_attr *attr;		
   
       /* used only during parsing */
  -    /** last child element 
  -     *  @defvar apr_xml_elem *last_child */
  +    /** last child element */
       struct apr_xml_elem *last_child;
  -    /** namespaces scoped by this elem 
  -     *  @defvar apr_xml_ns_scope *ns_scope */
  +    /** namespaces scoped by this elem */
       struct apr_xml_ns_scope *ns_scope;
   
       /* used by modules during request processing */
  
  
  

Mime
View raw message