Stash Software API  2.0.0
Static Public Attributes | List of all members
sStash.projectLib.ProjectFolder Class Reference

[ ENUM CLASS ] - Project folder enum class. More...

Inheritance diagram for sStash.projectLib.ProjectFolder:
sStash.enumAbs.Enum

Static Public Attributes

string kDevelopers = 'developers'
 [ str ] - Developers folder name. More...
 
string kDoc = 'doc'
 [ str ] - Documentation folder name. More...
 
 kDocDeveloper = os.path.join(kDoc, 'developer')
 [ str ] - Developer documentation folder name. More...
 
 kDocDeveloperCPPAPIReference = os.path.join(kDocDeveloper, 'cppAPIReference')
 [ str ] - Developer C++ API reference folder name. More...
 
 kDocDeveloperPythonAPIReference = os.path.join(kDocDeveloper, 'pythonAPIReference')
 [ str ] - Developer Python API reference folder name. More...
 
string kPackages = 'packages'
 [ str ] - Packages folder name. More...
 
string kUsers = 'users'
 [ str ] - Users folder name. More...
 

Additional Inherited Members

- Public Member Functions inherited from sStash.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, startAttrNamesLower=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 ] - Project folder enum class.

Member Data Documentation

◆ kDevelopers

string sStash.projectLib.ProjectFolder.kDevelopers = 'developers'
static

[ str ] - Developers folder name.

◆ kDoc

string sStash.projectLib.ProjectFolder.kDoc = 'doc'
static

[ str ] - Documentation folder name.

◆ kDocDeveloper

sStash.projectLib.ProjectFolder.kDocDeveloper = os.path.join(kDoc, 'developer')
static

[ str ] - Developer documentation folder name.

◆ kDocDeveloperCPPAPIReference

sStash.projectLib.ProjectFolder.kDocDeveloperCPPAPIReference = os.path.join(kDocDeveloper, 'cppAPIReference')
static

[ str ] - Developer C++ API reference folder name.

◆ kDocDeveloperPythonAPIReference

sStash.projectLib.ProjectFolder.kDocDeveloperPythonAPIReference = os.path.join(kDocDeveloper, 'pythonAPIReference')
static

[ str ] - Developer Python API reference folder name.

◆ kPackages

string sStash.projectLib.ProjectFolder.kPackages = 'packages'
static

[ str ] - Packages folder name.

◆ kUsers

string sStash.projectLib.ProjectFolder.kUsers = 'users'
static

[ str ] - Users folder name.


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