- doc_page
-
This tag defines a documentation page.
Parameters:- None.
- /doc_page
-
Close the
<doc_page>
tag.
Parameters:- None.
- doc_idx
-
This tag defines an index page.
Parameters:- None.
- /doc_idx
-
Close the
<doc_idx>
tag.
Parameters:- None.
- idx_el
-
Defines an element of the index.
Parameters:
- docname:
- Name of the document that contains the definition of the element
Default: None.
- name:
Default: None.
- tag
-
Defines a tag.
Parameters:- None.
- /tag
-
Close the
<tag>
tag.
Parameters:- None.
- doc_tag
-
Defines the name of the documenting tag.
Parameters:
- name:
- Name of the tag
Default: None.
- /doc_tag
-
Close the
<doc_tag>
tag.
Parameters:- None.
- no_params
-
No parameters are associated with the tag.
Parameters:- None.
- params
-
Used to start a parameter list in the documentation.
Parameters:- None.
- /params
-
Close the
<params>
tag.
Parameters:- None.
- param
-
Defines the documentation for a parameter. Must be enclosed in a
<params>
tag.
Parameters:
- name:
- Name of the parameter
Default: None.
- value:
- Value of the parameter
Default: None.
- default:
- Default value for the parameter
Default: None.