Detailed Description

Converts Doxygen generated XML files into a file containing
docstrings that can be used by SWIG-1.3.x that have support for
feature("docstring").  Once the data is parsed it is stored in
self.pieces.

Definition at line 53 of file doxy2swig.py.

Public Member Functions
def	__init__ (self, src, include_function_definition=True, quiet=False)

def	add_text (self, value)

def	clean_pieces (self, pieces)

def	do_argsstring (self, node, indent=0)

def	do_briefdescription (self, node, indent=0)

def	do_compounddef (self, node, indent=0)

def	do_compoundname (self, node, indent=0)

def	do_definition (self, node, indent=0)

def	do_detaileddescription (self, node, indent=0)

def	do_doxygenindex (self, node, indent=0)

def	do_header (self, node, indent=0)

def	do_includes (self, node, indent=0)

def	do_member (self, node, indent=0)

def	do_memberdef (self, node, indent=0)

def	do_para (self, node, indent=0)

def	do_parameterdefinition (self, node, indent=0)

def	do_parameterdescription (self, node, indent=0)

def	do_parameterlist (self, node, indent=0)

def	do_parametername (self, node, indent=0)

def	do_sectiondef (self, node, indent=0)

def	do_simplesect (self, node, indent=0)

def	generate (self)

def	generic_parse (self, node, pad=0, indent=0)

def	get_specific_nodes (self, node, names)

def	parse (self, node, indent=0)

def	parse_Comment (self, node, indent=0)

def	parse_Document (self, node, indent=0)

def	parse_Element (self, node, indent=0)

def	parse_Text (self, node, indent=0)

def	space_parse (self, node, indent=0)

def	write (self, fname)

Public Attributes
	ignores

	include_function_definition

	lead_spc

	multi

	my_dir

	pieces

	quiet

	space_re

	xmldoc

Static Public Attributes
def	do_bold = space_parse

def	do_computeroutput = space_parse

def	do_emphasis = space_parse

def	do_formula = space_parse

def	do_ref = space_parse

Constructor & Destructor Documentation

◆ init()

def doxy2swig.Doxy2SWIG.__init__	(	self,
		src,
		include_function_definition = `True`,
		quiet = `False`
	)

Initialize the instance given a source object.  `src` can
be a file or filename.  If you do not want to include function
definitions from doxygen then set
`include_function_definition` to `False`.  This is handy since
this allows you to use the swig generated function definition
using %feature("autodoc", [0,1]).

Definition at line 61 of file doxy2swig.py.

Member Function Documentation

◆ add_text()

def doxy2swig.Doxy2SWIG.add_text	(	self,
		value
	)

Adds text corresponding to `value` into `self.pieces`.

Definition at line 150 of file doxy2swig.py.

◆ clean_pieces()

def doxy2swig.Doxy2SWIG.clean_pieces	(	self,
		pieces
	)

Cleans the list of strings given as `pieces`.  It replaces
multiple newlines by a maximum of 2 and returns a new list.
It also wraps the paragraphs nicely.

Definition at line 396 of file doxy2swig.py.

◆ do_argsstring()

def doxy2swig.Doxy2SWIG.do_argsstring	(	self,
		node,
		indent = `0`
	)

Definition at line 365 of file doxy2swig.py.

◆ do_briefdescription()

def doxy2swig.Doxy2SWIG.do_briefdescription	(	self,
		node,
		indent = `0`
	)

Definition at line 269 of file doxy2swig.py.

◆ do_compounddef()

def doxy2swig.Doxy2SWIG.do_compounddef	(	self,
		node,
		indent = `0`
	)

Definition at line 208 of file doxy2swig.py.

◆ do_compoundname()

def doxy2swig.Doxy2SWIG.do_compoundname	(	self,
		node,
		indent = `0`
	)

Definition at line 203 of file doxy2swig.py.

◆ do_definition()

def doxy2swig.Doxy2SWIG.do_definition	(	self,
		node,
		indent = `0`
	)

Definition at line 320 of file doxy2swig.py.

◆ do_detaileddescription()

def doxy2swig.Doxy2SWIG.do_detaileddescription	(	self,
		node,
		indent = `0`
	)

