Document apr_xml_internal.h.

git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@1835993 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 16 insertions, 7 deletions

diff --git a/xml/apr_xml_internal.h b/xml/apr_xml_internal.h
index dfd191e32..f501077f0 100644
--- a/xml/apr_xml_internal.h
+++ b/xml/apr_xml_internal.h
@@ -19,7 +19,9 @@
 
 
 struct XMLParserImpl {
+    /** parse callback */
     apr_status_t (*Parse)(apr_xml_parser*, const char*, apr_size_t, int);
+    /** cleanup callback */
     apr_status_t (*cleanup)(void*);
 };
 typedef struct XMLParserImpl XMLParserImpl;
@@ -28,18 +30,25 @@ XMLParserImpl* apr_xml_get_parser_impl(void);
 
 /* the real (internal) definition of the parser context */
 struct apr_xml_parser {
-    apr_xml_doc *doc;           /* the doc we're parsing */
-    apr_pool_t *p;              /* the pool we allocate from */
-    apr_xml_elem *cur_elem;     /* current element */
-
-    int error;                  /* an error has occurred */
+    /** the doc we're parsing */
+    apr_xml_doc *doc;
+    /** the pool we allocate from */
+    apr_pool_t *p;
+    /** current element */
+    apr_xml_elem *cur_elem;
+    /** an error has occurred */
+    int error;
 #define APR_XML_ERROR_EXPAT             1
 #define APR_XML_ERROR_PARSE_DONE        2
 /* also: public APR_XML_NS_ERROR_* values (if any) */
 
-    XML_Parser xp;              /* the actual (Expat) XML parser */
-    XML_Error xp_err;      /* stored Expat error code */
+    /** the actual (Expat) XML parser */
+    XML_Parser xp;
+    /** stored Expat error code */
+    XML_Error xp_err;
+    /** message */
     const char *xp_msg;
+    /** XML parser implementation */
     XMLParserImpl *impl;
 };