Class: DocCommon

Class:DocCommon
Description:
File:/cli_tools/doc/include/common.php
CVS Version:1.3
CVS Modification:2004-05-30 16:06
Variables:
NameTypeDefaultDescription
sProjectTitleString
sProjectDescriptionString
sProjectPathString
aClassesArrayfalse
aMethodsArrayfalse
sCurrentFileString
aCVSEntriesArrayfalse

DocCommon

Description:
Returns: [Undefined]
Arguments:
NameTypeOptionalDescription

sGetProjectPath

Description:
Returns: [String]
Arguments:
NameTypeOptionalDescription

bDocumentDirectory

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
sDirString
sSpaceString

bDocumentFile

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
sFileString

sGetPHPCode

Description:
Returns: [String]
Arguments:
NameTypeOptionalDescription
sContentString reference

aGetComments

Description:
Returns: [Array]
Arguments:
NameTypeOptionalDescription
sContentString reference

bGetCodeClasses

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
sCodeString reference

sGetCodeToEndBracket

Description:
Returns: [String]
Arguments:
NameTypeOptionalDescription
sCodeString reference
iStartBracketInteger
bRemoveSlicedBoolean YES [false]

bSaveXML

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription

bSaveHTML

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription

bSortClasses

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
oClass1Object
oClass2Object

bSortMethods

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription
oFunc1Object
oFunc2Object

sGetHungarianType

Description:
Returns: [String]
Arguments:
NameTypeOptionalDescription
sVariableString

sGetFileString

Description:
Returns: [String]
Arguments:
NameTypeOptionalDescription
sFileString

bSaveCHM

Description:
Returns: [Boolean]
Arguments:
NameTypeOptionalDescription