gensrc.addins.doxygen.Doxygen Class Reference
Inheritance diagram for gensrc.addins.doxygen.Doxygen:
Collaboration diagram for gensrc.addins.doxygen.Doxygen:
Public Member Functions | |
| def | generate (self, categoryList, enumerationList) |
| public interface More... | |
| def | generateEnumeratedType (self, enumeratedTypeGroup, i, line1, line2) |
| def | generateEnumeratedClass (self, enumeratedClassGroup, i, line1, line2) |
| def | generateEnums (self) |
| def | generateFunctionDoc (self, func) |
| def | generateCategoryDoc (self) |
| def | generateFunctionList (self, allFuncs) |
| def | generateDocs (self) |
 Public Member Functions inherited from gensrc.addins.addin.Addin | |
| def | objectIdSuffix (self) |
| public interface More... | |
| def | bufferLoop (self) |
| def | unchanged (self) |
| def | updated (self) |
| def | created (self) |
| def | incrementUnchanged (self) |
| def | incrementUpdated (self) |
| def | incrementCreated (self) |
| def | voCall (self) |
| def | libraryCall (self) |
| def | libraryReturnType (self) |
| def | loopInputs (self) |
| def | loopReturnType (self) |
| def | idStrip (self, parameterList) |
| def | relativePath (self) |
| def | repositoryClass (self) |
| def | overwriteVariable (self) |
| def | serialize (self, serializer) |
| serializer interface More... | |
| def | postSerialize (self) |
| def | __init__ (self) |
| private member functions More... | |
Public Attributes | |
| categoryList_ | |
| enumerationList_ | |
| Public Attributes inherited from gensrc.addins.addin.Addin | |
| rootPath_ | |
| unchanged_ | |
| updated_ | |
| created_ | |
Static Public Attributes | |
| string | LINE_ENUM = ' <tr><td>%s</td><td>%s</td></tr>\n' |
| class variables | |
| string | LINE_REF_CLASS = '\\ref enum_class_%d \\n\n' |
| string | LINE_REF_TYPE = '\\ref enum_type_%d \\n\n' |
| string | LINE_SECTION_CLASS = '\\subsection enum_class_%d %s\n' |
| string | LINE_SECTION_TYPE = '\\subsection enum_type_%d %s\n' |
| string | LINE_TABLE |
| Static Public Attributes inherited from gensrc.addins.addin.Addin | |
| string | objectIdSuffix_ = '' |
| class variables | |
| string | repositoryClass_ = 'Repository' |
| string | overwriteVariable_ = 'Overwrite' |
Detailed Description
Generate doxygen documentation files.
Member Function Documentation
◆ generate()
| def gensrc.addins.doxygen.Doxygen.generate | ( | self, | |
| categoryList, | |||
| enumerationList | |||
| ) |
public interface
Generate doxygen documentation files.
◆ generateCategoryDoc()
| def gensrc.addins.doxygen.Doxygen.generateCategoryDoc | ( | self | ) |
Generate page listing function categories.
◆ generateDocs()
| def gensrc.addins.doxygen.Doxygen.generateDocs | ( | self | ) |
Generate doxygen documentation files.
◆ generateEnumeratedClass()
| def gensrc.addins.doxygen.Doxygen.generateEnumeratedClass | ( | self, | |
| enumeratedClassGroup, | |||
| i, | |||
| line1, | |||
| line2 | |||
| ) |
Generate documentation relating to an enumerated class.
◆ generateEnumeratedType()
| def gensrc.addins.doxygen.Doxygen.generateEnumeratedType | ( | self, | |
| enumeratedTypeGroup, | |||
| i, | |||
| line1, | |||
| line2 | |||
| ) |
Generate documentation relating to an enumerated type.
◆ generateEnums()
| def gensrc.addins.doxygen.Doxygen.generateEnums | ( | self | ) |
Generate documentation for enumerations.
◆ generateFunctionDoc()
| def gensrc.addins.doxygen.Doxygen.generateFunctionDoc | ( | self, | |
| func | |||
| ) |
Generate documentation for given function.
◆ generateFunctionList()
| def gensrc.addins.doxygen.Doxygen.generateFunctionList | ( | self, | |
| allFuncs | |||
| ) |
Generate alphabetical list of links to all functions.
Member Data Documentation
◆ LINE_TABLE
|
static |
Initial value:
= """<table>\n
<tr><td><b>String</b></td><td><b>%s</b></td></tr>\n"""
The documentation for this class was generated from the following file:
- doxygen.py