<p>George Joseph <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/17568">View Change</a></p><div style="white-space:pre-wrap">Approvals:
George Joseph: Looks good to me, approved; Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">xmldoc: Fix for Doxygen.<br><br>ASTERISK-29765<br><br>Change-Id: I654ba0debe8351038d4433716434a09370f04c9d<br>---<br>M include/asterisk/xmldoc.h<br>M main/xmldoc.c<br>2 files changed, 49 insertions(+), 47 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/asterisk/xmldoc.h b/include/asterisk/xmldoc.h</span><br><span>index 782fa1e..b14288f 100644</span><br><span>--- a/include/asterisk/xmldoc.h</span><br><span>+++ b/include/asterisk/xmldoc.h</span><br><span>@@ -81,7 +81,7 @@</span><br><span> };</span><br><span> </span><br><span> /*! \brief Execute an XPath query on the loaded XML documentation</span><br><span style="color: hsl(0, 100%, 40%);">- * \param query The XPath query string to execute</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fmt The XPath query string to execute</span><br><span> * \param ... Variable printf style format arguments</span><br><span> * \retval An XPath results object on success</span><br><span> * \retval NULL if no match found</span><br><span>diff --git a/main/xmldoc.c b/main/xmldoc.c</span><br><span>index 8b273f0..f924717 100644</span><br><span>--- a/main/xmldoc.c</span><br><span>+++ b/main/xmldoc.c</span><br><span>@@ -351,12 +351,12 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Cleanup spaces and tabs after a \n</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Cleanup spaces and tabs after a \\n</span><br><span> *</span><br><span> * \param text String to be cleaned up.</span><br><span> * \param output buffer (not already allocated).</span><br><span> * \param lastspaces Remove last spaces in the string.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param maintain_newlines Preserve new line characters (\n \r) discovered in the string</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param maintain_newlines Preserve new line characters (\\n \\r) discovered in the string</span><br><span> */</span><br><span> static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int lastspaces, int maintain_newlines)</span><br><span> {</span><br><span>@@ -559,8 +559,8 @@</span><br><span> * \internal</span><br><span> * \brief Check if the passed node has 'what' tags inside it.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param node Root node to search 'what' elements.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param what node name to search inside node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode Root node to search 'what' elements.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param what Node name to search inside node.</span><br><span> *</span><br><span> * \retval 1 If a 'what' element is found inside 'node'.</span><br><span> * \retval 0 If no 'what' is found inside 'node'.</span><br><span>@@ -581,7 +581,7 @@</span><br><span> * \internal</span><br><span> * \brief Check if the passed node has at least one node inside it.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param node Root node to search node elements.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode Root node to search node elements.</span><br><span> *</span><br><span> * \retval 1 If a node element is found inside 'node'.</span><br><span> * \retval 0 If no node is found inside 'node'.</span><br><span>@@ -602,7 +602,7 @@</span><br><span> * \internal</span><br><span> * \brief Check if the passed node has at least one specialtag.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param node Root node to search "specialtags" elements.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode Root node to search "specialtags" elements.</span><br><span> *</span><br><span> * \retval 1 If a "specialtag" element is found inside 'node'.</span><br><span> * \retval 0 If no "specialtag" is found inside 'node'.</span><br><span>@@ -872,9 +872,9 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse an enumlist inside a <parameter> to generate a COMMAND syntax.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse an enumlist inside a \<parameter\> to generate a COMMAND syntax.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param fixnode A pointer to the <enumlist> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode A pointer to the \<enumlist\> node.</span><br><span> *</span><br><span> * \retval {<unknown>} on error.</span><br><span> * \retval A string inside brackets {} with the enum's separated by pipes |.</span><br><span>@@ -922,12 +922,12 @@</span><br><span> * \internal</span><br><span> * \brief Generate a syntax of COMMAND type.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param fixnode The <syntax> node pointer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode The \<syntax\> node pointer.</span><br><span> * \param name The name of the 'command'.</span><br><span> * \param printname Print the name of the command before the paramters?</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval On error, return just 'name'.</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval On success return the generated syntax.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return On error, return just 'name'.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \return On success return the generated syntax.</span><br><span> */</span><br><span> static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname)</span><br><span> {</span><br><span>@@ -1201,9 +1201,9 @@</span><br><span> /*!</span><br><span> * \internal</span><br><span> * \brief Build syntax information for an item</span><br><span style="color: hsl(0, 100%, 40%);">- * \param node The syntax node to parse</span><br><span style="color: hsl(0, 100%, 40%);">- * \param type The source type</span><br><span style="color: hsl(0, 100%, 40%);">- * \param name The name of the item that the syntax describes</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param root_node The syntax node to parse</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param type The source type</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param name The name of the item that the syntax describes</span><br><span> *</span><br><span> * \note This method exists for when you already have the node. This</span><br><span> * prevents having to lock the documentation tree twice</span><br><span>@@ -1287,11 +1287,11 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse a <para> element.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse a \<para\> element.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param node The <para> element pointer.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param tabs Added this string before the content of the <para> element.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param posttabs Added this string after the content of the <para> element.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param node The \<para\> element pointer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param tabs Add this string before the content of the \<para\> element.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param posttabs Added this string after the content of the \<para\> element.</span><br><span> * \param buffer This must be an already allocated ast_str. It will be used</span><br><span> * to store the result (if already has something it will be appended to the current</span><br><span> * string).</span><br><span>@@ -1346,10 +1346,10 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse an <example> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse an \<example\> node.</span><br><span> * \since 13.0.0</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param fixnode An ast xml pointer to the <example> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode An ast xml pointer to the \<example\> node.</span><br><span> * \param buffer The output buffer.</span><br><span> *</span><br><span> * \retval 0 if no example node is parsed.</span><br><span>@@ -1397,7 +1397,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse special elements defined in 'struct special_tags' special elements must have a <para> element inside them.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse special elements defined in 'struct special_tags' special elements must have a \<para\> element inside them.</span><br><span> *</span><br><span> * \param fixnode special tag node pointer.</span><br><span> * \param tabs put tabs before printing the node content.</span><br><span>@@ -1406,7 +1406,7 @@</span><br><span> *</span><br><span> * \retval 0 if no special element is parsed.</span><br><span> * \retval 1 if a special element is parsed (data is appended to buffer).</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval 2 if a special element is parsed and also a <para> element is parsed inside the specialtag.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 2 if a special element is parsed and also a \<para\> element is parsed inside the specialtag.</span><br><span> */</span><br><span> static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *tabs, const char *posttabs, struct ast_str **buffer)</span><br><span> {</span><br><span>@@ -1456,13 +1456,13 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse an <argument> element from the xml documentation.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse an \<argument\> element from the xml documentation.</span><br><span> *</span><br><span> * \param fixnode Pointer to the 'argument' xml node.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param insideparameter If we are parsing an <argument> inside a <parameter>.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param insideparameter If we are parsing an \<argument\> inside a \<parameter\>.</span><br><span> * \param paramtabs pre tabs if we are inside a parameter element.</span><br><span> * \param tabs What to be printed before the argument name.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param buffer Output buffer to put values found inside the <argument> element.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param buffer Output buffer to put values found inside the \<argument\> element.</span><br><span> *</span><br><span> * \retval 1 If there is content inside the argument.</span><br><span> * \retval 0 If the argument element is not parsed, or there is no content inside it.</span><br><span>@@ -1502,7 +1502,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse a <variable> node inside a <variablelist> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse a \<variable\> node inside a \<variablelist\> node.</span><br><span> *</span><br><span> * \param node The variable node to parse.</span><br><span> * \param tabs A string to be appended at the begining of the output that will be stored</span><br><span>@@ -1563,7 +1563,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse a <variablelist> node and put all the output inside 'buffer'.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse a \<variablelist\> node and put all the output inside 'buffer'.</span><br><span> *</span><br><span> * \param node The variablelist node pointer.</span><br><span> * \param tabs A string to be appended at the begining of the output that will be stored</span><br><span>@@ -1572,7 +1572,7 @@</span><br><span> * to store the result (if already has something it will be appended to the current</span><br><span> * string).</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval 1 If a <variablelist> element is parsed.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 1 If a \<variablelist\> element is parsed.</span><br><span> * \retval 0 On error.</span><br><span> */</span><br><span> static int xmldoc_parse_variablelist(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)</span><br><span>@@ -1717,10 +1717,11 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse a <enum> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse a \<enum\> node.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param fixnode An ast_xml_node pointer to the <enum> node.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param buffer The output buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode An ast_xml_node pointer to the \<enum\> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param tabs Add this string before the content of the \<enum\> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param buffer The output buffer.</span><br><span> *</span><br><span> * \retval 0 if content is not found inside the enum element (data is not appended to buffer).</span><br><span> * \retval 1 if content is found and data is appended to buffer.</span><br><span>@@ -1751,13 +1752,14 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse a <enumlist> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse a \<enumlist\> node.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param fixnode As ast_xml pointer to the <enumlist> node.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param buffer The ast_str output buffer.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode As ast_xml pointer to the \<enumlist\> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param tabs Add this string before the content of the \<enumlist\> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param buffer The ast_str output buffer.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval 0 if no <enumlist> node was parsed.</span><br><span style="color: hsl(0, 100%, 40%);">- * \retval 1 if a <enumlist> node was parsed.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 if no \<enumlist\> node was parsed.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 1 if a \<enumlist\> node was parsed.</span><br><span> */</span><br><span> static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)</span><br><span> {</span><br><span>@@ -1788,9 +1790,9 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse an <option> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse an \<option\> node.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param fixnode An ast_xml pointer to the <option> node.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fixnode An ast_xml pointer to the \<option\> node.</span><br><span> * \param tabs A string to be appended at the begining of each line being added to the</span><br><span> * buffer string.</span><br><span> * \param buffer The output buffer.</span><br><span>@@ -1835,7 +1837,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Parse an <optionlist> element from the xml documentation.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Parse an \<optionlist\> element from the xml documentation.</span><br><span> *</span><br><span> * \param fixnode Pointer to the optionlist xml node.</span><br><span> * \param tabs A string to be appended at the begining of each line being added to the</span><br><span>@@ -1970,9 +1972,9 @@</span><br><span> *</span><br><span> * \param node A pointer to the 'info' xml node.</span><br><span> * \param tabs A string to be appended at the beginning of each line being printed</span><br><span style="color: hsl(0, 100%, 40%);">- * inside 'buffer'</span><br><span style="color: hsl(0, 100%, 40%);">- * \param posttabs Add this string after the content of the <para> element, if one exists</span><br><span style="color: hsl(0, 100%, 40%);">- * \param String buffer to put values found inide the info element.</span><br><span style="color: hsl(120, 100%, 40%);">+ * inside 'buffer'.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param posttabs Add this string after the content of the \<para\> element, if one exists</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param buffer String buffer to put values found inide the info element.</span><br><span> *</span><br><span> * \retval 2 if the information contained a para element, and it returned a value of 2</span><br><span> * \retval 1 if information was put into the buffer</span><br><span>@@ -2091,11 +2093,11 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Return the string within a node formatted with <para> and <variablelist> elements.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Return the string within a node formatted with \<para\> and \<variablelist\> elements.</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * \param node Parent node where content resides.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param raw If set, return the node's content without further processing.</span><br><span style="color: hsl(0, 100%, 40%);">- * \param raw_wrap Wrap raw text.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param node Parent node where content resides.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param raw_output If set, return the node's content without further processing.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param raw_wrap Wrap raw text.</span><br><span> *</span><br><span> * \retval NULL on error</span><br><span> * \retval Node content on success.</span><br><span></span><br></pre><div style="white-space:pre-wrap"></div><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17568">change 17568</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/17568"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 19 </div>
<div style="display:none"> Gerrit-Change-Id: I654ba0debe8351038d4433716434a09370f04c9d </div>
<div style="display:none"> Gerrit-Change-Number: 17568 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Alexander Traud <pabstraud@compuserve.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>