#ifndef _ASTERISK_XML_H
#define _ASTERISK_XML_H
-/*! \file
+/*! \file
* \brief Asterisk XML abstraction layer
*/
struct ast_xml_node;
struct ast_xml_doc;
-/*! \brief Initialize the XML library implementation.
+/*! \brief Initialize the XML library implementation.
* This function is used to setup everything needed
* to start working with the xml implementation.
* \retval 0 On success.
*/
int ast_xml_init(void);
-/*! \brief Cleanup library allocated global data.
+/*! \brief Cleanup library allocated global data.
* \retval 0 On success.
* \retval 1 On error.
*/
*/
struct ast_xml_node *ast_xml_get_root(struct ast_xml_doc *doc);
-/*! \brief Free node
+/*! \brief Free node
* \param node Node to be released.
*/
void ast_xml_free_node(struct ast_xml_node *node);
/*! \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
+/*! \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;
/*! \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 to print the parameter list inside the
+ * and based on the reverse value it makes use of fmt to print the parameter list inside the
* realloced buffer (syntax).
* \param reverse We are going backwards while generating the syntax?
* \param len Current length of 'syntax' buffer.
#undef MP
}
-/*! \internal
+/*! \internal
* \brief Parse an enumlist inside a <parameter> to generate a COMMAND
* syntax.
* \param fixnode A pointer to the <enumlist> node.
* \retval {<unknown>} on error.
- * \retval A string inside brackets {} with the enum's separated by pipes |.
+ * \retval A string inside brackets {} with the enum's separated by pipes |.
*/
static char *xmldoc_parse_cmd_enumlist(struct ast_xml_node *fixnode)
{
}
/*! \internal
- * \brief Generate a syntax of COMMAND type.
+ * \brief Generate a syntax of COMMAND type.
* \param fixnode The <syntax> node pointer.
* \param name The name of the 'command'.
* \param printname Print the name of the command before the paramters?
ast_xml_free_text(tmptext);
if (tmpstr) {
if (strcasecmp(ast_xml_node_get_name(tmp), "text")) {
- ast_str_append(buffer, 0, "<%s>%s</%s>", ast_xml_node_get_name(tmp),
+ ast_str_append(buffer, 0, "<%s>%s</%s>", ast_xml_node_get_name(tmp),
tmpstr->str, ast_xml_node_get_name(tmp));
} else {
ast_str_append(buffer, 0, "%s", tmpstr->str);