ast_xml_doc_item Struct Reference

Struct that contains the XML documentation for a particular item. Note that this is an ao2 ref counted object. More...

#include <xmldoc.h>

Collaboration diagram for ast_xml_doc_item:

Data Fields
struct ast_string_field_mgr	__field_mgr
struct ast_string_field_pool *	__field_mgr_pool
struct ast_str *	arguments
struct ast_str *	description
const ast_string_field	name
struct ast_xml_doc_item *	next
struct ast_str *	seealso
struct ast_str *	synopsis
struct ast_str *	syntax
const ast_string_field	type

---

Detailed Description

Struct that contains the XML documentation for a particular item. Note that this is an ao2 ref counted object.

Note:

Each of the ast_str objects are built from the corresponding ast_xmldoc_build_* calls

Since:

11

Definition at line 48 of file xmldoc.h.

---

Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 64 of file xmldoc.h.

struct ast_string_field_pool* __field_mgr_pool

The name of the item

The type of the item

Definition at line 64 of file xmldoc.h.

struct ast_str* arguments

The arguments to the item

Definition at line 54 of file xmldoc.h.

Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), handle_manager_show_event(), and xmldoc_build_documentation_item().

struct ast_str* description

A description of the item

Definition at line 58 of file xmldoc.h.

Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), handle_manager_show_event(), and xmldoc_build_documentation_item().

const ast_string_field name

Definition at line 64 of file xmldoc.h.

Referenced by ast_xml_doc_item_cmp(), ast_xml_doc_item_hash(), and handle_manager_show_event().

struct ast_xml_doc_item* next

The next XML documentation item that matches the same name/item type

Definition at line 66 of file xmldoc.h.

Referenced by ast_xml_doc_item_destructor(), ast_xmldoc_build_documentation(), and handle_manager_show_event().

struct ast_str* seealso

Seealso tagged information, if it exists

Definition at line 52 of file xmldoc.h.

Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), handle_manager_show_event(), and xmldoc_build_documentation_item().

struct ast_str* synopsis

A synopsis of the item

Definition at line 56 of file xmldoc.h.

Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), handle_manager_show_event(), and xmldoc_build_documentation_item().

struct ast_str* syntax

The syntax of the item

Definition at line 50 of file xmldoc.h.

Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), handle_manager_show_event(), and xmldoc_build_documentation_item().

const ast_string_field type

Definition at line 64 of file xmldoc.h.

---

The documentation for this struct was generated from the following file:

• xmldoc.h