sDoxygen.doxygenConfigAbs.Doxygen Class Reference

[ ABSTRACT CLASS ] - Abstract class for Doxygen documentation generation. More...

Inheritance diagram for sDoxygen.doxygenConfigAbs.Doxygen:

Public Member Functions
def	__init__ (self, verboseLevel=VerboseLevel.kSilent)
	Constructor. More...
def	__str__ (self)
	String representation. More...
def	asStr (self)
	Get string representation of the class. More...
def	getDefaultHTMLPath (self)
	Get absolute path of default html path. More...
def	initialize (self)
	Initialize. More...
def	create (self)
	Create documentation. More...

Static Public Attributes
string	CONFIG_FILE_EXTENSION = 'doxygen'
	[ str ] - File extension of config files. More...

Detailed Description

[ ABSTRACT CLASS ] - Abstract class for Doxygen documentation generation.

Constructor & Destructor Documentation

__init__()

def sDoxygen.doxygenConfigAbs.Doxygen.__init__	(		self,
			verboseLevel = VerboseLevel.kSilent
	)

Constructor.

Parameters

verboseLevel

[ enum | sDoxygen.doxygenAbs.VerboseLevel.kSilent | in ] - Verbose level from sDoxygen.doxygenConfigAbs.VerboseLevel enum class.

Returns

None - None.

Member Function Documentation

__str__()

def sDoxygen.doxygenConfigAbs.Doxygen.__str__

(

self

)

String representation.

Exceptions

N/A

Returns

str - Representation.

asStr()

def sDoxygen.doxygenConfigAbs.Doxygen.asStr

(

self

)

Get string representation of the class.

Exceptions

N/A

Returns

str - Information about the package in human readable form.

getDefaultHTMLPath()

def sDoxygen.doxygenConfigAbs.Doxygen.getDefaultHTMLPath

(

self

)

Get absolute path of default html path.

Exceptions

N/A

Returns

str - Path.

initialize()

def sDoxygen.doxygenConfigAbs.Doxygen.initialize

(

self

)

Initialize.

Exceptions

N/A

Returns

None - None.

create()

def sDoxygen.doxygenConfigAbs.Doxygen.create

(

self

)

Create documentation.

Exceptions

N/A

Returns

tuple - stdout and stderr strings.

Member Data Documentation

CONFIG_FILE_EXTENSION

string sDoxygen.doxygenConfigAbs.Doxygen.CONFIG_FILE_EXTENSION = 'doxygen'

static

[ str ] - File extension of config files.

---

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

• sDoxygen/python/sDoxygen/doxygenConfigAbs.py