Asterisk - The Open Source Telephony Project  GIT-master-4a4f1a5
Data Fields
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>

Data Fields

struct ast_string_field_mgr __field_mgr
 
struct ast_string_field_pool__field_mgr_pool
 
struct ast_strarguments
 
struct ast_strdescription
 
const ast_string_field name
 
struct {
   struct ast_xml_doc_item *   next
 
next
 
struct ast_xml_node * node
 
const ast_string_field ref
 
struct ast_strseealso
 
struct ast_strsynopsis
 
struct ast_strsyntax
 
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 56 of file xmldoc.h.

Field Documentation

◆ __field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 74 of file xmldoc.h.

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

The name of the item

The type of the item

Reference to another field

Definition at line 74 of file xmldoc.h.

◆ arguments

struct ast_str* arguments

◆ description

struct ast_str* description

◆ name

const ast_string_field name

◆  [1/2]

struct { ... } next

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

◆ next [2/2]

struct ast_xml_doc_item* next

◆ node

struct ast_xml_node* node

The node that this item was created from. Note that the life time of the node is not tied to the lifetime of this object.

Definition at line 78 of file xmldoc.h.

Referenced by xmldoc_build_documentation_item().

◆ ref

const ast_string_field ref

Definition at line 74 of file xmldoc.h.

Referenced by build_config_docs(), complete_config_option(), and find_xmldoc_option().

◆ seealso

struct ast_str* seealso

Seealso tagged information, if it exists

Definition at line 60 of file xmldoc.h.

Referenced by ast_xml_doc_item_destructor(), ast_xmldoc_regenerate_doc_item(), handle_showmancmd(), print_event_instance(), and xmldoc_build_documentation_item().

◆ synopsis

struct ast_str* synopsis

A synopsis of the item

Definition at line 64 of file xmldoc.h.

Referenced by ast_xml_doc_item_destructor(), and print_event_instance().

◆ syntax

struct ast_str* syntax

◆ type

const ast_string_field type

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