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_str * | arguments |
| struct ast_str * | description |
| 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_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
Field Documentation
◆ __field_mgr
| struct ast_string_field_mgr __field_mgr |
◆ __field_mgr_pool
| struct ast_string_field_pool* __field_mgr_pool |
◆ arguments
| struct ast_str* arguments |
The arguments to the item
Definition at line 62 of file xmldoc.h.
Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), ast_xmldoc_regenerate_doc_item(), print_event_instance(), and xmldoc_build_documentation_item().
◆ description
| struct ast_str* description |
A description of the item
Definition at line 66 of file xmldoc.h.
Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), ast_xmldoc_regenerate_doc_item(), cli_show_module_options(), cli_show_module_type(), Parameter::load(), Api::load(), Property::load(), Model::load(), ResourceApi::load(), print_event_instance(), and xmldoc_build_documentation_item().
◆ name
| const ast_string_field name |
The name of the item
Definition at line 74 of file xmldoc.h.
Referenced by ast_xml_doc_item_cmp(), ast_xml_doc_item_hash(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), cli_show_modules(), complete_config_module(), complete_config_option(), complete_config_type(), find_xmldoc_option(), find_xmldoc_type(), PathSegment::get_child(), handle_manager_show_event(), handle_showmancmd(), Parameter::load(), SwaggerType::load(), and Property::load().
◆ next [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 |
Definition at line 80 of file xmldoc.h.
Referenced by ast_xml_doc_item_destructor(), ast_xmldoc_build_documentation(), build_config_docs(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), complete_config_option(), complete_config_type(), find_xmldoc_option(), find_xmldoc_type(), handle_manager_show_event(), handle_showmancmd(), and xmldoc_build_list_responses().
◆ 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 ast_xmldoc_regenerate_doc_item(), and xmldoc_build_documentation_item().
◆ ref
| const ast_string_field ref |
Reference to another field
Definition at line 74 of file xmldoc.h.
Referenced by build_config_docs(), cli_show_module_options(), cli_show_module_type(), 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_alloc(), ast_xml_doc_item_destructor(), ast_xmldoc_regenerate_doc_item(), cli_show_module_options(), 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_alloc(), ast_xml_doc_item_destructor(), ast_xmldoc_regenerate_doc_item(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), print_event_instance(), and xmldoc_build_documentation_item().
◆ syntax
| struct ast_str* syntax |
The syntax of the item
Definition at line 58 of file xmldoc.h.
Referenced by ast_xml_doc_item_alloc(), ast_xml_doc_item_destructor(), ast_xmldoc_regenerate_doc_item(), cli_show_module_options(), cli_show_module_type(), print_event_instance(), and xmldoc_build_documentation_item().
◆ type
| const ast_string_field type |
The type of the item
Definition at line 74 of file xmldoc.h.
Referenced by ast_xmldoc_regenerate_doc_item(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), complete_config_option(), complete_config_type(), find_xmldoc_type(), and Property::load().
The documentation for this struct was generated from the following file:
