sStashPackage.packageLib.PackageFile Class Reference

[ ENUM CLASS ] - Name of the files contained by any package. More...

Inheritance diagram for sStashPackage.packageLib.PackageFile:

Static Public Attributes
string	kReadMeMarkdownFileName = 'README.md'
	[ str ] - Name of readme file. More...
string	kEnvModuleFileBaseName = 'packageEnvLib'
	[ str ] - Name of the package environment file. More...
string	kInfoModuleFileBaseName = 'packageInfoLib'
	[ str ] - Name of the package info file that contains information about the package. More...
string	kReleaseModuleFileBaseName = 'packageReleaseLib'
	[ str ] - Name of the package release file. More...
string	kGitIgnoreFileBaseName = 'gitignore'
	[ str ] - Git ignore template file name. More...
string	kDoxygenConfigFileBaseName = 'packageDoxygenMainLib'
	[ str ] - Doxygen documentation file base name. 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 ] - Name of the files contained by any package.

Member Data Documentation

kReadMeMarkdownFileName

string sStashPackage.packageLib.PackageFile.kReadMeMarkdownFileName = 'README.md'

static

[ str ] - Name of readme file.

kEnvModuleFileBaseName

string sStashPackage.packageLib.PackageFile.kEnvModuleFileBaseName = 'packageEnvLib'

static

[ str ] - Name of the package environment file.

kInfoModuleFileBaseName

string sStashPackage.packageLib.PackageFile.kInfoModuleFileBaseName = 'packageInfoLib'

static

[ str ] - Name of the package info file that contains information about the package.

kReleaseModuleFileBaseName

string sStashPackage.packageLib.PackageFile.kReleaseModuleFileBaseName = 'packageReleaseLib'

static

[ str ] - Name of the package release file.

kGitIgnoreFileBaseName

string sStashPackage.packageLib.PackageFile.kGitIgnoreFileBaseName = 'gitignore'

static

[ str ] - Git ignore template file name.

kDoxygenConfigFileBaseName

string sStashPackage.packageLib.PackageFile.kDoxygenConfigFileBaseName = 'packageDoxygenMainLib'

static

[ str ] - Doxygen documentation file base name.

---

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

• sStashPackage/python/sStashPackage/packageLib.py