Classes | Functions | Variables
doxygen_xml_parser Namespace Reference

Classes

class  ClassCompound
 
class  CompoundBase
 
class  Index
 
class  MemberDef
 
class  NamespaceCompound
 
class  OutputStreams
 
class  Reference
 

Functions

def _templateParamToDict (param)
 
def format_description (brief, detailed)
 
def makeHeaderGuard (filename)
 

Variables

 args = parser.parse_args()
 
 help
 
 index
 
 parser
 
 str
 
string template_class_attribute_body
 
string template_class_doc
 
string template_close_namespace = """}} // namespace {namespace}"""
 
string template_constructor_doc
 
string template_destructor_doc
 
string template_file_footer
 
string template_file_header
 
string template_include_extern
 
string template_include_intern
 
string template_member_func_args
 
string template_member_func_args_body
 
string template_member_func_doc
 
string template_member_func_doc_body
 
string template_open_namespace = """namespace {namespace} {{"""
 
string template_static_func_doc
 
string template_static_func_doc_body
 
 type
 

Function Documentation

◆ _templateParamToDict()

def doxygen_xml_parser._templateParamToDict (   param)
private

Definition at line 89 of file doxygen_xml_parser.py.

◆ format_description()

def doxygen_xml_parser.format_description (   brief,
  detailed 
)

Definition at line 126 of file doxygen_xml_parser.py.

◆ makeHeaderGuard()

def doxygen_xml_parser.makeHeaderGuard (   filename)

Definition at line 120 of file doxygen_xml_parser.py.

Variable Documentation

◆ args

doxygen_xml_parser.args = parser.parse_args()

Definition at line 883 of file doxygen_xml_parser.py.

◆ help

doxygen_xml_parser.help

Definition at line 881 of file doxygen_xml_parser.py.

◆ index

doxygen_xml_parser.index
Initial value:
1 = Index(
2  input=sys.argv[1],
3  output=OutputStreams(args.output_directory, sys.stdout, sys.stderr),
4  )

Definition at line 885 of file doxygen_xml_parser.py.

◆ parser

doxygen_xml_parser.parser
Initial value:
1 = argparse.ArgumentParser(
2  description="Process Doxygen XML documentation and generate C++ code."
3  )

Definition at line 878 of file doxygen_xml_parser.py.

◆ str

doxygen_xml_parser.str

Definition at line 881 of file doxygen_xml_parser.py.

◆ template_class_attribute_body

string doxygen_xml_parser.template_class_attribute_body
Initial value:
1 = """
2  if (strcmp(attrib, "{attribute}") == 0)
3  return "{docstring}";"""

Definition at line 32 of file doxygen_xml_parser.py.

◆ template_class_doc

string doxygen_xml_parser.template_class_doc
Initial value:
1 = """
2 template <{tplargs}>
3 struct class_doc_impl< {classname} >
4 {{
5 static inline const char* run ()
6 {{
7  return "{docstring}";
8 }}
9 static inline const char* attribute (const char* attrib)
10 {{{attributes}
11  (void)attrib; // turn off unused parameter warning.
12  return "";
13 }}
14 }};"""

Definition at line 18 of file doxygen_xml_parser.py.

◆ template_close_namespace

string doxygen_xml_parser.template_close_namespace = """}} // namespace {namespace}"""

Definition at line 82 of file doxygen_xml_parser.py.

◆ template_constructor_doc

string doxygen_xml_parser.template_constructor_doc
Initial value:
1 = """
2 template <{tplargs}>
3 struct constructor_{nargs}_impl< {classname_prefix}{comma}{argsstring} >
4 {{
5 static inline const char* doc ()
6 {{
7  return "{docstring}";
8 }}
9 static inline boost::python::detail::keywords<{nargs}+1> args ()
10 {{
11  return ({argnamesstring});
12 }}
13 }};"""

Definition at line 35 of file doxygen_xml_parser.py.

◆ template_destructor_doc

string doxygen_xml_parser.template_destructor_doc
Initial value:
1 = """
2 template <{tplargs}>
3 struct destructor_doc_impl < {classname_prefix} >
4 {{
5 static inline const char* run ()
6 {{
7  return "{docstring}";
8 }}
9 }};"""

Definition at line 48 of file doxygen_xml_parser.py.

◆ template_file_footer

string doxygen_xml_parser.template_file_footer
Initial value:
1 = """
2 #endif // DOXYGEN_AUTODOC_{header_guard}
3 """

Definition at line 14 of file doxygen_xml_parser.py.

◆ template_file_header

string doxygen_xml_parser.template_file_header
Initial value:
1 = """#ifndef DOXYGEN_AUTODOC_{header_guard}
2 #define DOXYGEN_AUTODOC_{header_guard}
3 
4 #include "{path}/doxygen.hh"
5 """

Definition at line 9 of file doxygen_xml_parser.py.

◆ template_include_extern

string doxygen_xml_parser.template_include_extern
Initial value:
1 = """#include <{filename}>
2 """

Definition at line 85 of file doxygen_xml_parser.py.

◆ template_include_intern

string doxygen_xml_parser.template_include_intern
Initial value:
1 = """#include <doxygen_autodoc/{filename}>
2 """

Definition at line 83 of file doxygen_xml_parser.py.

◆ template_member_func_args

string doxygen_xml_parser.template_member_func_args
Initial value:
1 = """
2 {template}inline boost::python::detail::keywords<{n}> member_func_args ({rettype} ({classname_prefix}*function_ptr) {argsstring})
3 {{{body}
4  return ({default_args});
5 }}"""

Definition at line 65 of file doxygen_xml_parser.py.

◆ template_member_func_args_body

string doxygen_xml_parser.template_member_func_args_body
Initial value:
1 = """
2  if (function_ptr == static_cast<{rettype} ({classname_prefix}*) {argsstring}>(&{classname_prefix}{membername}))
3  return ({args});"""

Definition at line 70 of file doxygen_xml_parser.py.

◆ template_member_func_doc

string doxygen_xml_parser.template_member_func_doc
Initial value:
1 = """
2 {template}inline const char* member_func_doc ({rettype} ({classname_prefix}*function_ptr) {argsstring})
3 {{{body}
4  return "";
5 }}"""

Definition at line 57 of file doxygen_xml_parser.py.

◆ template_member_func_doc_body

string doxygen_xml_parser.template_member_func_doc_body
Initial value:
1 = """
2  if (function_ptr == static_cast<{rettype} ({classname_prefix}*) {argsstring}>(&{classname_prefix}{membername}))
3  return "{docstring}";"""

Definition at line 62 of file doxygen_xml_parser.py.

◆ template_open_namespace

string doxygen_xml_parser.template_open_namespace = """namespace {namespace} {{"""

Definition at line 81 of file doxygen_xml_parser.py.

◆ template_static_func_doc

string doxygen_xml_parser.template_static_func_doc
Initial value:
1 = """
2 {template}inline const char* member_func_doc ({rettype} (*function_ptr) {argsstring})
3 {{{body}
4  return "";
5 }}"""

Definition at line 73 of file doxygen_xml_parser.py.

◆ template_static_func_doc_body

string doxygen_xml_parser.template_static_func_doc_body
Initial value:
1 = """
2  if (function_ptr == static_cast<{rettype} (*) {argsstring}>(&{namespace}::{membername}))
3  return "{docstring}";"""

Definition at line 78 of file doxygen_xml_parser.py.

◆ type

doxygen_xml_parser.type

Definition at line 881 of file doxygen_xml_parser.py.



hpp-fcl
Author(s):
autogenerated on Fri Jun 2 2023 02:39:03