sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey Class Reference

[ ENUM CLASS ] - Keys to be replaces in the config template file. More...

Inheritance diagram for sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey:

Static Public Attributes
string	kProjectName = 'S_PROJECT_NAME'
	[ str ] - Project name key. More...
string	kProjectNumber = 'S_PROJECT_NUMBER'
	[ str ] - Project number key. More...
string	kProjectBrief = 'S_PROJECT_BRIEF'
	[ str ] - Project brief key. More...
string	kInput = 'S_INPUT'
	[ str ] - Input. More...
string	kOutputDirectory = 'S_OUTPUT_DIRECTORY'
	[ str ] - Document output directory key. More...
string	kStripFromPath = 'S_STRIP_FROM_PATH'
	[ str ] - Strip from path. More...
string	kFilePatterns = 'S_FILE_PATTERNS'
	[ str ] - File patterns. More...
string	kExcludePatterns = 'S_EXCLUDE_PATTERNS'
	[ str ] - Exclude patterns. More...
string	kUseMDFileAsMainPage = 'S_USE_MDFILE_AS_MAINPAGE'
	[ str ] - Use MD file as main page. More...

Additional Inherited Members
Public Member Functions inherited from sCore.enumAbs.Enum
def	listAttributes (cls, stringOnly=True, getValues=True, removeK=True, startAttrNamesLower=False)
	List static public attributes of the class. More...
def	listAttributeElements (cls, attribute)
	List elements of a static public attribute. More...
def	getAttributeNameFromValue (cls, value, removeK=True, defaultAttributeName=None, startLower=False)
	Get the name of the attribute for given value. More...
def	getValueFromAttributeName (cls, attribute, removeK=False, defaultValue=None)
	Get value from attribute name. More...
def	asDict (cls, removeK=True)
	Get all the attributes and their values in a dict instance. More...

Detailed Description

[ ENUM CLASS ] - Keys to be replaces in the config template file.

Member Data Documentation

kProjectName

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kProjectName = 'S_PROJECT_NAME'

static

[ str ] - Project name key.

kProjectNumber

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kProjectNumber = 'S_PROJECT_NUMBER'

static

[ str ] - Project number key.

kProjectBrief

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kProjectBrief = 'S_PROJECT_BRIEF'

static

[ str ] - Project brief key.

kInput

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kInput = 'S_INPUT'

static

[ str ] - Input.

kOutputDirectory

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kOutputDirectory = 'S_OUTPUT_DIRECTORY'

static

[ str ] - Document output directory key.

kStripFromPath

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kStripFromPath = 'S_STRIP_FROM_PATH'

static

[ str ] - Strip from path.

kFilePatterns

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kFilePatterns = 'S_FILE_PATTERNS'

static

[ str ] - File patterns.

kExcludePatterns

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kExcludePatterns = 'S_EXCLUDE_PATTERNS'

static

[ str ] - Exclude patterns.

kUseMDFileAsMainPage

string sDoxygen.doxygenConfigAbs.ConfigTemplateFileContentKey.kUseMDFileAsMainPage = 'S_USE_MDFILE_AS_MAINPAGE'

static

[ str ] - Use MD file as main page.

---

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

• sDoxygen/python/sDoxygen/doxygenConfigAbs.py