Mailing-List: contact cvs-help@apr.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@apr.apache.org
Date: 16 Sep 2001 21:46:11 -0000
Message-ID: <20010916214611.4764.qmail@icarus.apache.org>
From: ianh@apache.org
To: apr-util-cvs@apache.org
Subject: cvs commit: apr-util/include apr_ldap.h.in apr_ring.h apr_uri.h
 apr_xml.h apu_compat.h

ianh        01/09/16 14:46:11

  Modified:    include  apr_ldap.h.in apr_ring.h apr_uri.h apr_xml.h
                        apu_compat.h
  Log:
  Doxygen Changes
  
  Revision  Changes    Path
  1.2       +12 -2     apr-util/include/apr_ldap.h.in
  
  Index: apr_ldap.h.in
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_ldap.h.in,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- apr_ldap.h.in	2001/08/18 09:44:17	1.1
  +++ apr_ldap.h.in	2001/09/16 21:46:11	1.2
  @@ -55,10 +55,20 @@
   /*
    * apr_ldap.h is generated from apr_ldap.h.in by configure -- do not edit apr_ldap.h
    */
  -
  +/**
  + * @file apr_ldab.h
  + * @brief  APR-UTIL LDAP 
  + */
   #ifndef APU_LDAP_H
   #define APU_LDAP_H
   
  +/**
  + * @defgroup APR_Util_LDAP LDAP
  + * @ingroup APR_Util
  + * @{
  + */
  +
  +
   /*
    * This switches LDAP support on or off.
    */
  @@ -106,7 +116,7 @@
   #ifndef LDAP_URL_ERR_NODN
   #define LDAP_URL_ERR_NODN LDAP_URL_ERR_BADURL
   #endif
  -
   
  +/** @} */
   #endif /* APU_HAS_LDAP */
   #endif /* APU_LDAP_H */
  
  
  
  1.11      +40 -60    apr-util/include/apr_ring.h
  
  Index: apr_ring.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_ring.h,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- apr_ring.h	2001/08/10 00:10:50	1.10
  +++ apr_ring.h	2001/09/16 21:46:11	1.11
  @@ -61,7 +61,10 @@
    * We'd use Dean's code directly if we could guarantee the
    * availability of inline functions.
    */
  -
  +/**
  + * @file apr_ring.h
  + * @brief APR-Util Rings
  + */
   #ifndef APR_RING_H
   #define APR_RING_H
   
  @@ -71,15 +74,18 @@
   #include <stddef.h>
   
   /**
  - * @package Rings
  + * @defgroup APR_Util_Rings Rings
  + * @ingroup APR_Util
  + * @{
    */
  -/*
  +
  +/**
    * A ring is a kind of doubly-linked list that can be manipulated
    * without knowing where its head is.
    */
   
   /**
  - * <p>The Ring Element</p>
  + * The Ring Element
    *
    * A ring element struct is linked to the other elements in the ring
    * through its ring entry field, e.g.
  @@ -97,7 +103,6 @@
    * first in the element struct unless the head is always part of a larger
    * object with enough earlier fields to accommodate the offsetof() used
    * to compute the ring sentinel below. You can usually ignore this caveat.
  - * @defvar APR_RING_ENTRY
    */
   #define APR_RING_ENTRY(elem)						\
       struct {								\
  @@ -106,7 +111,7 @@
       }
   
   /**
  - * <p>The Ring Head</p>
  + * The Ring Head
    *
    * Each ring is managed via its head, which is a struct declared like this:
    * <pre>
  @@ -119,7 +124,6 @@
    *
    * The first element in the ring is next after the head, and the last
    * element is just before the head.
  - * @defvar APR_RING_HEAD
    */
   #define APR_RING_HEAD(head, elem)					\
       struct head {							\
  @@ -128,7 +132,7 @@
       }
   
   /**
  - * <p>The Ring Sentinel</p>
  + * The Ring Sentinel
    *
    * This is the magic pointer value that occurs before the first and
    * after the last elements in the ring, computed from the address of
  @@ -139,7 +143,6 @@
    * @param hp   The head of the ring
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc elem *APR_RING_SENTINEL(head *hp, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_SENTINEL(hp, elem, link)				\
       (struct elem *)((char *)(hp) - offsetof(struct elem, link))
  @@ -147,27 +150,23 @@
   /**
    * The first element of the ring
    * @param hp   The head of the ring
  - * @deffunc elem *APR_RING_FIRST(head *hp)
    */
   #define APR_RING_FIRST(hp)	(hp)->next
   /**
    * The last element of the ring
    * @param hp   The head of the ring
  - * @deffunc elem *APR_RING_LAST(head *hp)
    */
   #define APR_RING_LAST(hp)	(hp)->prev
   /**
    * The next element in the ring
    * @param ep   The current element
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc elem *APR_RING_NEXT(elem *ep, APR_RING_ENTRY link)
    */
   #define APR_RING_NEXT(ep, link)	(ep)->link.next
   /**
    * The previous element in the ring
    * @param ep   The current element
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc elem *APR_RING_PREV(elem *ep, APR_RING_ENTRY link)
    */
   #define APR_RING_PREV(ep, link)	(ep)->link.prev
   
  @@ -177,7 +176,6 @@
    * @param hp   The head of the ring
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_INIT(head *hp, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_INIT(hp, elem, link) do {				\
   	APR_RING_FIRST((hp)) = APR_RING_SENTINEL((hp), elem, link);	\
  @@ -190,7 +188,6 @@
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
    * @return true or false
  - * @deffunc int APR_RING_EMPTY(head *hp, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_EMPTY(hp, elem, link)					\
       (APR_RING_FIRST((hp)) == APR_RING_SENTINEL((hp), elem, link))
  @@ -199,7 +196,6 @@
    * Initialize a singleton element
    * @param ep   The element
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_ELEM_INIT(elem *ep, APR_RING_ENTRY link)
    */
   #define APR_RING_ELEM_INIT(ep, link) do {				\
   	APR_RING_NEXT((ep), link) = (ep);				\
  @@ -216,7 +212,6 @@
    * @param ep1  First element in the sequence to splice in
    * @param epN  Last element in the sequence to splice in
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_SPLICE_BEFORE(elem *lep, elem *ep1, elem *epN, APR_RING_ENTRY link)
    */
   #define APR_RING_SPLICE_BEFORE(lep, ep1, epN, link) do {		\
   	APR_RING_NEXT((epN), link) = (lep);				\
  @@ -234,7 +229,6 @@
    * @param ep1  First element in the sequence to splice in
    * @param epN  Last element in the sequence to splice in
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_SPLICE_AFTER(elem *lep, elem *ep1, elem *epN, APR_RING_ENTRY link)
    */
   #define APR_RING_SPLICE_AFTER(lep, ep1, epN, link) do {			\
   	APR_RING_PREV((ep1), link) = (lep);				\
  @@ -251,7 +245,6 @@
    * @param lep  Element in the ring to insert before
    * @param nep  Element to insert
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_INSERT_BEFORE(elem *lep, elem *nep, APR_RING_ENTRY link)
    */
   #define APR_RING_INSERT_BEFORE(lep, nep, link)				\
   	APR_RING_SPLICE_BEFORE((lep), (nep), (nep), link)
  @@ -264,7 +257,6 @@
    * @param lep  Element in the ring to insert after
    * @param nep  Element to insert
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_INSERT_AFTER(elem *lep, elem *nep, APR_RING_ENTRY link)
    */
   #define APR_RING_INSERT_AFTER(lep, nep, link)				\
   	APR_RING_SPLICE_AFTER((lep), (nep), (nep), link)
  @@ -278,7 +270,6 @@
    * @param epN  Last element in the sequence to splice in
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_SPLICE_HEAD(head *hp, elem *ep1, elem *epN, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_SPLICE_HEAD(hp, ep1, epN, elem, link)			\
   	APR_RING_SPLICE_AFTER(APR_RING_SENTINEL((hp), elem, link),	\
  @@ -292,7 +283,6 @@
    * @param epN  Last element in the sequence to splice in
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_SPLICE_TAIL(head *hp, elem *ep1, elem *epN, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_SPLICE_TAIL(hp, ep1, epN, elem, link)			\
   	APR_RING_SPLICE_BEFORE(APR_RING_SENTINEL((hp), elem, link),	\
  @@ -305,7 +295,6 @@
    * @param nep  Element to insert
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_INSERT_HEAD(head *hp, elem *nep, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_INSERT_HEAD(hp, nep, elem, link)			\
   	APR_RING_SPLICE_HEAD((hp), (nep), (nep), elem, link)
  @@ -317,7 +306,6 @@
    * @param nep  Element to insert
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_INSERT_TAIL(head *hp, elem *nep, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_INSERT_TAIL(hp, nep, elem, link)			\
   	APR_RING_SPLICE_TAIL((hp), (nep), (nep), elem, link)
  @@ -328,7 +316,6 @@
    * @param h2   Head of the ring to concatenate
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_CONCAT(head *h1, head *h2, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_CONCAT(h1, h2, elem, link) do {			\
   	if (!APR_RING_EMPTY((h2), elem, link)) {			\
  @@ -346,7 +333,6 @@
    * @param ep1  First element in the sequence to unsplice
    * @param epN  Last element in the sequence to unsplice
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_UNSPLICE(elem *ep1, elem *epN, APR_RING_ENTRY link)
    */
   #define APR_RING_UNSPLICE(ep1, epN, link) do {				\
   	APR_RING_NEXT(APR_RING_PREV((ep1), link), link) =		\
  @@ -360,7 +346,6 @@
    * @warning The unspliced element is left with dangling pointers at either end
    * @param ep   Element to remove
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @deffunc void APR_RING_REMOVE(elem *ep, APR_RING_ENTRY link)
    */
   #define APR_RING_REMOVE(ep, link)					\
       APR_RING_UNSPLICE((ep), (ep), link)
  @@ -372,7 +357,7 @@
    * @param hp The ring to iterate over
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
  - * @tip This is the same as either:
  + * @remark This is the same as either:
    * <pre>
    *	ep = APR_RING_FIRST(hp);
    * 	while (ep != APR_RING_SENTINEL(hp, elem, link)) {
  @@ -404,7 +389,6 @@
    *          APR_RING_REMOVE(ep, link);
    *      }
    * </pre>
  - * @deffunc void APR_RING_FOREACH(elem *ep, head *hp, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_FOREACH(ep, hp, elem, link)				\
       for ((ep)  = APR_RING_FIRST((hp));					\
  @@ -418,7 +402,6 @@
    * @param elem The name of the element struct
    * @param link The name of the APR_RING_ENTRY in the element struct
    * @see APR_RING_FOREACH
  - * @deffunc void APR_RING_FOREACH_REVERSE(elem *ep, head *hp, struct elem, APR_RING_ENTRY link)
    */
   #define APR_RING_FOREACH_REVERSE(ep, hp, elem, link)			\
       for ((ep)  = APR_RING_LAST((hp));					\
  @@ -428,35 +411,6 @@
   
   /* Debugging tools: */
   
  -/**
  - * Print a single pointer value to STDERR
  - *   (This is a no-op unless APR_RING_DEBUG is defined.)
  - * @param msg Descriptive message
  - * @param ptr Pointer value to print
  - * @deffunc void APR_RING_CHECK_ONE(char *msg, void *ptr)
  - */
  -/**
  - * Dump all ring pointers to STDERR, starting with the head and looping all
  - * the way around the ring back to the head.  Aborts if an inconsistency
  - * is found.
  - *   (This is a no-op unless APR_RING_DEBUG is defined.)
  - * @param hp   Head of the ring
  - * @param elem The name of the element struct
  - * @param link The name of the APR_RING_ENTRY in the element struct
  - * @param msg  Descriptive message
  - * @deffunc void APR_RING_CHECK(head *hp, struct elem, APR_RING_ENTRY link, char *msg)
  - */
  -/**
  - * Dump all ring pointers to STDERR, starting with the given element and
  - * looping all the way around the ring back to that element.  Aborts if
  - * an inconsistency is found.
  - *   (This is a no-op unless APR_RING_DEBUG is defined.)
  - * @param ep   The element
  - * @param elem The name of the element struct
  - * @param link The name of the APR_RING_ENTRY in the element struct
  - * @param msg  Descriptive message
  - * @deffunc void APR_RING_CHECK_ELEM(elem *ep, struct elem, APR_RING_ENTRY link, char *msg)
  - */
   #ifdef APR_RING_DEBUG
   #include <stdio.h>
   #define APR_RING_CHECK_ONE(msg, ptr)					\
  @@ -490,9 +444,35 @@
   	fprintf(stderr, "*** ring check end\n");			\
       } while (0)
   #else
  +/**
  + * Print a single pointer value to STDERR
  + *   (This is a no-op unless APR_RING_DEBUG is defined.)
  + * @param msg Descriptive message
  + * @param ptr Pointer value to print
  + */
   #define APR_RING_CHECK_ONE(msg, ptr)
  +/**
  + * Dump all ring pointers to STDERR, starting with the head and looping all
  + * the way around the ring back to the head.  Aborts if an inconsistency
  + * is found.
  + *   (This is a no-op unless APR_RING_DEBUG is defined.)
  + * @param hp   Head of the ring
  + * @param elem The name of the element struct
  + * @param link The name of the APR_RING_ENTRY in the element struct
  + * @param msg  Descriptive message
  + */
   #define APR_RING_CHECK(hp, elem, link, msg)
  +/**
  + * Dump all ring pointers to STDERR, starting with the given element and
  + * looping all the way around the ring back to that element.  Aborts if
  + * an inconsistency is found.
  + *   (This is a no-op unless APR_RING_DEBUG is defined.)
  + * @param ep   The element
  + * @param elem The name of the element struct
  + * @param link The name of the APR_RING_ENTRY in the element struct
  + * @param msg  Descriptive message
  + */
   #define APR_RING_CHECK_ELEM(ep, elem, link, msg)
   #endif
  -
  +/** @} */ 
   #endif /* !APR_RING_H */
  
  
  
  1.8       +9 -5      apr-util/include/apr_uri.h
  
  Index: apr_uri.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_uri.h,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- apr_uri.h	2001/08/19 16:06:57	1.7
  +++ apr_uri.h	2001/09/16 21:46:11	1.8
  @@ -60,6 +60,11 @@
    * apr_uri.h: External Interface of apr_uri.c
    */
   
  +/**
  + * @file apr_uri.h
  + * @brief APR-UTIL URI Routines
  + */
  +
   #ifndef APR_URI_H
   #define APR_URI_H
   
  @@ -72,7 +77,9 @@
   #endif
   
   /**
  - * @package Apache URI library
  + * @defgroup APR_Util_URI URI
  + * @ingroup APR_Util
  + * @{
    */
   
   #define APR_URI_FTP_DEFAULT_PORT         21
  @@ -150,7 +157,6 @@
    * http, ftp, https, gopher, wais, nntp, snews, and prospero
    * @param scheme_str The string that contains the current scheme
    * @return The default port for this scheme
  - * @deffunc apr_port_t apr_uri_default_port_for_scheme(const char *scheme_str)
    */ 
   APU_DECLARE(apr_port_t) apr_uri_default_port_for_scheme(const char *scheme_str);
   
  @@ -170,7 +176,6 @@
    *    APR_URI_UNP_OMITQUERY           Omit the "?queryarg" from the path 
    * </PRE>
    * @return The uri as a string
  - * @deffunc char * apr_uri_unparse(apr_pool_t *p, const apr_uri_t *uptr, unsigned flags)
    */
   APU_DECLARE(char *) apr_uri_unparse(apr_pool_t *p, 
                                                  const apr_uri_t *uptr,
  @@ -184,7 +189,6 @@
    * @param uri The uri to parse
    * @param uptr The apr_uri_t to fill out
    * @return An HTTP status code
  - * @deffunc int apr_uri_parse(apr_pool_t *p, const char *uri, apr_uri_t *uptr)
    */
   APU_DECLARE(int) apr_uri_parse(apr_pool_t *p, const char *uri, 
                                             apr_uri_t *uptr);
  @@ -195,12 +199,12 @@
    * @param hostinfo The hostinfo string to parse
    * @param uptr The apr_uri_t to fill out
    * @return An HTTP status code
  - * @deffunc int apr_parse_hostinfo_components(apr_pool_t *p, const char *hostinfo, apr_uri_t *uptr)
    */
   APU_DECLARE(int) apr_uri_parse_hostinfo(apr_pool_t *p, 
                                                      const char *hostinfo, 
                                                      apr_uri_t *uptr);
   
  +/** @} */
   #ifdef __cplusplus
   }
   #endif
  
  
  
  1.16      +16 -14    apr-util/include/apr_xml.h
  
  Index: apr_xml.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apr_xml.h,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- apr_xml.h	2001/08/07 23:26:51	1.15
  +++ apr_xml.h	2001/09/16 21:46:11	1.16
  @@ -51,10 +51,18 @@
    * information on the Apache Software Foundation, please see
    * <http://www.apache.org/>.
    */
  -
  +/**
  + * @file apr_xml.h
  + * @brief APR-UTIL XML Library
  + */
   #ifndef APR_XML_H
   #define APR_XML_H
   
  +/**
  + * @defgroup APR_Util_XML XML 
  + * @ingroup APR_Util
  + * @{
  + */
   #include "apr_pools.h"
   #include "apr_tables.h"
   #include "apr_file_io.h"
  @@ -100,7 +108,6 @@
    * @param p The pool to allocate out of
    * @param hdr The text header to append to
    * @param text The new text to append
  - * @deffunc void apr_text_append(apr_pool_t *p, apr_text_header *hdr, const char *text)
    */
   APU_DECLARE(void) apr_text_append(apr_pool_t *p, apr_text_header *hdr,
                                     const char *text);
  @@ -268,7 +275,7 @@
    * @param data The data to parse.
    * @param len The length of the data.
    * @return Any errors found during parsing.
  - * @tip Use apr_xml_parser_geterror() to get more error information.
  + * @remark Use apr_xml_parser_geterror() to get more error information.
    */
   APU_DECLARE(apr_status_t) apr_xml_parser_feed(apr_xml_parser *parser,
                                                 const char *data,
  @@ -280,7 +287,7 @@
    * @param pdoc The resulting parse information. May be NULL to simply
    *             terminate the parsing without fetching the info.
    * @return Any errors found during the final stage of parsing.
  - * @tip Use apr_xml_parser_geterror() to get more error information.
  + * @remark Use apr_xml_parser_geterror() to get more error information.
    */
   APU_DECLARE(apr_status_t) apr_xml_parser_done(apr_xml_parser *parser,
                                                 apr_xml_doc **pdoc);
  @@ -312,7 +319,6 @@
    * @param ns_map Namespace mapping
    * @param pbuf Buffer to put the converted text into
    * @param psize Size of the converted text
  - * @deffunc void apr_xml_to_text(apr_pool_t *p, const apr_xml_elem *elem, int style, apr_array_header_t *namespaces, int *ns_map, const char **pbuf, size_t *psize);
    */
   APU_DECLARE(void) apr_xml_to_text(apr_pool_t *p, const apr_xml_elem *elem,
                                     int style, apr_array_header_t *namespaces,
  @@ -320,17 +326,16 @@
                                     apr_size_t *psize);
   
   /* style argument values: */
  -#define APR_XML_X2T_FULL         0	/* start tag, contents, end tag */
  -#define APR_XML_X2T_INNER        1	/* contents only */
  -#define APR_XML_X2T_LANG_INNER   2	/* xml:lang + inner contents */
  -#define APR_XML_X2T_FULL_NS_LANG 3	/* FULL + ns defns + xml:lang */
  +#define APR_XML_X2T_FULL         0	/**< start tag, contents, end tag */
  +#define APR_XML_X2T_INNER        1	/**< contents only */
  +#define APR_XML_X2T_LANG_INNER   2	/**< xml:lang + inner contents */
  +#define APR_XML_X2T_FULL_NS_LANG 3	/**< FULL + ns defns + xml:lang */
   
   /**
    * empty XML element
    * @param p The pool to allocate out of
    * @param elem The XML element to empty
    * @return the string that was stored in the XML element
  - * @deffunc const char *apr_xml_empty_elem(apr_pool_t *p, const apr_xml_elem *elem)
    */
   APU_DECLARE(const char *) apr_xml_empty_elem(apr_pool_t *p,
                                                const apr_xml_elem *elem);
  @@ -342,7 +347,6 @@
    * @param s The string to quote
    * @param quotes If quotes is true, then replace '"' with '&quot;'.
    * @return The quoted string
  - * @deffunc const char *apr_xml_quote_string(apr_pool_t *p, const char *s, int quotes)
    */
   APU_DECLARE(const char *) apr_xml_quote_string(apr_pool_t *p, const char *s,
                                                  int quotes);
  @@ -351,7 +355,6 @@
    * Quote an XML element
    * @param p The pool to allocate out of
    * @param elem The element to quote
  - * @deffunc void apr_xml_quote_elem(apr_pool_t *p, apr_xml_elem *elem)
    */
   APU_DECLARE(void) apr_xml_quote_elem(apr_pool_t *p, apr_xml_elem *elem);
   
  @@ -362,7 +365,6 @@
    * @param uri_array array to insert into
    * @param uri The uri to insert
    * @return int The uri's index
  - * @deffunc int apr_xml_insert_uri(apr_array_header_t *uri_array, const char *uri)
    */
   APU_DECLARE(int) apr_xml_insert_uri(apr_array_header_t *uri_array,
                                       const char *uri);
  @@ -371,5 +373,5 @@
   #ifdef __cplusplus
   }
   #endif
  -
  +/** @} */
   #endif /* APR_XML_H */
  
  
  
  1.7       +44 -1     apr-util/include/apu_compat.h
  
  Index: apu_compat.h
  ===================================================================
  RCS file: /home/cvs/apr-util/include/apu_compat.h,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- apu_compat.h	2001/06/05 23:38:17	1.6
  +++ apu_compat.h	2001/09/16 21:46:11	1.7
  @@ -52,9 +52,20 @@
    * <http://www.apache.org/>.
    */
   
  +/**
  + * @file  apu_compat.h
  + * @brief APR-UTIL Compabitlity Functions
  + * @deprecated These functions are only present for historical purposes
  + */
   #ifndef APU_COMPAT_H
   #define APU_COMPAT_H
  +/**
  + * @defgroup APR_Util_compat 1.3 Compatibility Functions
  + * @ingroup APR_Util
  + * @{
  + */
   
  +
   /* Include the apr compatibility changes, since apr-util users are
    * always apr users.
    */
  @@ -63,49 +74,81 @@
   /* --------------------------------------------------------------------
    * redefine 1.3.x symbols to those that now live in libapr-util
    */
  +/** @deprecated @see apr_base64_decode */
   #define ap_base64decode apr_base64_decode
  +/** @deprecated @see apr_base64_decode_binary */
   #define ap_base64decode_binary apr_base64_decode_binary
  +/** @deprecated @see apr_base64_decode_len */
   #define ap_base64decode_len apr_base64_decode_len
  +/** @deprecated @see apr_base64_encode */
   #define ap_base64encode apr_base64_encode
  +/** @deprecated @see apr_base64_encode_binary */
   #define ap_base64encode_binary apr_base64_encode_binary
  +/** @deprecated @see apr_base64_encode_len */
   #define ap_base64encode_len apr_base64_encode_len
  +/** @deprecated @see apr_hook_deregister_all */
   #define ap_hook_deregister_all apr_hook_deregister_all
  +/** @deprecated @see apr_hook_sort_register */
   #define ap_hook_sort_register apr_hook_sort_register
  +/** @deprecated @see apr_show_hook */
   #define ap_show_hook apr_show_hook
   
   /* --------------------------------------------------------------------
    * the following symbols were moved from httpd-2.0/.../util_date.[ch]
    */
  +/** @deprecated @see apr_date_parse_http */
   #define ap_parseHTTPdate apr_date_parse_http
  +/** @deprecated @see apr_date_checkmask */
   #define ap_checkmask apr_date_checkmask
   
   /* --------------------------------------------------------------------
    * the following symbols were moved from httpd-2.0/.../util_xml.[ch]
    */
  +/** @deprecated @see apr_text */
   #define ap_text apr_text
  +/** @deprecated @see apr_text_header */
   #define ap_text_header apr_text_header
  +/** @deprecated @see apr_text_append */
   #define ap_text_append apr_text_append
   
  +/** @deprecated @see APR_XML_NS_DAV_ID */
   #define AP_XML_NS_DAV_ID APR_XML_NS_DAV_ID
  +/** @deprecated @see APR_XML_NS_NONE */
   #define AP_XML_NS_NONE APR_XML_NS_NONE
  +/** @deprecated @see APR_XML_NS_ERROR_BASE */
   #define AP_XML_NS_ERROR_BASE APR_XML_NS_ERROR_BASE
  +/** @deprecated @see APR_XML_NS_IS_ERROR */
   #define AP_XML_NS_IS_ERROR(e) APR_XML_NS_IS_ERROR(e)
  +/** @deprecated @see APR_XML_ELEM_IS_EMPTY */
   #define AP_XML_ELEM_IS_EMPTY(e) APR_XML_ELEM_IS_EMPTY(e)
   
  +/** @deprecated @see apr_xml_attr */
   #define ap_xml_attr apr_xml_attr
  +/** @deprecated @see apr_xml_elem */
   #define ap_xml_elem apr_xml_elem
  +/** @deprecated @see apr_xml_doc */
   #define ap_xml_doc apr_xml_doc
   
  +/** @deprecated @see apr_xml_to_text */
   #define ap_xml_to_text apr_xml_to_text
  +/** @deprecated @see APR_XML_X2T_FULL */
   #define AP_XML_X2T_FULL APR_XML_X2T_FULL
  +/** @deprecated @see APR_XML_X2T_INNER */
   #define AP_XML_X2T_INNER APR_XML_X2T_INNER
  +/** @deprecated @see APR_XML_X2T_LANG_INNER */
   #define AP_XML_X2T_LANG_INNER APR_XML_X2T_LANG_INNER
  +/** @deprecated @see APR_XML_X2T_FULL_NS_LANG */
   #define AP_XML_X2T_FULL_NS_LANG APR_XML_X2T_FULL_NS_LANG
   
  +/** @deprecated @see apr_xml_empty_elem */
   #define ap_xml_empty_elem apr_xml_empty_elem
  +/** @deprecated @see apr_xml_quote_string */
   #define ap_xml_quote_string apr_xml_quote_string
  +/** @deprecated @see apr_xml_quote_elem */
   #define ap_xml_quote_elem apr_xml_quote_elem
  +/** @deprecated @see apr_xml_insert_uri */
   #define ap_xml_insert_uri apr_xml_insert_uri
  +/** @deprecated @see APR_XML_GET_URI_ITEM */
   #define AP_XML_GET_URI_ITEM(a,i) APR_XML_GET_URI_ITEM(a,i)
  -
  +/** @} */
   #endif /* APU_COMPAT_H */