data_structures.Description Class Reference

A Description of module function or register. More...

Public Member Functions
def	__init__
	Description Constructor

Static Public Member Functions
def	extract
	Return the Description object from parent_element

Detailed Description

A Description of module function or register.

Each module has a textual description in its defining XML file. This class captures the descriptive text. This corresponds to:

   <Description>
     Text that describes function or register goes here.
   </Description>

in the XML file.

Constructor & Destructor Documentation

def data_structures.Description.__init__	(		self,
			description_element,
			style
	)

Description Constructor

Parameters

description_element	Element that contains the Description XML
style	Style object that specifies how to format generate code.

Initialize a Description object using description_element for the XML information and style for the formatting style.

Member Function Documentation

def data_structures.Description.extract (   parent_element,   style  )

static

Return the Description object from parent_element

Parameters

parent_element	Element parent containing XML description
style	Style object that specifies how to format generate code.

Returns

Description extracted from parent_element

This static method is responsible for ensuring that there is one and only one <Description ...> tag underneight parent_element. The resulting Description is returned.

---

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

• data_structures.py