[ CLASS ] - Class to generate Doxygen documentation for a package's Python source code. More...

Inheritance diagram for sDoxygen.doxygenConfigLib.PackagePython:

Public Member Functions
def	__init__ (self, packagePath, verboseLevel=sDoxygen.doxygenConfigAbs.VerboseLevel.kWarningsOnly)
	Constructor. More...

Public Member Functions inherited from sDoxygen.doxygenConfigAbs.Doxygen
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...

Additional Inherited Members
Static Public Attributes inherited from sDoxygen.doxygenConfigAbs.Doxygen
string	CONFIG_FILE_EXTENSION = 'doxygen'
	[ str ] - File extension of config files. More...

Detailed Description

[ CLASS ] - Class to generate Doxygen documentation for a package's Python source code.

Constructor & Destructor Documentation

def sDoxygen.doxygenConfigLib.PackagePython.__init__	(	self,
		packagePath,
		verboseLevel = `sDoxygen.doxygenConfigAbs.VerboseLevel.kWarningsOnly`
	)

Constructor.

Parameters

packagePath	[ str \| None \| in ] - Root path of a package.
verboseLevel	[ enum \| sDoxygen.doxygenAbs.VerboseLevel.kSilent \| in ] - Verbose level from sDoxygen.doxygenConfigAbs.VerboseLevel enum class.

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