|
HWRF
trunk@4391
|
Subclass of override, for documenting the core configuration files. More...
Subclass of override, for documenting the core configuration files.
Definition at line 549 of file confdoc.py.
Public Member Functions | |
| def | __init__ (self, basename, parent) |
| coredoc constructor More... | |
| def | print_subdoc (self, s) |
| Prints the documentation to the specified stream. More... | |
 Public Member Functions inherited from confdoc.override | |
| def | __init__ |
| Class override constructor. More... | |
| def | secanch |
| Returns the anchor for the specified section. More... | |
| def | optanch |
| Returns the anchor for a specified section and option. More... | |
| def | section_inc (self, section, inc) |
| Sets the @inc list for a conf section. More... | |
| def | file_block (self, basename, brief, detail) |
| Adds a documentation block that is not associated with any section or option. More... | |
| def | add_section |
| Adds documentation for a conf section. More... | |
| def | add_option |
| Adds documentation for an option in a conf section. More... | |
| def | find_optbrief (self, section, option) |
| Finds the brief documentation for a section. More... | |
| def | find_secbrief (self, section) |
| Finds the brief documentation for a section. More... | |
| def | find_secdoc (self, section, detail) |
| Finds the brief and detailed documentation for a section. More... | |
| def | print_subdoc (self, s) |
| Prints the documentation to the specified stream. More... | |
| def | print_sec_opt (self, s) |
| Prints the section and option part of the documentation to the given stream. More... | |
| Public Member Functions inherited from confdoc.docbase | |
| def | __init__ (self) |
| docbase constructor More... | |
| def | set_subdoc (self, basename, doc) |
| Sets the documentation object that will contain file-specific information for the given file. More... | |
| def | fileanch (self, basename) |
| Returns the anchor for a configuration file. More... | |
| def | secanch |
| Returns the anchor for a specified section. More... | |
| def | optanch |
| Returns the anchor for a specified option. More... | |
| def | make_brief (self, detail) |
| Given a detailed description for something that has no brief description, return the brief description. More... | |
| def | add_section |
| Adds documentation for a conf section. More... | |
| def | section_inc (self, section, inc) |
| Sets the @inc list for a conf section. More... | |
| def | file_block (self, basename, brief, detail) |
| Adds a documentation block that is not associated with any section or option. More... | |
| def | add_option |
| Adds documentation for an option in a conf section. More... | |
| def | print_doc (self, s) |
| Writes Doxygen documentation to the stream "s" which is assumed to be a StringIO. More... | |
Additional Inherited Members | |
| Public Attributes inherited from confdoc.docbase | |
| sections | |
| Mapping of section name to description. | |
| secref | |
| Mapping from section name to anchor name. | |
| secrefset | |
| secfile | |
| Mapping from doxified filename to list of sections in that file. | |
| secinc | |
| Mapping from section name to the list of sections that are @inc included by that section. | |
| seclist | |
| List of section names, in the order they were first seen. | |
| options | |
| Mapping from option anchor name to the description of the option. | |
| optbrief | |
| Mapping from option anchor to the option's brief description. | |
| secbrief | |
| Mapping from section name to the section's brief description. | |
| fileset | |
| filelist | |
| blocks | |
| Mapping from file basename to the list of documentation blocks in that file that were not associated with any section or option. More... | |
| Protected Member Functions inherited from confdoc.override | |
| def | _secsec (self, section, brief, detail) |
| Generates the contents of the documentation section that documents the specified conf section. More... | |
| def confdoc.coredoc.__init__ | ( | self, | |
| basename, | |||
| parent | |||
| ) |
coredoc constructor
| basename | the file basename |
| parent | The parent docbase |
Definition at line 552 of file confdoc.py.
| def confdoc.coredoc.print_subdoc | ( | self, | |
| s | |||
| ) |
Prints the documentation to the specified stream.
| s | The stream, ideally a StringIO.StringIO. |
Definition at line 557 of file confdoc.py.
1.8.10
