[svn-commits] eliel: branch group/appdocsxml r137402 - in /team/group/appdocsxml: include/a...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Wed Aug 13 08:39:17 CDT 2008
Author: eliel
Date: Wed Aug 13 08:39:13 2008
New Revision: 137402
URL: http://svn.digium.com/view/asterisk?view=rev&rev=137402
Log:
- Documentation fixes, use \internal for static functions.
- Preprocessor fixes.
Modified:
team/group/appdocsxml/include/asterisk/xml.h
team/group/appdocsxml/main/pbx.c
team/group/appdocsxml/main/xml.c
Modified: team/group/appdocsxml/include/asterisk/xml.h
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/include/asterisk/xml.h?view=diff&rev=137402&r1=137401&r2=137402
==============================================================================
--- team/group/appdocsxml/include/asterisk/xml.h (original)
+++ team/group/appdocsxml/include/asterisk/xml.h Wed Aug 13 08:39:13 2008
@@ -17,12 +17,14 @@
#ifndef _ASTERISK_XML_H
#define _ASTERISK_XML_H
-/*
- * Implementation specific code.
+/*! \file
+ * \brief Asterisk XML abstraction layer
*/
-#if defined(HAVE_LIBXML2) && !defined(AST_XML_IMPLEMENTATION)
+
+/* Implementation specific code. */
+#if defined(HAVE_LIBXML2) && !defined(AST_XML_H_IMPLEMENTATION)
/* AST_XML_IMPLEMENTATION must be defined if an XML implementation is available. */
-#define AST_XML_IMPLEMENTATION
+#define AST_XML_H_IMPLEMENTATION
/* libxml2 specific definitions */
#include <libxml/parser.h>
@@ -40,13 +42,11 @@
#define AST_XML_PARENT parent
#define AST_XML_NAME name
-#endif /* defined(HAVE_LIBXML2) && !defined(AST_XML_IMPLEMENTATION) */
+#endif /* defined(HAVE_LIBXML2) && !defined(AST_XML_H_IMPLEMENTATION) */
/* Compile this if we have a working XML implementation. */
-#ifdef AST_XML_IMPLEMENTATION
-#define AST_XML_DESCEND 0
-#define AST_XML_NO_DESCEND 1
+#ifdef AST_XML_H_IMPLEMENTATION
/*! \brief Initialize the XML library implementation.
* This function is used to setup everything needed
@@ -125,7 +125,7 @@
/* Features using ast_xml_ */
#define XML_DOCUMENTATION
-#endif /* AST_XML_IMPLEMENTATION */
+#endif /* AST_XML_H_IMPLEMENTATION */
#endif /* _ASTERISK_XML_H */
Modified: team/group/appdocsxml/main/pbx.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/main/pbx.c?view=diff&rev=137402&r1=137401&r2=137402
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Wed Aug 13 08:39:13 2008
@@ -287,7 +287,9 @@
#ifdef XML_DOCUMENTATION
#define DEFAULT_DOCUMENTATION_LANGUAGE "en_US"
+/*! \brief XML documentation language. */
static char documentation_language[80];
+/*! \brief XML documentation tree. */
static ast_xml_doc *documentation_tree = NULL;
#endif
@@ -2793,7 +2795,8 @@
#ifdef XML_DOCUMENTATION
-/*! \brief Get the application/function node for 'name' application/function with language 'language'
+/*! \internal
+ * \brief Get the application/function node for 'name' application/function with language 'language'
* if we don't find any, get the first application with 'name' no matter which language with.
* \param doc XML documentation tree structure.
* \param type 'application', 'function', ...
@@ -2836,7 +2839,8 @@
return node;
}
-/*! \brief Helper function used to build the syntax, it allocates the needed buffer (or reallocates it),
+/*! \internal
+ * \brief Helper function used to build the syntax, it allocates the needed buffer (or reallocates it),
* and based on the reverse value it makes use of fmt or fmtrev to print the parameter list inside the
* realloced buffer (syntax).
* \param reverse We are going backwards while generating the syntax?
@@ -2881,7 +2885,8 @@
ast_free(tmpfmt);
}
-/*! \brief Build the syntax for an application or a function.
+/*! \internal
+ * \brief Build the syntax for an application or a function.
* \param type 'application' or 'function' ?
* \param name Name of the application or function to build the syntax.
* \retval NULL on error.
@@ -3062,7 +3067,8 @@
#undef GOTONEXT
}
-/*! \brief Parse a <para> element.
+/*! \internal
+ * \brief Parse a <para> element.
* \param node The <para> element pointer.
* \param tabs Added this string before the content of the <para> element.
* \param posttabs Added this string after the content of the <para> element.
@@ -3095,7 +3101,8 @@
return 1;
}
-/*! \brief Parse a <variable> node inside a <variablelist> node.
+/*! \internal
+ * \brief Parse a <variable> node inside a <variablelist> node.
* \param node The variable node to parse.
* \param tabs A string to be appended at the begining of the output that will be stored
* in buffer.
@@ -3146,7 +3153,8 @@
}
-/*! \brief Parse a <variablelist> node and put all the output inside 'buffer'.
+/*! \internal
+ * \brief Parse a <variablelist> node and put all the output inside 'buffer'.
* \param node The variablelist node pointer.
* \param tabs A string to be appended at the begining of the output that will be stored
* in buffer.
@@ -3194,7 +3202,8 @@
return 1;
}
-/*! \brief Return the string within a node formatted with
+/*! \internal
+ * \brief Return the string within a node formatted with
* <para> and <variablelist> elements.
* \param node Parent node where content resides.
* \param raw If set, return the node's content without further processing.
@@ -3230,7 +3239,8 @@
return ret;
}
-/*! \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
+/*! \internal
+ * \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
* \param type Type of element (application, function, ...).
* \param name Name of element (Dial, Echo, Playback, ...).
* \param var Name of field to return (synopsis, description, etc).
Modified: team/group/appdocsxml/main/xml.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/main/xml.c?view=diff&rev=137402&r1=137401&r2=137402
==============================================================================
--- team/group/appdocsxml/main/xml.c (original)
+++ team/group/appdocsxml/main/xml.c Wed Aug 13 08:39:13 2008
@@ -26,7 +26,8 @@
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-#ifdef HAVE_LIBXML2
+#if defined(HAVE_LIBXML2) && !defined(AST_XML_IMPLEMENTATION)
+#define AST_XML_IMPLEMENTATION
/* libxml2 ast_xml implementation. */
@@ -167,5 +168,5 @@
return (char *)xmlNodeListGetString(node->doc, node->children, 0);
}
-#endif /* HAVE_LIBXML2 */
+#endif /* defined(HAVE_LIBXML2) && !defined(AST_XML_IMPLEMENTATION) */
More information about the svn-commits
mailing list