Definition at line 266 of file doxy2swig.py.

◆ do_doxygenindex()

def doxy2swig.Doxy2SWIG.do_doxygenindex	(	self,
		node,
		indent = `0`
	)

Definition at line 374 of file doxy2swig.py.

◆ do_header()

def doxy2swig.Doxy2SWIG.do_header	(	self,
		node,
		indent = `0`
	)

For a user defined section def a header field is present
which should not be printed as such, so we comment it in the
output.

Definition at line 329 of file doxy2swig.py.

◆ do_includes()

def doxy2swig.Doxy2SWIG.do_includes	(	self,
		node,
		indent = `0`
	)

Definition at line 229 of file doxy2swig.py.

◆ do_member()

def doxy2swig.Doxy2SWIG.do_member	(	self,
		node,
		indent = `0`
	)

Definition at line 368 of file doxy2swig.py.

◆ do_memberdef()

def doxy2swig.Doxy2SWIG.do_memberdef	(	self,
		node,
		indent = `0`
	)

Definition at line 272 of file doxy2swig.py.

◆ do_para()

def doxy2swig.Doxy2SWIG.do_para	(	self,
		node,
		indent = `0`
	)

Definition at line 245 of file doxy2swig.py.

◆ do_parameterdefinition()

def doxy2swig.Doxy2SWIG.do_parameterdefinition	(	self,
		node,
		indent = `0`
	)

Definition at line 260 of file doxy2swig.py.

◆ do_parameterdescription()

def doxy2swig.Doxy2SWIG.do_parameterdescription	(	self,
		node,
		indent = `0`
	)

Definition at line 263 of file doxy2swig.py.

◆ do_parameterlist()

def doxy2swig.Doxy2SWIG.do_parameterlist	(	self,
		node,
		indent = `0`
	)

Definition at line 233 of file doxy2swig.py.

◆ do_parametername()

def doxy2swig.Doxy2SWIG.do_parametername	(	self,
		node,
		indent = `0`
	)

Definition at line 248 of file doxy2swig.py.

◆ do_sectiondef()

def doxy2swig.Doxy2SWIG.do_sectiondef	(	self,
		node,
		indent = `0`
	)

Definition at line 324 of file doxy2swig.py.

◆ do_simplesect()

def doxy2swig.Doxy2SWIG.do_simplesect	(	self,
		node,
		indent = `0`
	)

Definition at line 348 of file doxy2swig.py.

◆ generate()

def doxy2swig.Doxy2SWIG.generate ( self )

Parses the file set in the initialization.  The resulting
data is stored in `self.pieces`.

Definition at line 97 of file doxy2swig.py.

◆ generic_parse()

def doxy2swig.Doxy2SWIG.generic_parse	(	self,
		node,
		pad = `0`,
		indent = `0`
	)

A Generic parser for arbitrary tags in a node.

Parameters:

 - node:  A node in the DOM.
 - pad: `int` (default: 0)

   If 0 the node data is not padded with newlines.  If 1 it
   appends a newline after parsing the childNodes.  If 2 it
   pads before and after the nodes are processed.  Defaults to
   0.

Definition at line 168 of file doxy2swig.py.

◆ get_specific_nodes()

def doxy2swig.Doxy2SWIG.get_specific_nodes	(	self,
		node,
		names
	)

Given a node and a sequence of strings in `names`, return a
dictionary containing the names as keys and child
`ELEMENT_NODEs`, that have a `tagName` equal to the name.

Definition at line 157 of file doxy2swig.py.

◆ parse()

def doxy2swig.Doxy2SWIG.parse	(	self,
		node,
		indent = `0`
	)

Parse a given node.  This function in turn calls the
`parse_<nodeType>` functions which handle the respective
nodes.

Definition at line 104 of file doxy2swig.py.

◆ parse_Comment()

def doxy2swig.Doxy2SWIG.parse_Comment	(	self,
		node,
		indent = `0`
	)

Parse a `COMMENT_NODE`.  This does nothing for now.

Definition at line 146 of file doxy2swig.py.

◆ parse_Document()

