Public Member Functions | Public Attributes | List of all members
doxygen_xml_parser.Index Class Reference

Public Member Functions

def __init__ (self, input, output)
 
def getref (self, id)
 
def hasref (self, id)
 
def parseCompound (self)
 
def registerReference (self, obj, overwrite=True)
 
def write (self)
 

Public Attributes

 compounds
 
 directory
 
 output
 
 references
 
 tree
 
 xml_docstring
 

Detailed Description

This class is responsible for generating the list of all C++-usable documented elements.

Definition at line 680 of file doxygen_xml_parser.py.

Constructor & Destructor Documentation

◆ __init__()

def doxygen_xml_parser.Index.__init__ (   self,
  input,
  output 
)

Definition at line 685 of file doxygen_xml_parser.py.

Member Function Documentation

◆ getref()

def doxygen_xml_parser.Index.getref (   self,
  id 
)

Definition at line 804 of file doxygen_xml_parser.py.

◆ hasref()

def doxygen_xml_parser.Index.hasref (   self,
  id 
)

Definition at line 801 of file doxygen_xml_parser.py.

◆ parseCompound()

def doxygen_xml_parser.Index.parseCompound (   self)

Definition at line 693 of file doxygen_xml_parser.py.

◆ registerReference()

def doxygen_xml_parser.Index.registerReference (   self,
  obj,
  overwrite = True 
)

Definition at line 787 of file doxygen_xml_parser.py.

◆ write()

def doxygen_xml_parser.Index.write (   self)

Definition at line 703 of file doxygen_xml_parser.py.

Member Data Documentation

◆ compounds

doxygen_xml_parser.Index.compounds

Definition at line 689 of file doxygen_xml_parser.py.

◆ directory

doxygen_xml_parser.Index.directory

Definition at line 687 of file doxygen_xml_parser.py.

◆ output

doxygen_xml_parser.Index.output

Definition at line 691 of file doxygen_xml_parser.py.

◆ references

doxygen_xml_parser.Index.references

Definition at line 690 of file doxygen_xml_parser.py.

◆ tree

doxygen_xml_parser.Index.tree

Definition at line 686 of file doxygen_xml_parser.py.

◆ xml_docstring

doxygen_xml_parser.Index.xml_docstring

Definition at line 688 of file doxygen_xml_parser.py.


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


hpp-fcl
Author(s):
autogenerated on Fri Jan 26 2024 03:46:16