Overview description of a Module.
More...
|
| def | __init__ |
| | Initialize self from XML in overview_element.
|
| |
Overview description of a Module.
This class captures the overview text for a module. It corresponds to the following XML:
<Overview>
Overview text goes here.
</Overview>
| def data_structures.Overview.__init__ |
( |
|
self, |
|
|
|
overview_element, |
|
|
|
style |
|
) |
| |
Initialize self from XML in overview_element.
- Parameters
-
| self | Overview to fill from overview_element. |
| overview_element | ET.Element to extract XML from |
| style | Style object that specifies how to format generate code. |
This method will initialize self with the Overview XML tag contained in overview_element.
| def data_structures.Overview.extract |
( |
|
parent_element, |
|
|
|
style |
|
) |
| |
|
static |
Extract and return Overview object from parent_element.
- Parameters
-
| parent_element | ET.Element that contains Overview XML |
| style | Style object that specifies how to format generate code. |
- Returns
- Overview object that extracted is returned.
This static method will extract the XML Overview tag from parent_element and return it.
The documentation for this class was generated from the following file:
