Python API
The primary purpose of the Python API is to define custom sections for the class TOCs. This is done by subclassing the
Section
class, although a number of helper functions and classes are also
available.
|
Generate a succinct TOC for automatically documented classes. |
|
Format a specific section in a class TOC, e.g. |
|
Include a "Public Methods" section in the class TOC. |
|
Include a "Private Methods" section in the class TOC. |
|
Include a "Public Data Attributes" section in the class TOC. |
|
Include a "Private Data Attributes" section in the class TOC. |
|
Include an "Inner Classes" section in the class TOC. |
|
Return true if the given attribute is a method or property. |
|
Return true if the given attribute is a data attribute, e.g. |
|
Return true if the given name is public. |
|
Return true if the given name is private. |
|
Return True if the name starts and ends with a double-underscore. |
The |
|
Indicate an configuration error affecting |