Public Member Functions | Public Attributes | List of all members
parse_doxygen_xml.ParseDoxygenXML Class Reference

Public Member Functions

def __init__ (self, input_path, output_path)
 
def run (self, quiet=True)
 

Public Attributes

 input_path
 
 output_path
 

Detailed Description

Definition at line 10 of file parse_doxygen_xml.py.

Constructor & Destructor Documentation

def parse_doxygen_xml.ParseDoxygenXML.__init__ (   self,
  input_path,
  output_path 
)
Parse the Doxygen generated XML files.

Arguments:
input_path -- path to the input folder or file
output_path -- path to the output folder

Definition at line 11 of file parse_doxygen_xml.py.

Member Function Documentation

def parse_doxygen_xml.ParseDoxygenXML.run (   self,
  quiet = True 
)
Run the Doxygen XML parser.

Arguments:
quiet -- turn on/off the messages that are generated to standard
 output by Doxygen (default = True)

Returns:
    A Docs template storing all the class and free documentation in the
    file.

Definition at line 21 of file parse_doxygen_xml.py.

Member Data Documentation

parse_doxygen_xml.ParseDoxygenXML.input_path

Definition at line 18 of file parse_doxygen_xml.py.

parse_doxygen_xml.ParseDoxygenXML.output_path

Definition at line 19 of file parse_doxygen_xml.py.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:59:12