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:

=  Index(
        input=sys.argv[1],
        output=OutputStreams(args.output_directory, sys.stdout, sys.stderr),
    )

Definition at line 885 of file doxygen_xml_parser.py.

parser

doxygen_xml_parser.parser

Initial value:

=  argparse.ArgumentParser(
        description="Process Doxygen XML documentation and generate C++ code."
    )

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:

=  """
  if (strcmp(attrib, "{attribute}") == 0)
    return "{docstring}";"""

Definition at line 32 of file doxygen_xml_parser.py.

template_class_doc

string doxygen_xml_parser.template_class_doc

Initial value:

=  """
template <{tplargs}>
struct class_doc_impl< {classname} >
{{
static inline const char* run ()
{{
  return "{docstring}";
}}
static inline const char* attribute (const char* attrib)
{{{attributes}
  (void)attrib; // turn off unused parameter warning.
  return "";
}}
}};"""

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:

=  """
template <{tplargs}>
struct constructor_{nargs}_impl< {classname_prefix}{comma}{argsstring} >
{{
static inline const char* doc ()
{{
  return "{docstring}";
}}
static inline boost::python::detail::keywords<{nargs}+1> args ()
{{
  return ({argnamesstring});
}}
}};"""

Definition at line 35 of file doxygen_xml_parser.py.

template_destructor_doc

string doxygen_xml_parser.template_destructor_doc

Initial value:

=  """
template <{tplargs}>
struct destructor_doc_impl < {classname_prefix} >
{{
static inline const char* run ()
{{
  return "{docstring}";
}}
}};"""

Definition at line 48 of file doxygen_xml_parser.py.

template_file_footer

string doxygen_xml_parser.template_file_footer

Initial value:

=  """
#endif // DOXYGEN_AUTODOC_{header_guard}
"""

Definition at line 14 of file doxygen_xml_parser.py.

template_file_header

string doxygen_xml_parser.template_file_header

Initial value:

=  """#ifndef DOXYGEN_AUTODOC_{header_guard}
#define DOXYGEN_AUTODOC_{header_guard}

#include "{path}/doxygen.hh"
"""

Definition at line 9 of file doxygen_xml_parser.py.

template_include_extern

string doxygen_xml_parser.template_include_extern

Initial value:

=  """#include <{filename}>
"""

Definition at line 85 of file doxygen_xml_parser.py.

template_include_intern

string doxygen_xml_parser.template_include_intern

Initial value:

=  """#include <doxygen_autodoc/{filename}>
"""

Definition at line 83 of file doxygen_xml_parser.py.

template_member_func_args

string doxygen_xml_parser.template_member_func_args

Initial value:

=  """
{template}inline boost::python::detail::keywords<{n}> member_func_args ({rettype} ({classname_prefix}*function_ptr) {argsstring})
{{{body}
  return ({default_args});
}}"""

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:

=  """
  if (function_ptr == static_cast<{rettype} ({classname_prefix}*) {argsstring}>(&{classname_prefix}{membername}))
    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:

=  """
{template}inline const char* member_func_doc ({rettype} ({classname_prefix}*function_ptr) {argsstring})
{{{body}
  return "";
}}"""

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:

=  """
  if (function_ptr == static_cast<{rettype} ({classname_prefix}*) {argsstring}>(&{classname_prefix}{membername}))
    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:

=  """
{template}inline const char* member_func_doc ({rettype} (*function_ptr) {argsstring})
{{{body}
  return "";
}}"""

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:

=  """
  if (function_ptr == static_cast<{rettype} (*) {argsstring}>(&{namespace}::{membername}))
    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.