def doxy2swig.Doxy2SWIG.parse_Document	(	self,
		node,
		indent = `0`
	)

Definition at line 113 of file doxy2swig.py.

◆ parse_Element()

def doxy2swig.Doxy2SWIG.parse_Element	(	self,
		node,
		indent = `0`
	)

Parse an `ELEMENT_NODE`.  This calls specific
`do_<tagName>` handers for different elements.  If no handler
is available the `generic_parse` method is called.  All
tagNames specified in `self.ignores` are simply ignored.

Definition at line 127 of file doxy2swig.py.

◆ parse_Text()

def doxy2swig.Doxy2SWIG.parse_Text	(	self,
		node,
		indent = `0`
	)

Definition at line 116 of file doxy2swig.py.

◆ space_parse()

def doxy2swig.Doxy2SWIG.space_parse	(	self,
		node,
		indent = `0`
	)

Definition at line 193 of file doxy2swig.py.

◆ write()

def doxy2swig.Doxy2SWIG.write	(	self,
		fname
	)

Definition at line 388 of file doxy2swig.py.

Member Data Documentation

◆ do_bold

def doxy2swig.Doxy2SWIG.do_bold = space_parse

static

Definition at line 199 of file doxy2swig.py.

◆ do_computeroutput

def doxy2swig.Doxy2SWIG.do_computeroutput = space_parse

static

Definition at line 200 of file doxy2swig.py.

◆ do_emphasis

def doxy2swig.Doxy2SWIG.do_emphasis = space_parse

static

Definition at line 198 of file doxy2swig.py.

◆ do_formula

def doxy2swig.Doxy2SWIG.do_formula = space_parse

static

Definition at line 201 of file doxy2swig.py.

◆ do_ref

def doxy2swig.Doxy2SWIG.do_ref = space_parse

static

Definition at line 197 of file doxy2swig.py.

◆ ignores

doxy2swig.Doxy2SWIG.ignores

Definition at line 82 of file doxy2swig.py.

◆ include_function_definition

doxy2swig.Doxy2SWIG.include_function_definition

Definition at line 90 of file doxy2swig.py.

◆ lead_spc

doxy2swig.Doxy2SWIG.lead_spc

Definition at line 80 of file doxy2swig.py.

◆ multi

doxy2swig.Doxy2SWIG.multi

Definition at line 81 of file doxy2swig.py.

◆ my_dir

doxy2swig.Doxy2SWIG.my_dir

Definition at line 71 of file doxy2swig.py.

◆ pieces

doxy2swig.Doxy2SWIG.pieces

Definition at line 75 of file doxy2swig.py.

◆ quiet

doxy2swig.Doxy2SWIG.quiet

Definition at line 94 of file doxy2swig.py.

◆ space_re

doxy2swig.Doxy2SWIG.space_re

Definition at line 79 of file doxy2swig.py.

◆ xmldoc

doxy2swig.Doxy2SWIG.xmldoc

Definition at line 72 of file doxy2swig.py.

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

doxy2swig.py

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ add_text()

◆ clean_pieces()

◆ do_argsstring()

◆ do_briefdescription()

◆ do_compounddef()

◆ do_compoundname()

◆ do_definition()

◆ do_detaileddescription()

◆ do_doxygenindex()

◆ do_header()

◆ do_includes()

◆ do_member()

◆ do_memberdef()

◆ do_para()

◆ do_parameterdefinition()

◆ do_parameterdescription()

◆ do_parameterlist()

◆ do_parametername()

◆ do_sectiondef()

◆ do_simplesect()

◆ generate()

◆ generic_parse()

◆ get_specific_nodes()

◆ parse()

◆ parse_Comment()

◆ parse_Document()

◆ parse_Element()

◆ parse_Text()

◆ space_parse()

◆ write()

Member Data Documentation

◆ do_bold

◆ do_computeroutput

◆ do_emphasis

◆ do_formula

◆ do_ref

◆ ignores

◆ include_function_definition

◆ lead_spc

◆ multi

◆ my_dir

◆ pieces

◆ quiet

◆ space_re

◆ xmldoc

◆ init()