Remove constant conditionals (dead-code).
[asterisk/asterisk.git] / main / xmldoc.c
index 71def2a..105bee0 100644 (file)
@@ -29,8 +29,6 @@
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include "asterisk/_private.h"
 #include "asterisk/paths.h"
 #include "asterisk/linkedlists.h"
@@ -47,12 +45,7 @@ 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;
+static const int xmldoc_text_columns = 79;
 
 /*! \brief XML documentation language. */
 static char documentation_language[6];
@@ -66,6 +59,7 @@ struct documentation_tree {
 
 static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname);
 static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer);
+static void xmldoc_parse_parameter(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer);
 static int xmldoc_parse_info(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer);
 static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer);
 static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *tabs, const char *posttabs, struct ast_str **buffer);
@@ -99,7 +93,9 @@ static const struct strcolorized_tags {
 
        /* Special tags */
        { "", "", COLOR_YELLOW, "<note>",   "</note>" },
-       { "", "", COLOR_RED,   "<warning>", "</warning>" }
+       { "", "", COLOR_RED,   "<warning>", "</warning>" },
+       { "", "", COLOR_WHITE, "<example>", "</example>" },
+       { "", "", COLOR_GRAY, "<exampletext>", "</exampletext>"},
 };
 
 static const struct strspecial_tags {
@@ -108,14 +104,18 @@ static const struct strspecial_tags {
        const char *end;                /*!< Print this at the end. */
 } special_tags[] = {
        { "note",    "<note>NOTE:</note> ",             "" },
-       { "warning", "<warning>WARNING!!!:</warning> ", "" }
+       { "warning", "<warning>WARNING!!!:</warning> ", "" },
+       { "example", "<example>Example:</example> ", "" },
 };
 
-/*! \internal
- *  \brief Calculate the space in bytes used by a format string
- *         that will be passed to a sprintf function.
- *  \param postbr The format string to use to calculate the length.
- *  \retval The postbr length.
+/*!
+ * \internal
+ * \brief Calculate the space in bytes used by a format string
+ *        that will be passed to a sprintf function.
+ *
+ * \param postbr The format string to use to calculate the length.
+ *
+ * \retval The postbr length.
  */
 static int xmldoc_postbrlen(const char *postbr)
 {
@@ -136,12 +136,14 @@ static int xmldoc_postbrlen(const char *postbr)
        return postbrreallen;
 }
 
-/*! \internal
- *  \brief Setup postbr to be used while wrapping the text.
- *         Add to postbr array all the spaces and tabs at the beginning of text.
- *  \param postbr output array.
- *  \param len text array length.
- *  \param text Text with format string before the actual string.
+/*!
+ * \internal
+ * \brief Setup postbr to be used while wrapping the text.
+ *        Add to postbr array all the spaces and tabs at the beginning of text.
+ *
+ * \param postbr output array.
+ * \param len text array length.
+ * \param text Text with format string before the actual string.
  */
 static void xmldoc_setpostbr(char *postbr, size_t len, const char *text)
 {
@@ -161,93 +163,24 @@ static void xmldoc_setpostbr(char *postbr, size_t len, const char *text)
        postbr[postbrlen] = '\0';
 }
 
-/*! \internal
- *  \brief Try to find a space or a break in text starting at currentpost
- *         and moving at most maxdiff positions.
- *         Helper for xmldoc_string_wrap().
- *  \param text Input string where it will search.
- *  \param currentpos Current position within text.
- *  \param maxdiff Not move more than maxdiff inside text.
- *  \retval 1 if a space or break is found inside text while moving.
- *  \retval 0 if no space or break is found.
- */
-static int xmldoc_wait_nextspace(const char *text, int currentpos, int maxdiff)
-{
-       int i, textlen;
-
-       if (!text) {
-               return 0;
-       }
-
-       textlen = strlen(text);
-       for (i = currentpos; i < textlen; i++) {
-               if (text[i] == ESC) {
-                       /* Move to the end of the escape sequence */
-                       while (i < textlen && text[i] != 'm') {
-                               i++;
-                       }
-               } else if (text[i] == ' ' || text[i] == '\n') {
-                       /* Found the next space or linefeed */
-                       return 1;
-               } else if (i - currentpos > maxdiff) {
-                       /* We have looked the max distance and didn't find it */
-                       return 0;
-               }
-       }
-
-       /* Reached the end and did not find it */
-
-       return 0;
-}
-
-/*! \internal
- *  \brief Helper function for xmldoc_string_wrap().
- *        Try to found a space or a break inside text moving backward
- *        not more than maxdiff positions.
- *  \param text The input string where to search for a space.
- *  \param currentpos The current cursor position.
- *  \param maxdiff The max number of positions to move within text.
- *  \retval 0 If no space is found (Notice that text[currentpos] is not a space or a break)
- *  \retval > 0 If a space or a break is found, and the result is the position relative to
- *             currentpos.
- */
-static int xmldoc_foundspace_backward(const char *text, int currentpos, int maxdiff)
-{
-       int i;
-
-       for (i = currentpos; i > 0; i--) {
-               if (text[i] == ' ' || text[i] == '\n') {
-                       return (currentpos - i);
-               } else if (text[i] == 'm' && (text[i - 1] >= '0' || text[i - 1] <= '9')) {
-                       /* give up, we found the end of a possible ESC sequence. */
-                       return 0;
-               } else if (currentpos - i > maxdiff) {
-                       /* give up, we can't move anymore. */
-                       return 0;
-               }
-       }
-
-       /* we found the beginning of the text */
-
-       return 0;
-}
-
-/*! \internal
- *  \brief Justify a text to a number of columns.
- *  \param text Input text to be justified.
- *  \param columns Number of columns to preserve in the text.
- *  \param maxdiff Try to not cut a word when goinf down.
- *  \retval NULL on error.
- *  \retval The wrapped text.
+/*!
+ * \internal
+ * \brief Justify a text to a number of columns.
+ *
+ * \param text Input text to be justified.
+ * \param columns Number of columns to preserve in the text.
+ *
+ * \retval NULL on error.
+ * \retval The wrapped text.
  */
-static char *xmldoc_string_wrap(const char *text, int columns, int maxdiff)
+static char *xmldoc_string_wrap(const char *text, int columns)
 {
        struct ast_str *tmp;
        char *ret, postbr[160];
-       int count = 1, i, backspace, needtobreak = 0, colmax, textlen;
+       int count, i, textlen, postbrlen, lastbreak;
 
        /* sanity check */
-       if (!text || columns <= 0 || maxdiff < 0) {
+       if (!text || columns <= 0) {
                ast_log(LOG_WARNING, "Passing wrong arguments while trying to wrap the text\n");
                return NULL;
        }
@@ -260,55 +193,44 @@ static char *xmldoc_string_wrap(const char *text, int columns, int maxdiff)
 
        /* Check for blanks and tabs and put them in postbr. */
        xmldoc_setpostbr(postbr, sizeof(postbr), text);
-       colmax = columns - xmldoc_postbrlen(postbr);
+       postbrlen = xmldoc_postbrlen(postbr);
+
+       count = 0;
+       lastbreak = 0;
 
        textlen = strlen(text);
        for (i = 0; i < textlen; i++) {
-               if (needtobreak || !(count % colmax)) {
-                       if (text[i] == ' ') {
-                               ast_str_append(&tmp, 0, "\n%s", postbr);
-                               needtobreak = 0;
-                               count = 1;
-                       } else if (text[i] != '\n') {
-                               needtobreak = 1;
-                               if (xmldoc_wait_nextspace(text, i, maxdiff)) {
-                                       /* wait for the next space */
-                                       ast_str_append(&tmp, 0, "%c", text[i]);
-                                       continue;
-                               }
-                               /* Try to look backwards */
-                               backspace = xmldoc_foundspace_backward(text, i, maxdiff);
-                               if (backspace) {
-                                       needtobreak = 1;
-                                       ast_str_truncate(tmp, -backspace);
-                                       i -= backspace + 1;
-                                       continue;
-                               }
-                               ast_str_append(&tmp, 0, "\n%s", postbr);
-                               needtobreak = 0;
-                               count = 1;
-                       }
-                       /* skip blanks after a \n */
-                       while (text[i] == ' ') {
-                               i++;
-                       }
-               }
                if (text[i] == '\n') {
                        xmldoc_setpostbr(postbr, sizeof(postbr), &text[i] + 1);
-                       colmax = columns - xmldoc_postbrlen(postbr);
-                       needtobreak = 0;
-                       count = 1;
-               }
-               if (text[i] == ESC) {
-                       /* Ignore Escape sequences. */
+                       postbrlen = xmldoc_postbrlen(postbr);
+                       count = 0;
+                       lastbreak = 0;
+               } else if (text[i] == ESC) {
+                       /* Walk over escape sequences without counting them. */
                        do {
                                ast_str_append(&tmp, 0, "%c", text[i]);
                                i++;
                        } while (i < textlen && text[i] != 'm');
                } else {
+                       if (text[i] == ' ') {
+                               lastbreak = i;
+                       }
                        count++;
                }
-               ast_str_append(&tmp, 0, "%c", text[i]);
+
+               if (count > columns) {
+                       /* Seek backwards if it was at most 30 characters ago. */
+                       int back = i - lastbreak;
+                       if (lastbreak && back > 0 && back < 30) {
+                               ast_str_truncate(tmp, -back);
+                               i = lastbreak; /* go back a bit */
+                       }
+                       ast_str_append(&tmp, 0, "\n%s", postbr);
+                       count = postbrlen;
+                       lastbreak = 0;
+               } else {
+                       ast_str_append(&tmp, 0, "%c", text[i]);
+               }
        }
 
        ret = ast_strdup(ast_str_buffer(tmp));
@@ -413,27 +335,30 @@ char *ast_xmldoc_printable(const char *bwinput, int withcolors)
        }
 
        if (withcolors) {
-               ast_str_append(&colorized, 0, "%s", term_end());
+               ast_str_append(&colorized, 0, "%s", ast_term_reset());
                if (!colorized) {
                        return NULL;
                }
        }
 
        /* Wrap the text, notice that string wrap will avoid cutting an ESC sequence. */
-       wrapped = xmldoc_string_wrap(ast_str_buffer(colorized), xmldoc_text_columns, xmldoc_max_diff);
+       wrapped = xmldoc_string_wrap(ast_str_buffer(colorized), xmldoc_text_columns);
 
        ast_free(colorized);
 
        return wrapped;
 }
 
-/*! \internal
- *  \brief Cleanup spaces and tabs after a \n
- *  \param text String to be cleaned up.
- *  \param output buffer (not already allocated).
- *  \param lastspaces Remove last spaces in the string.
+/*!
+ * \internal
+ * \brief Cleanup spaces and tabs after a \n
+ *
+ * \param text String to be cleaned up.
+ * \param output buffer (not already allocated).
+ * \param lastspaces Remove last spaces in the string.
+ * \param maintain_newlines Preserve new line characters (\n \r) discovered in the string
  */
-static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int lastspaces)
+static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int lastspaces, int maintain_newlines)
 {
        int i;
        size_t textlen;
@@ -453,6 +378,9 @@ static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int
 
        for (i = 0; i < textlen; i++) {
                if (text[i] == '\n' || text[i] == '\r') {
+                       if (maintain_newlines) {
+                               ast_str_append(output, 0, "%c", text[i]);
+                       }
                        /* remove spaces/tabs/\n after a \n. */
                        while (text[i + 1] == '\t' || text[i + 1] == '\r' || text[i + 1] == '\n') {
                                i++;
@@ -470,11 +398,14 @@ static void xmldoc_string_cleanup(const char *text, struct ast_str **output, int
        }
 }
 
-/*! \internal
+/*!
+ * \internal
  * \brief Check if the given attribute on the given node matches the given value.
+ *
  * \param node the node to match
  * \param attr the name of the attribute
  * \param value the expected value of the attribute
+ *
  * \retval true if the given attribute contains the given value
  * \retval false if the given attribute does not exist or does not contain the given value
  */
@@ -486,16 +417,19 @@ static int xmldoc_attribute_match(struct ast_xml_node *node, const char *attr, c
        return match;
 }
 
-/*! \internal
- *  \brief Get the application/function node for 'name' application/function with language 'language'
- *         and module 'module' if we don't find any, get the first application
- *         with 'name' no matter which language or module.
- *  \param type 'application', 'function', ...
- *  \param name Application or Function name.
- *  \param module Module item is in.
- *  \param language Try to get this language (if not found try with en_US)
- *  \retval NULL on error.
- *  \retval A node of type ast_xml_node.
+/*!
+ * \internal
+ * \brief Get the application/function node for 'name' application/function with language 'language'
+ *        and module 'module' if we don't find any, get the first application
+ *        with 'name' no matter which language or module.
+ *
+ * \param type 'application', 'function', ...
+ * \param name Application or Function name.
+ * \param module Module item is in.
+ * \param language Try to get this language (if not found try with en_US)
+ *
+ * \retval NULL on error.
+ * \retval A node of type ast_xml_node.
  */
 static struct ast_xml_node *xmldoc_get_node(const char *type, const char *name, const char *module, const char *language)
 {
@@ -568,19 +502,24 @@ static struct ast_xml_node *xmldoc_get_node(const char *type, const char *name,
        return node;
 }
 
-/*! \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
- *         realloced buffer (syntax).
- *  \param reverse We are going backwards while generating the syntax?
- *  \param len Current length of 'syntax' buffer.
- *  \param syntax Output buffer for the concatenated values.
- *  \param fmt A format string that will be used in a sprintf call.
+/*!
+ * \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
+ *        realloced buffer (syntax).
+ *
+ * \param reverse We are going backwards while generating the syntax?
+ * \param len Current length of 'syntax' buffer.
+ * \param syntax Output buffer for the concatenated values.
+ * \param fmt A format string that will be used in a sprintf call.
  */
 static void __attribute__((format(printf, 4, 5))) xmldoc_reverse_helper(int reverse, int *len, char **syntax, const char *fmt, ...)
 {
-       int totlen, tmpfmtlen;
-       char *tmpfmt, tmp;
+       int totlen;
+       int tmpfmtlen;
+       char *tmpfmt;
+       char *new_syntax;
+       char tmp;
        va_list ap;
 
        va_start(ap, fmt);
@@ -593,12 +532,12 @@ static void __attribute__((format(printf, 4, 5))) xmldoc_reverse_helper(int reve
        tmpfmtlen = strlen(tmpfmt);
        totlen = *len + tmpfmtlen + 1;
 
-       *syntax = ast_realloc(*syntax, totlen);
-
-       if (!*syntax) {
+       new_syntax = ast_realloc(*syntax, totlen);
+       if (!new_syntax) {
                ast_free(tmpfmt);
                return;
        }
+       *syntax = new_syntax;
 
        if (reverse) {
                memmove(*syntax + tmpfmtlen, *syntax, *len);
@@ -616,12 +555,15 @@ static void __attribute__((format(printf, 4, 5))) xmldoc_reverse_helper(int reve
        ast_free(tmpfmt);
 }
 
-/*! \internal
- *  \brief Check if the passed node has 'what' tags inside it.
- *  \param node Root node to search 'what' elements.
- *  \param what node name to search inside node.
- *  \retval 1 If a 'what' element is found inside 'node'.
- *  \retval 0 If no 'what' is found inside 'node'.
+/*!
+ * \internal
+ * \brief Check if the passed node has 'what' tags inside it.
+ *
+ * \param node Root node to search 'what' elements.
+ * \param what node name to search inside node.
+ *
+ * \retval 1 If a 'what' element is found inside 'node'.
+ * \retval 0 If no 'what' is found inside 'node'.
  */
 static int xmldoc_has_inside(struct ast_xml_node *fixnode, const char *what)
 {
@@ -635,11 +577,14 @@ static int xmldoc_has_inside(struct ast_xml_node *fixnode, const char *what)
        return 0;
 }
 
-/*! \internal
- *  \brief Check if the passed node has at least one node inside it.
- *  \param node Root node to search node elements.
- *  \retval 1 If a node element is found inside 'node'.
- *  \retval 0 If no node is found inside 'node'.
+/*!
+ * \internal
+ * \brief Check if the passed node has at least one node inside it.
+ *
+ * \param node Root node to search node elements.
+ *
+ * \retval 1 If a node element is found inside 'node'.
+ * \retval 0 If no node is found inside 'node'.
  */
 static int xmldoc_has_nodes(struct ast_xml_node *fixnode)
 {
@@ -653,11 +598,14 @@ static int xmldoc_has_nodes(struct ast_xml_node *fixnode)
        return 0;
 }
 
-/*! \internal
- *  \brief Check if the passed node has at least one specialtag.
- *  \param node Root node to search "specialtags" elements.
- *  \retval 1 If a "specialtag" element is found inside 'node'.
- *  \retval 0 If no "specialtag" is found inside 'node'.
+/*!
+ * \internal
+ * \brief Check if the passed node has at least one specialtag.
+ *
+ * \param node Root node to search "specialtags" elements.
+ *
+ * \retval 1 If a "specialtag" element is found inside 'node'.
+ * \retval 0 If no "specialtag" is found inside 'node'.
  */
 static int xmldoc_has_specialtags(struct ast_xml_node *fixnode)
 {
@@ -674,15 +622,18 @@ static int xmldoc_has_specialtags(struct ast_xml_node *fixnode)
        return 0;
 }
 
-/*! \internal
- *  \brief Build the syntax for a specified starting node.
- *  \param rootnode A pointer to the ast_xml root node.
- *  \param rootname Name of the application, function, option, etc. to build the syntax.
- *  \param childname The name of each parameter node.
- *  \param printparenthesis Boolean if we must print parenthesis if not parameters are found in the rootnode.
- *  \param printrootname Boolean if we must print the rootname before the syntax and parenthesis at the begining/end.
- *  \retval NULL on error.
- *  \retval An ast_malloc'ed string with the syntax generated.
+/*!
+ * \internal
+ * \brief Build the syntax for a specified starting node.
+ *
+ * \param rootnode A pointer to the ast_xml root node.
+ * \param rootname Name of the application, function, option, etc. to build the syntax.
+ * \param childname The name of each parameter node.
+ * \param printparenthesis Boolean if we must print parenthesis if not parameters are found in the rootnode.
+ * \param printrootname Boolean if we must print the rootname before the syntax and parenthesis at the begining/end.
+ *
+ * \retval NULL on error.
+ * \retval An ast_malloc'ed string with the syntax generated.
  */
 static char *xmldoc_get_syntax_fun(struct ast_xml_node *rootnode, const char *rootname, const char *childname, int printparenthesis, int printrootname)
 {
@@ -919,12 +870,14 @@ static char *xmldoc_get_syntax_fun(struct ast_xml_node *rootnode, const char *ro
 #undef MP
 }
 
-/*! \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 |.
+/*!
+ * \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 |.
  */
 static char *xmldoc_parse_cmd_enumlist(struct ast_xml_node *fixnode)
 {
@@ -965,13 +918,16 @@ static char *xmldoc_parse_cmd_enumlist(struct ast_xml_node *fixnode)
        return ret;
 }
 
-/*! \internal
- *  \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?
- *  \retval On error, return just 'name'.
- *  \retval On success return the generated syntax.
+/*!
+ * \internal
+ * \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?
+ *
+ * \retval On error, return just 'name'.
+ * \retval On success return the generated syntax.
  */
 static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *name, int printname)
 {
@@ -1068,13 +1024,16 @@ static char *xmldoc_get_syntax_cmd(struct ast_xml_node *fixnode, const char *nam
        return ret;
 }
 
-/*! \internal
- *  \brief Generate an AMI action/event syntax.
- *  \param fixnode The manager action/event node pointer.
- *  \param name The name of the manager action/event.
- *  \param manager_type "Action" or "Event"
- *  \retval The generated syntax.
- *  \retval NULL on error.
+/*!
+ * \internal
+ * \brief Generate an AMI action/event syntax.
+ *
+ * \param fixnode The manager action/event node pointer.
+ * \param name The name of the manager action/event.
+ * \param manager_type "Action" or "Event"
+ *
+ * \retval The generated syntax.
+ * \retval NULL on error.
  */
 static char *xmldoc_get_syntax_manager(struct ast_xml_node *fixnode, const char *name, const char *manager_type)
 {
@@ -1180,9 +1139,9 @@ static char *xmldoc_get_syntax_config_option(struct ast_xml_node *fixnode, const
        regex = ast_xml_get_attribute(fixnode, "regex");
        ast_str_set(&syntax, 0, "%s = [%s] (Default: %s) (Regex: %s)\n",
                name,
-               type,
-               default_value,
-               regex ? regex : "False");
+               type ?: "",
+               default_value ?: "n/a",
+               regex ?: "False");
 
        ast_xml_free_attr(type);
        ast_xml_free_attr(default_value);
@@ -1219,10 +1178,13 @@ static struct strsyntaxtype {
     { "agi",          COMMAND_SYNTAX       },
 };
 
-/*! \internal
- *  \brief Get syntax type based on type of node.
- *  \param type Type of node.
- *  \retval The type of syntax to generate based on the type of node.
+/*!
+ * \internal
+ * \brief Get syntax type based on type of node.
+ *
+ * \param type Type of node.
+ *
+ * \retval The type of syntax to generate based on the type of node.
  */
 static enum syntaxtype xmldoc_get_syntax_type(const char *type)
 {
@@ -1246,8 +1208,8 @@ static enum syntaxtype xmldoc_get_syntax_type(const char *type)
  * \note This method exists for when you already have the node.  This
  * prevents having to lock the documentation tree twice
  *
- * \returns A malloc'd character pointer to the syntax of the item
- * \returns NULL on failure
+ * \retval A malloc'd character pointer to the syntax of the item
+ * \retval NULL on failure
  *
  * \since 11
  */
@@ -1300,18 +1262,21 @@ char *ast_xmldoc_build_syntax(const char *type, const char *name, const char *mo
        return _ast_xmldoc_build_syntax(node, type, name);
 }
 
-/*! \internal
- *  \brief Parse common internal elements.  This includes paragraphs, special
- *         tags, and information nodes.
- *  \param node The element to parse
- *  \param tabs Add this string before the content of the parsed element.
- *  \param posttabs Add this string after the content of the parsed element.
- *  \param buffer This must be an already allocated ast_str. It will be used to
- *                store the result (if something has already been placed in the
- *                buffer, the parsed elements will be appended)
- *  \retval 1 if any data was appended to the buffer
- *  \retval 2 if the data appended to the buffer contained a text paragraph
- *  \retval 0 if no data was appended to the buffer
+/*!
+ * \internal
+ * \brief Parse common internal elements.  This includes paragraphs, special
+ *        tags, and information nodes.
+ *
+ * \param node The element to parse
+ * \param tabs Add this string before the content of the parsed element.
+ * \param posttabs Add this string after the content of the parsed element.
+ * \param buffer This must be an already allocated ast_str. It will be used to
+ *               store the result (if something has already been placed in the
+ *               buffer, the parsed elements will be appended)
+ *
+ * \retval 1 if any data was appended to the buffer
+ * \retval 2 if the data appended to the buffer contained a text paragraph
+ * \retval 0 if no data was appended to the buffer
  */
 static int xmldoc_parse_common_elements(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
 {
@@ -1320,17 +1285,20 @@ static int xmldoc_parse_common_elements(struct ast_xml_node *node, const char *t
                || xmldoc_parse_info(node, tabs, posttabs, buffer));
 }
 
-/*! \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.
- *  \param buffer This must be an already allocated ast_str. It will be used
- *         to store the result (if already has something it will be appended to the current
- *         string).
- *  \retval 1 If 'node' is a named 'para'.
- *  \retval 2 If data is appended in buffer.
- *  \retval 0 on error.
+/*!
+ * \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.
+ * \param buffer This must be an already allocated ast_str. It will be used
+ *        to store the result (if already has something it will be appended to the current
+ *        string).
+ *
+ * \retval 1 If 'node' is a named 'para'.
+ * \retval 2 If data is appended in buffer.
+ * \retval 0 on error.
  */
 static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
 {
@@ -1356,7 +1324,7 @@ static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const
                tmptext = ast_xml_get_text(tmp);
                if (tmptext) {
                        /* Strip \n etc. */
-                       xmldoc_string_cleanup(tmptext, &tmpstr, 0);
+                       xmldoc_string_cleanup(tmptext, &tmpstr, 0, 0);
                        ast_xml_free_text(tmptext);
                        if (tmpstr) {
                                if (strcasecmp(ast_xml_node_get_name(tmp), "text")) {
@@ -1376,20 +1344,74 @@ static int xmldoc_parse_para(struct ast_xml_node *node, const char *tabs, const
        return ret;
 }
 
-/*! \internal
- *  \brief Parse special elements defined in 'struct special_tags' special elements must have a <para> element inside them.
- *  \param fixnode special tag node pointer.
- *  \param tabs put tabs before printing the node content.
- *  \param posttabs put posttabs after printing node content.
- *  \param buffer Output buffer, the special tags will be appended here.
- *  \retval 0 if no special element is parsed.
- *  \retval 1 if a special element is parsed (data is appended to buffer).
- *  \retval 2 if a special element is parsed and also a <para> element is parsed inside the specialtag.
+/*!
+ * \internal
+ * \brief Parse an <example> node.
+ * \since 13.0.0
+ *
+ * \param fixnode An ast xml pointer to the <example> node.
+ * \param buffer The output buffer.
+ *
+ * \retval 0 if no example node is parsed.
+ * \retval 1 if an example node is parsed.
+ */
+static int xmldoc_parse_example(struct ast_xml_node *fixnode, struct ast_str **buffer)
+{
+       struct ast_xml_node *node = fixnode;
+       const char *tmptext;
+       const char *title;
+       struct ast_str *stripped_text;
+       int ret = 0;
+
+       if (!node || !ast_xml_node_get_children(node)) {
+               return ret;
+       }
+
+       if (strcasecmp(ast_xml_node_get_name(node), "example")) {
+               return ret;
+       }
+
+       ret = 1;
+
+       title = ast_xml_get_attribute(node, "title");
+       if (title) {
+               ast_str_append(buffer, 0, "%s", title);
+               ast_xml_free_attr(title);
+       }
+       ast_str_append(buffer, 0, "\n");
+
+       for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
+               tmptext = ast_xml_get_text(node);
+               if (tmptext) {
+                       xmldoc_string_cleanup(tmptext, &stripped_text, 0, 1);
+                       if (stripped_text) {
+                               ast_str_append(buffer, 0, "<exampletext>%s</exampletext>\n", ast_str_buffer(stripped_text));
+                               ast_xml_free_text(tmptext);
+                               ast_free(stripped_text);
+                       }
+               }
+       }
+
+       return ret;
+}
+
+/*!
+ * \internal
+ * \brief Parse special elements defined in 'struct special_tags' special elements must have a <para> element inside them.
+ *
+ * \param fixnode special tag node pointer.
+ * \param tabs put tabs before printing the node content.
+ * \param posttabs put posttabs after printing node content.
+ * \param buffer Output buffer, the special tags will be appended here.
+ *
+ * \retval 0 if no special element is parsed.
+ * \retval 1 if a special element is parsed (data is appended to buffer).
+ * \retval 2 if a special element is parsed and also a <para> element is parsed inside the specialtag.
  */
 static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *tabs, const char *posttabs, struct ast_str **buffer)
 {
        struct ast_xml_node *node = fixnode;
-       int ret = 0, i, count = 0;
+       int ret = 0, i;
 
        if (!node || !ast_xml_node_get_children(node)) {
                return ret;
@@ -1408,11 +1430,16 @@ static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *ta
                        ast_str_append(buffer, 0, "%s%s", tabs, special_tags[i].init);
                }
 
+               if (xmldoc_parse_example(node, buffer)) {
+                       ret = 1;
+                       break;
+               }
+
                /* parse <para> elements inside special tags. */
                for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
                        /* first <para> just print it without tabs at the begining. */
-                       if ((xmldoc_parse_para(node, (!count ? "" : tabs), posttabs, buffer) == 2)
-                               || (xmldoc_parse_info(node, (!count ? "": tabs), posttabs, buffer) == 2)) {
+                       if ((xmldoc_parse_para(node, "", posttabs, buffer) == 2)
+                               || (xmldoc_parse_info(node, "", posttabs, buffer) == 2)) {
                                ret = 2;
                        }
                }
@@ -1427,64 +1454,18 @@ static int xmldoc_parse_specialtags(struct ast_xml_node *fixnode, const char *ta
        return ret;
 }
 
-/*! \internal
- *  \brief Parse an 'info' tag inside an element.
- *  \param node A pointer to the 'info' xml node.
- *  \param tabs A string to be appended at the beginning of each line being printed
- *              inside 'buffer'
- *  \param posttabs Add this string after the content of the <para> element, if one exists
- *  \param String buffer to put values found inide the info element.
- *  \ret 2 if the information contained a para element, and it returned a value of 2
- *  \ret 1 if information was put into the buffer
- *  \ret 0 if no information was put into the buffer or error
- */
-static int xmldoc_parse_info(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
-{
-       const char *tech;
-       char *internaltabs;
-       int internal_ret;
-       int ret = 0;
-
-       if (strcasecmp(ast_xml_node_get_name(node), "info")) {
-               return ret;
-       }
-
-       ast_asprintf(&internaltabs, "%s    ", tabs);
-       if (!internaltabs) {
-               return ret;
-       }
-
-       tech = ast_xml_get_attribute(node, "tech");
-       if (tech) {
-               ast_str_append(buffer, 0, "%s<note>Technology: %s</note>\n", internaltabs, tech);
-               ast_xml_free_attr(tech);
-       }
-
-       ret = 1;
-
-       for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
-               if (!strcasecmp(ast_xml_node_get_name(node), "enumlist")) {
-                       xmldoc_parse_enumlist(node, internaltabs, buffer);
-               } else if ((internal_ret = xmldoc_parse_common_elements(node, internaltabs, posttabs, buffer))) {
-                       if (internal_ret > ret) {
-                               ret = internal_ret;
-                       }
-               }
-       }
-       ast_free(internaltabs);
-
-       return ret;
-}
-
-/*! \internal
- *  \brief Parse an <argument> element from the xml documentation.
- *  \param fixnode Pointer to the 'argument' xml node.
- *  \param insideparameter If we are parsing an <argument> inside a <parameter>.
- *  \param paramtabs pre tabs if we are inside a parameter element.
- *  \param tabs What to be printed before the argument name.
- *  \param buffer Output buffer to put values found inside the <argument> element.
- *  \retval 1 If there is content inside the argument.
- *  \retval 0 If the argument element is not parsed, or there is no content inside it.
+/*!
+ * \internal
+ * \brief Parse an <argument> element from the xml documentation.
+ *
+ * \param fixnode Pointer to the 'argument' xml node.
+ * \param insideparameter If we are parsing an <argument> inside a <parameter>.
+ * \param paramtabs pre tabs if we are inside a parameter element.
+ * \param tabs What to be printed before the argument name.
+ * \param buffer Output buffer to put values found inside the <argument> element.
+ *
+ * \retval 1 If there is content inside the argument.
+ * \retval 0 If the argument element is not parsed, or there is no content inside it.
  */
 static int xmldoc_parse_argument(struct ast_xml_node *fixnode, int insideparameter, const char *paramtabs, const char *tabs, struct ast_str **buffer)
 {
@@ -1519,16 +1500,19 @@ static int xmldoc_parse_argument(struct ast_xml_node *fixnode, int insideparamet
        return ret;
 }
 
-/*! \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.
- *  \param buffer This must be an already created ast_str. It will be used
- *         to store the result (if already has something it will be appended to the current
- *         string).
- *  \retval 0 if no data is appended.
- *  \retval 1 if data is appended.
+/*!
+ * \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.
+ * \param buffer This must be an already created ast_str. It will be used
+ *        to store the result (if already has something it will be appended to the current
+ *        string).
+ *
+ * \retval 0 if no data is appended.
+ * \retval 1 if data is appended.
  */
 static int xmldoc_parse_variable(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)
 {
@@ -1564,7 +1548,7 @@ static int xmldoc_parse_variable(struct ast_xml_node *node, const char *tabs, st
                /* Check inside this node for any explanation about its meaning. */
                if (tmptext) {
                        /* Cleanup text. */
-                       xmldoc_string_cleanup(tmptext, &cleanstr, 1);
+                       xmldoc_string_cleanup(tmptext, &cleanstr, 1, 0);
                        ast_xml_free_text(tmptext);
                        if (cleanstr && ast_str_strlen(cleanstr) > 0) {
                                ast_str_append(buffer, 0, ":%s", ast_str_buffer(cleanstr));
@@ -1577,16 +1561,19 @@ static int xmldoc_parse_variable(struct ast_xml_node *node, const char *tabs, st
        return ret;
 }
 
-/*! \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.
- *  \param buffer This must be an already created ast_str. It will be used
- *         to store the result (if already has something it will be appended to the current
- *         string).
- *  \retval 1 If a <variablelist> element is parsed.
- *  \retval 0 On error.
+/*!
+ * \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.
+ * \param buffer This must be an already created ast_str. It will be used
+ *        to store the result (if already has something it will be appended to the current
+ *        string).
+ *
+ * \retval 1 If a <variablelist> element is parsed.
+ * \retval 0 On error.
  */
 static int xmldoc_parse_variablelist(struct ast_xml_node *node, const char *tabs, struct ast_str **buffer)
 {
@@ -1635,13 +1622,14 @@ static int xmldoc_parse_variablelist(struct ast_xml_node *node, const char *tabs
 /*!
  * \internal
  * \brief Build seealso information for an item
+ *
  * \param node The seealso node to parse
  *
  * \note This method exists for when you already have the node.  This
  * prevents having to lock the documentation tree twice
  *
- * \returns A malloc'd character pointer to the seealso information of the item
- * \returns NULL on failure
+ * \retval A malloc'd character pointer to the seealso information of the item
+ * \retval NULL on failure
  *
  * \since 11
  */
@@ -1727,12 +1715,15 @@ char *ast_xmldoc_build_seealso(const char *type, const char *name, const char *m
        return output;
 }
 
-/*! \internal
- *  \brief Parse a <enum> node.
- *  \brief fixnode An ast_xml_node pointer to the <enum> node.
- *  \bried buffer The output buffer.
- *  \retval 0 if content is not found inside the enum element (data is not appended to buffer).
- *  \retval 1 if content is found and data is appended to buffer.
+/*!
+ * \internal
+ * \brief Parse a <enum> node.
+ *
+ * \param fixnode An ast_xml_node pointer to the <enum> node.
+ * \param buffer The output buffer.
+ *
+ * \retval 0 if content is not found inside the enum element (data is not appended to buffer).
+ * \retval 1 if content is found and data is appended to buffer.
  */
 static int xmldoc_parse_enum(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
 {
@@ -1750,6 +1741,7 @@ static int xmldoc_parse_enum(struct ast_xml_node *fixnode, const char *tabs, str
                }
 
                xmldoc_parse_enumlist(node, optiontabs, buffer);
+               xmldoc_parse_parameter(node, optiontabs, buffer);
        }
 
        ast_free(optiontabs);
@@ -1757,12 +1749,15 @@ static int xmldoc_parse_enum(struct ast_xml_node *fixnode, const char *tabs, str
        return ret;
 }
 
-/*! \internal
- *  \brief Parse a <enumlist> node.
- *  \param fixnode As ast_xml pointer to the <enumlist> node.
- *  \param buffer The ast_str output buffer.
- *  \retval 0 if no <enumlist> node was parsed.
- *  \retval 1 if a <enumlist> node was parsed.
+/*!
+ * \internal
+ * \brief Parse a <enumlist> node.
+ *
+ * \param fixnode As ast_xml pointer to the <enumlist> node.
+ * \param buffer The ast_str output buffer.
+ *
+ * \retval 0 if no <enumlist> node was parsed.
+ * \retval 1 if a <enumlist> node was parsed.
  */
 static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
 {
@@ -1791,14 +1786,17 @@ static int xmldoc_parse_enumlist(struct ast_xml_node *fixnode, const char *tabs,
        return ret;
 }
 
-/*! \internal
- *  \brief Parse an <option> node.
- *  \param fixnode An ast_xml pointer to the <option> node.
- *  \param tabs A string to be appended at the begining of each line being added to the
- *              buffer string.
- *  \param buffer The output buffer.
- *  \retval 0 if no option node is parsed.
- *  \retval 1 if an option node is parsed.
+/*!
+ * \internal
+ * \brief Parse an <option> node.
+ *
+ * \param fixnode An ast_xml pointer to the <option> node.
+ * \param tabs A string to be appended at the begining of each line being added to the
+ *             buffer string.
+ * \param buffer The output buffer.
+ *
+ * \retval 0 if no option node is parsed.
+ * \retval 1 if an option node is parsed.
  */
 static int xmldoc_parse_option(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
 {
@@ -1835,12 +1833,14 @@ static int xmldoc_parse_option(struct ast_xml_node *fixnode, const char *tabs, s
        return ret;
 }
 
-/*! \internal
- *  \brief Parse an <optionlist> element from the xml documentation.
- *  \param fixnode Pointer to the optionlist xml node.
- *  \param tabs A string to be appended at the begining of each line being added to the
- *              buffer string.
- *  \param buffer Output buffer to put what is inside the optionlist tag.
+/*!
+ * \internal
+ * \brief Parse an <optionlist> element from the xml documentation.
+ *
+ * \param fixnode Pointer to the optionlist xml node.
+ * \param tabs A string to be appended at the begining of each line being added to the
+ *             buffer string.
+ * \param buffer Output buffer to put what is inside the optionlist tag.
  */
 static void xmldoc_parse_optionlist(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
 {
@@ -1886,12 +1886,14 @@ static void xmldoc_parse_optionlist(struct ast_xml_node *fixnode, const char *ta
        }
 }
 
-/*! \internal
- *  \brief Parse a 'parameter' tag inside a syntax element.
- *  \param fixnode A pointer to the 'parameter' xml node.
- *  \param tabs A string to be appended at the beginning of each line being printed inside
- *              'buffer'.
- *  \param buffer String buffer to put values found inside the parameter element.
+/*!
+ * \internal
+ * \brief Parse a 'parameter' tag inside a syntax element.
+ *
+ * \param fixnode A pointer to the 'parameter' xml node.
+ * \param tabs A string to be appended at the beginning of each line being printed inside
+ *             'buffer'.
+ * \param buffer String buffer to put values found inside the parameter element.
  */
 static void xmldoc_parse_parameter(struct ast_xml_node *fixnode, const char *tabs, struct ast_str **buffer)
 {
@@ -1964,14 +1966,69 @@ static void xmldoc_parse_parameter(struct ast_xml_node *fixnode, const char *tab
 
 /*!
  * \internal
+ * \brief Parse an 'info' tag inside an element.
+ *
+ * \param node A pointer to the 'info' xml node.
+ * \param tabs A string to be appended at the beginning of each line being printed
+ *             inside 'buffer'
+ * \param posttabs Add this string after the content of the <para> element, if one exists
+ * \param String buffer to put values found inide the info element.
+ *
+ * \retval 2 if the information contained a para element, and it returned a value of 2
+ * \retval 1 if information was put into the buffer
+ * \retval 0 if no information was put into the buffer or error
+ */
+static int xmldoc_parse_info(struct ast_xml_node *node, const char *tabs, const char *posttabs, struct ast_str **buffer)
+{
+       const char *tech;
+       char *internaltabs;
+       int internal_ret;
+       int ret = 0;
+
+       if (strcasecmp(ast_xml_node_get_name(node), "info")) {
+               return ret;
+       }
+
+       ast_asprintf(&internaltabs, "%s    ", tabs);
+       if (!internaltabs) {
+               return ret;
+       }
+
+       tech = ast_xml_get_attribute(node, "tech");
+       if (tech) {
+               ast_str_append(buffer, 0, "%s<note>Technology: %s</note>\n", internaltabs, tech);
+               ast_xml_free_attr(tech);
+       }
+
+       ret = 1;
+
+       for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
+               if (!strcasecmp(ast_xml_node_get_name(node), "enumlist")) {
+                       xmldoc_parse_enumlist(node, internaltabs, buffer);
+               } else if (!strcasecmp(ast_xml_node_get_name(node), "parameter")) {
+                       xmldoc_parse_parameter(node, internaltabs, buffer);
+               } else if ((internal_ret = xmldoc_parse_common_elements(node, internaltabs, posttabs, buffer))) {
+                       if (internal_ret > ret) {
+                               ret = internal_ret;
+                       }
+               }
+       }
+       ast_free(internaltabs);
+
+       return ret;
+}
+
+/*!
+ * \internal
  * \brief Build the arguments for an item
+ *
  * \param node The arguments node to parse
  *
  * \note This method exists for when you already have the node.  This
  * prevents having to lock the documentation tree twice
  *
- * \returns A malloc'd character pointer to the arguments for the item
- * \returns NULL on failure
+ * \retval A malloc'd character pointer to the arguments for the item
+ * \retval NULL on failure
  *
  * \since 11
  */
@@ -2032,13 +2089,16 @@ char *ast_xmldoc_build_arguments(const char *type, const char *name, const char
        return _ast_xmldoc_build_arguments(node);
 }
 
-/*! \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.
- *  \param raw_wrap Wrap raw text.
- *  \retval NULL on error
- *  \retval Node content on success.
+/*!
+ * \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.
+ * \param raw_wrap Wrap raw text.
+ *
+ * \retval NULL on error
+ * \retval Node content on success.
  */
 static struct ast_str *xmldoc_get_formatted(struct ast_xml_node *node, int raw_output, int raw_wrap)
 {
@@ -2050,18 +2110,27 @@ static struct ast_str *xmldoc_get_formatted(struct ast_xml_node *node, int raw_o
                /* xmldoc_string_cleanup will allocate the ret object */
                notcleanret = ast_xml_get_text(node);
                tmpstr = notcleanret;
-               xmldoc_string_cleanup(ast_skip_blanks(notcleanret), &ret, 0);
+               xmldoc_string_cleanup(ast_skip_blanks(notcleanret), &ret, 0, 0);
                ast_xml_free_text(tmpstr);
        } else {
                ret = ast_str_create(128);
+               if (!ret) {
+                       return NULL;
+               }
                for (tmp = ast_xml_node_get_children(node); tmp; tmp = ast_xml_node_get_next(tmp)) {
-                       /* if found, parse a <para> element. */
+                       /* if found, parse children elements. */
                        if (xmldoc_parse_common_elements(tmp, "", "\n", &ret)) {
                                continue;
                        }
-                       /* if found, parse a <variablelist> element. */
-                       xmldoc_parse_variablelist(tmp, "", &ret);
-                       xmldoc_parse_enumlist(tmp, "    ", &ret);
+                       if (xmldoc_parse_variablelist(tmp, "", &ret)) {
+                               continue;
+                       }
+                       if (xmldoc_parse_enumlist(tmp, "    ", &ret)) {
+                               continue;
+                       }
+                       if (xmldoc_parse_specialtags(tmp, "", "", &ret)) {
+                               continue;
+                       }
                }
                /* remove last '\n' */
                /* XXX Don't modify ast_str internals manually */
@@ -2074,13 +2143,16 @@ static struct ast_str *xmldoc_get_formatted(struct ast_xml_node *node, int raw_o
 }
 
 /*!
- *  \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree node
- *  \param node The node to obtain the information from
- *  \param var Name of field to return (synopsis, description, etc).
- *  \param raw Field only contains text, no other elements inside it.
- *  \retval NULL On error.
- *  \retval Field text content on success.
- *  \since 11
+ * \internal
+ * \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree node
+ *
+ * \param node The node to obtain the information from
+ * \param var Name of field to return (synopsis, description, etc).
+ * \param raw Field only contains text, no other elements inside it.
+ *
+ * \retval NULL On error.
+ * \retval Field text content on success.
+ * \since 11
  */
 static char *_xmldoc_build_field(struct ast_xml_node *node, const char *var, int raw)
 {
@@ -2090,12 +2162,11 @@ static char *_xmldoc_build_field(struct ast_xml_node *node, const char *var, int
        node = ast_xml_find_element(ast_xml_node_get_children(node), var, NULL, NULL);
 
        if (!node || !ast_xml_node_get_children(node)) {
-               ast_debug(1, "Cannot find variable '%s' in tree\n", var);
                return ret;
        }
 
        formatted = xmldoc_get_formatted(node, raw, raw);
-       if (ast_str_strlen(formatted) > 0) {
+       if (formatted && ast_str_strlen(formatted) > 0) {
                ret = ast_strdup(ast_str_buffer(formatted));
        }
        ast_free(formatted);
@@ -2104,12 +2175,15 @@ static char *_xmldoc_build_field(struct ast_xml_node *node, const char *var, int
 }
 
 /*!
+ * \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).
  * \param module
  * \param raw Field only contains text, no other elements inside it.
+ *
  * \retval NULL On error.
  * \retval Field text content on success.
  */
@@ -2132,15 +2206,17 @@ static char *xmldoc_build_field(const char *type, const char *name, const char *
        return _xmldoc_build_field(node, var, raw);
 }
 
-/* \internal
+/*!
+ * \internal
  * \brief Build the synopsis for an item
+ *
  * \param node The synopsis node
  *
  * \note This method exists for when you already have the node.  This
  * prevents having to lock the documentation tree twice
  *
- * \returns A malloc'd character pointer to the synopsis information
- * \returns NULL on failure
+ * \retval A malloc'd character pointer to the synopsis information
+ * \retval NULL on failure
  * \since 11
  */
 static char *_ast_xmldoc_build_synopsis(struct ast_xml_node *node)
@@ -2156,13 +2232,14 @@ char *ast_xmldoc_build_synopsis(const char *type, const char *name, const char *
 /*!
  * \internal
  * \brief Build the descripton for an item
+ *
  * \param node The description node to parse
  *
  * \note This method exists for when you already have the node.  This
  * prevents having to lock the documentation tree twice
  *
- * \returns A malloc'd character pointer to the arguments for the item
- * \returns NULL on failure
+ * \retval A malloc'd character pointer to the arguments for the item
+ * \retval NULL on failure
  * \since 11
  */
 static char *_ast_xmldoc_build_description(struct ast_xml_node *node)
@@ -2175,7 +2252,9 @@ char *ast_xmldoc_build_description(const char *type, const char *name, const cha
        return xmldoc_build_field(type, name, module, "description", 0);
 }
 
-/*! \internal \brief ast_xml_doc_item ao2 destructor
+/*!
+ * \internal
+ * \brief ast_xml_doc_item ao2 destructor
  * \since 11
  */
 static void ast_xml_doc_item_destructor(void *obj)
@@ -2193,14 +2272,16 @@ static void ast_xml_doc_item_destructor(void *obj)
        ast_free(doc->description);
        ast_string_field_free_memory(doc);
 
-       if (doc->next) {
-               ao2_ref(doc->next, -1);
-               doc->next = NULL;
+       if (AST_LIST_NEXT(doc, next)) {
+               ao2_ref(AST_LIST_NEXT(doc, next), -1);
+               AST_LIST_NEXT(doc, next) = NULL;
        }
 }
 
-/*! \internal
+/*!
+ * \internal
  * \brief Create an ao2 ref counted ast_xml_doc_item
+ *
  * \param name The name of the item
  * \param type The item's source type
  * \since 11
@@ -2237,7 +2318,8 @@ ast_xml_doc_item_failure:
        return NULL;
 }
 
-/*! \internal
+/*!
+ * \internal
  * \brief ao2 item hash function for ast_xml_doc_item
  * \since 11
  */
@@ -2248,7 +2330,8 @@ static int ast_xml_doc_item_hash(const void *obj, const int flags)
        return ast_str_case_hash(name);
 }
 
-/*! \internal
+/*!
+ * \internal
  * \brief ao2 item comparison function for ast_xml_doc_item
  * \since 11
  */
@@ -2260,14 +2343,16 @@ static int ast_xml_doc_item_cmp(void *obj, void *arg, int flags)
        return strcasecmp(left->name, match) ? 0 : (CMP_MATCH | CMP_STOP);
 }
 
-/* \internal
+/*!
+ * \internal
  * \brief Build an XML documentation item
+ *
  * \param node The root node for the item
  * \param name The name of the item
  * \param type The item's source type
  *
- * \returns NULL on failure
- * \returns An ao2 ref counted object
+ * \retval NULL on failure
+ * \retval An ao2 ref counted object
  * \since 11
  */
 static struct ast_xml_doc_item *xmldoc_build_documentation_item(struct ast_xml_node *node, const char *name, const char *type)
@@ -2315,20 +2400,164 @@ static struct ast_xml_doc_item *xmldoc_build_documentation_item(struct ast_xml_n
        return item;
 }
 
+/*!
+ * \internal
+ * \brief Build the list responses for an item
+ *
+ * \param manager_action The action node to parse
+ *
+ * \note This method exists for when you already have the node.  This
+ * prevents having to lock the documentation tree twice
+ *
+ * \retval A list of ast_xml_doc_items
+ * \retval NULL on failure
+ *
+ * \since 13.0.0
+ */
+static struct ast_xml_doc_item *xmldoc_build_list_responses(struct ast_xml_node *manager_action)
+{
+       struct ast_xml_node *event;
+       struct ast_xml_node *responses;
+       struct ast_xml_node *list_elements;
+       struct ast_xml_doc_item_list root;
+
+       AST_LIST_HEAD_INIT(&root);
+
+       responses = ast_xml_find_element(ast_xml_node_get_children(manager_action), "responses", NULL, NULL);
+       if (!responses) {
+               return NULL;
+       }
+
+       list_elements = ast_xml_find_element(ast_xml_node_get_children(responses), "list-elements", NULL, NULL);
+       if (!list_elements) {
+               return NULL;
+       }
+
+       /* Iterate over managerEvent nodes */
+       for (event = ast_xml_node_get_children(list_elements); event; event = ast_xml_node_get_next(event)) {
+               struct ast_xml_node *event_instance;
+               RAII_VAR(const char *, name, ast_xml_get_attribute(event, "name"),
+                       ast_xml_free_attr);
+               struct ast_xml_doc_item *new_item;
+
+               if (!name || strcmp(ast_xml_node_get_name(event), "managerEvent")) {
+                       continue;
+               }
+
+               event_instance = ast_xml_find_element(ast_xml_node_get_children(event),
+                       "managerEventInstance", NULL, NULL);
+               new_item = xmldoc_build_documentation_item(event_instance, name, "managerEvent");
+               if (!new_item) {
+                       ao2_cleanup(AST_LIST_FIRST(&root));
+                       return NULL;
+               }
+
+               AST_LIST_INSERT_TAIL(&root, new_item, next);
+       }
+
+       return AST_LIST_FIRST(&root);
+}
+
+struct ast_xml_doc_item *ast_xmldoc_build_list_responses(const char *type, const char *name, const char *module)
+{
+       struct ast_xml_node *node;
+
+       if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
+               return NULL;
+       }
+
+       node = xmldoc_get_node(type, name, module, documentation_language);
+
+       if (!node || !ast_xml_node_get_children(node)) {
+               return NULL;
+       }
+
+       return xmldoc_build_list_responses(node);
+}
+
+/*!
+ * \internal
+ * \brief Build the final response for an item
+ *
+ * \param manager_action The action node to parse
+ *
+ * \note This method exists for when you already have the node.  This
+ * prevents having to lock the documentation tree twice
+ *
+ * \retval An ast_xml_doc_item
+ * \retval NULL on failure
+ *
+ * \since 13.0.0
+ */
+static struct ast_xml_doc_item *xmldoc_build_final_response(struct ast_xml_node *manager_action)
+{
+       struct ast_xml_node *responses;
+       struct ast_xml_node *final_response_event;
+       struct ast_xml_node *event_instance;
+
+       responses = ast_xml_find_element(ast_xml_node_get_children(manager_action),
+               "responses", NULL, NULL);
+       if (!responses) {
+               return NULL;
+       }
+
+       final_response_event = ast_xml_find_element(ast_xml_node_get_children(responses),
+               "managerEvent", NULL, NULL);
+       if (!final_response_event) {
+               return NULL;
+       }
+
+       event_instance = ast_xml_find_element(ast_xml_node_get_children(final_response_event),
+               "managerEventInstance", NULL, NULL);
+       if (!event_instance) {
+               return NULL;
+       } else {
+               const char *name;
+               struct ast_xml_doc_item *res;
+
+               name = ast_xml_get_attribute(final_response_event, "name");
+               res = xmldoc_build_documentation_item(event_instance, name, "managerEvent");
+               ast_xml_free_attr(name);
+               return res;
+       }
+
+}
+
+struct ast_xml_doc_item *ast_xmldoc_build_final_response(const char *type, const char *name, const char *module)
+{
+       struct ast_xml_node *node;
+
+       if (ast_strlen_zero(type) || ast_strlen_zero(name)) {
+               return NULL;
+       }
+
+       node = xmldoc_get_node(type, name, module, documentation_language);
+
+       if (!node || !ast_xml_node_get_children(node)) {
+               return NULL;
+       }
+
+       return xmldoc_build_final_response(node);
+}
+
 struct ast_xml_xpath_results *__attribute__((format(printf, 1, 2))) ast_xmldoc_query(const char *fmt, ...)
 {
        struct ast_xml_xpath_results *results = NULL;
        struct documentation_tree *doctree;
        RAII_VAR(struct ast_str *, xpath_str, ast_str_create(128), ast_free);
        va_list ap;
+       int res;
 
        if (!xpath_str) {
                return NULL;
        }
 
        va_start(ap, fmt);
-       ast_str_set_va(&xpath_str, 0, fmt, ap);
+       res = ast_str_set_va(&xpath_str, 0, fmt, ap);
        va_end(ap);
+       if (res == AST_DYNSTR_BUILD_FAILED) {
+               return NULL;
+       }
 
        AST_RWLIST_RDLOCK(&xmldoc_tree);
        AST_LIST_TRAVERSE(&xmldoc_tree, doctree, entry) {
@@ -2342,7 +2571,7 @@ struct ast_xml_xpath_results *__attribute__((format(printf, 1, 2))) ast_xmldoc_q
        return results;
 }
 
-static void build_config_docs(struct ast_xml_node *cur, struct ast_xml_doc_item **tail)
+static void build_config_docs(struct ast_xml_node *cur, struct ast_xml_doc_item_list *root)
 {
        struct ast_xml_node *iter;
        struct ast_xml_doc_item *item;
@@ -2365,9 +2594,8 @@ static void build_config_docs(struct ast_xml_node *cur, struct ast_xml_doc_item
                        ast_string_field_set(item, ref, name);
                        ast_xml_free_attr(name);
                }
-               (*tail)->next = item;
-               *tail = (*tail)->next;
-               build_config_docs(iter, tail);
+               AST_LIST_INSERT_TAIL(root, item, next);
+               build_config_docs(iter, root);
        }
 }
 
@@ -2423,7 +2651,6 @@ int ast_xmldoc_regenerate_doc_item(struct ast_xml_doc_item *item)
 struct ao2_container *ast_xmldoc_build_documentation(const char *type)
 {
        struct ao2_container *docs;
-       struct ast_xml_doc_item *item = NULL, *root = NULL;
        struct ast_xml_node *node = NULL, *instance = NULL;
        struct documentation_tree *doctree;
        const char *name;
@@ -2442,6 +2669,8 @@ struct ao2_container *ast_xmldoc_build_documentation(const char *type)
                }
 
                for (node = ast_xml_node_get_children(node); node; node = ast_xml_node_get_next(node)) {
+                       struct ast_xml_doc_item *item = NULL;
+
                        /* Ignore empty nodes or nodes that aren't of the type requested */
                        if (!ast_xml_node_get_children(node) || strcasecmp(ast_xml_node_get_name(node), type)) {
                                continue;
@@ -2453,6 +2682,10 @@ struct ao2_container *ast_xmldoc_build_documentation(const char *type)
 
                        switch (xmldoc_get_syntax_type(type)) {
                        case MANAGER_EVENT_SYNTAX:
+                       {
+                               struct ast_xml_doc_item_list root;
+
+                               AST_LIST_HEAD_INIT(&root);
                                for (instance = ast_xml_node_get_children(node); instance; instance = ast_xml_node_get_next(instance)) {
                                        struct ast_xml_doc_item *temp;
                                        if (!ast_xml_node_get_children(instance) || strcasecmp(ast_xml_node_get_name(instance), "managerEventInstance")) {
@@ -2462,27 +2695,27 @@ struct ao2_container *ast_xmldoc_build_documentation(const char *type)
                                        if (!temp) {
                                                break;
                                        }
-                                       if (!item) {
-                                               item = temp;
-                                               root = item;
-                                       } else {
-                                               item->next = temp;
-                                               item = temp;
-                                       }
+                                       AST_LIST_INSERT_TAIL(&root, temp, next);
                                }
-                               item = root;
+                               item = AST_LIST_FIRST(&root);
                                break;
+                       }
                        case CONFIG_INFO_SYNTAX:
                        {
-                               struct ast_xml_doc_item *tail;
-                               if (item || !ast_xml_node_get_children(node) || strcasecmp(ast_xml_node_get_name(node), "configInfo")) {
+                               RAII_VAR(const char *, name, ast_xml_get_attribute(node, "name"), ast_xml_free_attr);
+
+                               if (!ast_xml_node_get_children(node) || strcasecmp(ast_xml_node_get_name(node), "configInfo")) {
                                        break;
                                }
-                               if (!(item = xmldoc_build_documentation_item(node, ast_xml_get_attribute(node, "name"), "configInfo"))) {
-                                       break;
+
+                               item = xmldoc_build_documentation_item(node, name, "configInfo");
+                               if (item) {
+                                       struct ast_xml_doc_item_list root;
+
+                                       AST_LIST_HEAD_INIT(&root);
+                                       AST_LIST_INSERT_TAIL(&root, item, next);
+                                       build_config_docs(node, &root);
                                }
-                               tail = item;
-                               build_config_docs(node, &tail);
                                break;
                        }
                        default:
@@ -2493,7 +2726,6 @@ struct ao2_container *ast_xmldoc_build_documentation(const char *type)
                        if (item) {
                                ao2_link(docs, item);
                                ao2_t_ref(item, -1, "Dispose of creation ref");
-                               item = NULL;
                        }
                }
        }
@@ -2634,7 +2866,7 @@ int ast_xmldoc_load_documentation(void)
 
        ast_cli_register(&cli_dump_xmldocs);
        /* register function to be run when asterisk finish. */
-       ast_register_atexit(xmldoc_unload_documentation);
+       ast_register_cleanup(xmldoc_unload_documentation);
 
        globbuf.gl_offs = 0;    /* slots to reserve in gl_pathv */
 
@@ -2651,7 +2883,7 @@ int ast_xmldoc_load_documentation(void)
        globret = glob(xmlpattern, MY_GLOB_FLAGS, NULL, &globbuf);
 #endif
 
-       ast_debug(3, "gl_pathc %zd\n", globbuf.gl_pathc);
+       ast_debug(3, "gl_pathc %zu\n", (size_t)globbuf.gl_pathc);
        if (globret == GLOB_NOSPACE) {
                ast_log(LOG_WARNING, "XML load failure, glob expansion of pattern '%s' failed: Not enough memory\n", xmlpattern);
                ast_free(xmlpattern);