Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
xml_docstring.XmlDocString Class Reference
Inheritance diagram for xml_docstring.XmlDocString:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, index)
 
def clear (self)
 
def emphasis (self, node)
 
def formula (self, node)
 
def getDocString (self, brief, detailled, output)
 
def itemizedlist (self, node)
 
def listitem (self, node)
 
def otherTags (self, node)
 
def para (self, node)
 
def parameteritem (self, node)
 
def parameterlist (self, node)
 
def ref (self, node)
 
def simplesect (self, node)
 
def unknownTag (self, node)
 
def visit (self, node)
 
def writeErrors (self, output)
 

Public Attributes

 index
 
 latex
 
 lines
 
 tags
 
 unkwownReferences
 
 unkwownTags
 

Private Member Functions

def _clean (self)
 
def _newline (self, n=1)
 
def _write (self, str)
 

Private Attributes

 _linesep
 

Detailed Description

Definition at line 1 of file xml_docstring.py.

Constructor & Destructor Documentation

◆ __init__()

def xml_docstring.XmlDocString.__init__ (   self,
  index 
)

Definition at line 2 of file xml_docstring.py.

Member Function Documentation

◆ _clean()

def xml_docstring.XmlDocString._clean (   self)
private

Definition at line 60 of file xml_docstring.py.

◆ _newline()

def xml_docstring.XmlDocString._newline (   self,
  n = 1 
)
private

Definition at line 52 of file xml_docstring.py.

◆ _write()

def xml_docstring.XmlDocString._write (   self,
  str 
)
private

Definition at line 43 of file xml_docstring.py.

◆ clear()

def xml_docstring.XmlDocString.clear (   self)

Definition at line 28 of file xml_docstring.py.

◆ emphasis()

def xml_docstring.XmlDocString.emphasis (   self,
  node 
)

Definition at line 112 of file xml_docstring.py.

◆ formula()

def xml_docstring.XmlDocString.formula (   self,
  node 
)

Definition at line 168 of file xml_docstring.py.

◆ getDocString()

def xml_docstring.XmlDocString.getDocString (   self,
  brief,
  detailled,
  output 
)

Definition at line 75 of file xml_docstring.py.

◆ itemizedlist()

def xml_docstring.XmlDocString.itemizedlist (   self,
  node 
)

Definition at line 160 of file xml_docstring.py.

◆ listitem()

def xml_docstring.XmlDocString.listitem (   self,
  node 
)

Definition at line 164 of file xml_docstring.py.

◆ otherTags()

def xml_docstring.XmlDocString.otherTags (   self,
  node 
)

Definition at line 104 of file xml_docstring.py.

◆ para()

def xml_docstring.XmlDocString.para (   self,
  node 
)

Definition at line 121 of file xml_docstring.py.

◆ parameteritem()

def xml_docstring.XmlDocString.parameteritem (   self,
  node 
)

Definition at line 146 of file xml_docstring.py.

◆ parameterlist()

def xml_docstring.XmlDocString.parameterlist (   self,
  node 
)

Definition at line 139 of file xml_docstring.py.

◆ ref()

def xml_docstring.XmlDocString.ref (   self,
  node 
)

Definition at line 130 of file xml_docstring.py.

◆ simplesect()

def xml_docstring.XmlDocString.simplesect (   self,
  node 
)

Definition at line 117 of file xml_docstring.py.

◆ unknownTag()

def xml_docstring.XmlDocString.unknownTag (   self,
  node 
)

Definition at line 100 of file xml_docstring.py.

◆ visit()

def xml_docstring.XmlDocString.visit (   self,
  node 
)

Definition at line 92 of file xml_docstring.py.

◆ writeErrors()

def xml_docstring.XmlDocString.writeErrors (   self,
  output 
)

Definition at line 33 of file xml_docstring.py.

Member Data Documentation

◆ _linesep

xml_docstring.XmlDocString._linesep
private

Definition at line 19 of file xml_docstring.py.

◆ index

xml_docstring.XmlDocString.index

Definition at line 3 of file xml_docstring.py.

◆ latex

xml_docstring.XmlDocString.latex

Definition at line 24 of file xml_docstring.py.

◆ lines

xml_docstring.XmlDocString.lines

Definition at line 29 of file xml_docstring.py.

◆ tags

xml_docstring.XmlDocString.tags

Definition at line 4 of file xml_docstring.py.

◆ unkwownReferences

xml_docstring.XmlDocString.unkwownReferences

Definition at line 18 of file xml_docstring.py.

◆ unkwownTags

xml_docstring.XmlDocString.unkwownTags

Definition at line 17 of file xml_docstring.py.


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


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