[svn-commits] eliel: branch group/appdocsxml r153183 - /team/group/appdocsxml/main/pbx.c

[SVN commits to the Digium repositories]

Author: eliel
Date: Fri Oct 31 14:25:05 2008
New Revision: 153183

URL: http://svn.digium.com/view/asterisk?view=rev&rev=153183
Log:
Add some comments before merging.

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=153183&r1=153182&r2=153183
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Fri Oct 31 14:25:05 2008
@@ -839,8 +839,8 @@
 
 /*! \brief XML documentation tree */
 struct documentation_tree {
-	char *filename;
-	struct ast_xml_doc *doc;
+	char *filename;					/*!< XML document filename. */
+	struct ast_xml_doc *doc;			/*!< Open document pointer. */
 	AST_RWLIST_ENTRY(documentation_tree) entry;
 };
 
@@ -3488,6 +3488,7 @@
 
 	for (i = 0; i < textlen; i++) {
 		if (text[i] == '\n' || text[i] == '\r') {
+			/* remove spaces/tabs/\n after a \n. */
 			while (text[i + 1] == '\t' || text[i + 1] == '\r' || text[i + 1] == '\n') {
 				i++;
 			}
@@ -3791,6 +3792,7 @@
 			if (!paramcount) {
 				xmldoc_reverse_helper(reverse, &len, &syntax, "%s%s%s%s", paramname, MP("["), MP(argsep), MP("...]"));
 			} else {
+				/* Time to close open brackets. */
 				while (openbrackets > 0) {
 					xmldoc_reverse_helper(reverse, &len, &syntax, (reverse ? "[" : "]"));
 					openbrackets--;
@@ -3808,6 +3810,7 @@
 				xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s]", paramname, MP("["), MP(argsep), MP("...]"));
 			} else {
 				if (ISLAST(reverse, node)) {
+					/* This is the last parameter. */
 					if (reverse) {
 						xmldoc_reverse_helper(reverse, &len, &syntax, "[%s%s%s%s]%s", paramname,
 									MP("["), MP(argsep), MP("...]"), argsep);
@@ -3836,6 +3839,7 @@
 		paramcount++;
 	}
 
+	/* Time to close open brackets. */
 	while (openbrackets > 0) {
 		xmldoc_reverse_helper(reverse, &len, &syntax, (reverse ? "[" : "]"));
 		openbrackets--;