[asterisk-commits] russell: branch group/appdocsxml r151946 - /team/group/appdocsxml/main/pbx.c

[SVN commits to the Asterisk project]

Author: russell
Date: Sat Oct 25 06:49:34 2008
New Revision: 151946

URL: http://svn.digium.com/view/asterisk?view=rev&rev=151946
Log:
Add a note about something I noticed during code review.  The RWLIST
being used here is fine for now.  However, it will not be sufficient
if reload support gets added.  At that point, we will have to modify
the object management a bit.

Modified:
    team/group/appdocsxml/main/pbx.c

Modified: team/group/appdocsxml/main/pbx.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/main/pbx.c?view=diff&rev=151946&r1=151945&r2=151946
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Sat Oct 25 06:49:34 2008
@@ -825,22 +825,33 @@
 #ifdef XML_DOCUMENTATION
 /*! \brief Default documentation language. */
 static const char default_documentation_language[] = "en_US";
+
 /*! \brief Number of columns to print when showing the XML documentation with a 
  *         'core show application/function *' CLI command. Used in text wrapping.*/
 static const int xmldoc_text_columns = 74;
+
 /*! \brief This is a value that we will use to let the wrapping mechanism move the cursor
  *         backward and forward xmldoc_max_diff positions before cutting the middle of a
  *         word, trying to find a space or a \n. */
 static const int xmldoc_max_diff = 5;
+
 /*! \brief XML documentation language. */
 static char documentation_language[6];
-/*! \brief XML documentation tree, here we will allocate the pointers to the
- *         ast_xml_docs open. */
+
+/*! \brief XML documentation tree */
 struct documentation_tree {
 	char *filename;
 	ast_xml_doc *doc;
 	AST_RWLIST_ENTRY(documentation_tree) entry;
 };
+
+/*!
+ * \brief Container of documentation trees
+ *
+ * \note A RWLIST is a sufficient container type to use here for now.
+ *       However, some changes will need to be made to implement ref counting
+ *       if reload support is added in the future.
+ */
 static AST_RWLIST_HEAD_STATIC(xmldoc_tree, documentation_tree);
 #endif