Automatically generated with Code Structure Viewer (CS), Project Version: 3o4d 17-November-2020
Copyright © 2020, BAI Research. All Rights Reserved.
File Name: CSgenerateHTMLdocumentation.cpp/.hpp
File Description: CS generate HTML documentation
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctions | void | generate HTML documentation functions |
name | type | description |
---|---|---|
firstTagInSVGFile | XMLparserTag* | first tag in SVGF ile |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
generateHTMLdocumentationMode | int | generate HTML documentation mode |
useOutputHTMLfile | const bool | use output HTML file |
traceFunctionUpwards | const bool | trace function upwards |
usePredefinedGrid | bool | use predefined grid |
outputHTMLfileName | const string | output HTML file name |
location | current function being traced |
---|---|
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateHTMLdocumentationHeader | string | generate HTML documentation header |
name | type | description |
---|---|---|
name | const string | name |
htmlHeader | const bool | html header |
isFile | const bool | is file |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
generateHTMLdocumentationHeader | string | generate HTML documentation header |
name | type | description |
---|---|---|
titleName | const string | title name |
fileName | const string | file name |
htmlHeader | const bool | html header |
isFile | const bool | is file |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
generateHTMLdocumentationFooter | string | generate HTML documentation footer |
name | type | description |
---|---|---|
htmlFileFooter | const bool | html file footer |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFooter |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFooter |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFooter |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFooter |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
generateHTMLdocumentationForAllFunctions | void | generate HTML documentation for all functions |
name | type | description |
---|---|---|
firstObjectInAboveLevelBelowListContainer | CSfileContainer* | first object in above level below list container |
currentReferenceInPrintList | LDreference* | current reference in print list |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
generateHTMLdocumentationMode | int | generate HTML documentation mode |
useOutputHTMLfile | const bool | use output HTML file |
HTMLdocumentationBody | string* | HTML documentation body |
firstTagInSVGFile | const XMLparserTag* | first tag in SVGF ile |
lastTagInSVGFile | XMLparserTag* | last tag in SVGF ile |
traceFunctionUpwards | const bool | trace function upwards |
usePredefinedGrid | bool | use predefined grid |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateHTMLdocumentationForFunction | void | generate HTML documentation for function |
name | type | description |
---|---|---|
currentReferenceInPrintList | LDreference* | current reference in print list |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
bottomLevelFunctionToTraceUpwards | CSfunction* | bottom level function to trace upwards |
fileNameHoldingFunction | const string | file name holding function |
currentTag | XMLparserTag** | current tag |
generateHTMLdocumentationMode | int | generate HTML documentation mode |
HTMLdocumentationFunctionBody | string* | HTML documentation function body |
outputSVGfileNameFunction | const string* | output SVG file name function |
useOutputHTMLfile | const bool | use output HTML file |
outputHTMLfileName | const string | output HTML file name |
traceFunctionUpwards | const bool | trace function upwards |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctionSummary | void | generate HTML documentation function summary |
name | type | description |
---|---|---|
currentFunction | const CSfunction* | current function |
HTMLdocumentationFunctionSummary | string* | HTML documentation function summary |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionSummary |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctionInputArguments | void | generate HTML documentation function input arguments |
name | type | description |
---|---|---|
currentFunction | const CSfunction* | current function |
HTMLdocumentationFunctionInputArguments | string* | HTML documentation function input arguments |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionInputArguments |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull | void | generate HTML documentation function or class arguments from function name full |
name | type | description |
---|---|---|
classDataOrFunctionArguments | const bool | class data or function arguments |
functionNameFull | const string* | function name full |
HTMLdocumentationFunctionInputArguments | string* | HTML documentation function input arguments |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionInputArguments |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctionOrClassArgumentsFromString | void | generate HTML documentation function or class arguments from string |
name | type | description |
---|---|---|
classDataOrFunctionArguments | const bool | class data or function arguments |
functionArgumentsRaw | const string | function arguments raw |
HTMLdocumentationFunctionInputArguments | string* | HTML documentation function input arguments |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromString |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionInputArguments |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList | void | generate HTML documentation function or class arguments from parameter list |
name | type | description |
---|---|---|
classDataOrFunctionArguments | const bool | class data or function arguments |
parameterList | vector<CSparameter*>* | parameter list |
HTMLdocumentationParameterList | string* | HTML documentation parameter list |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromParameterList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionInputArguments |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
ensureHTMLTagSafe | string | ensure HTMLT ag safe |
name | type | description |
---|---|---|
str | const string | str |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | ensureHTMLTagSafe |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromString |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionInputArguments |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
CSgenerateHTMLdocumentation.hpp | ensureHTMLTagSafe |
name | return type | description |
---|---|---|
createDescriptionFromCaseSensitiveMultiwordString | string | create description from case sensitive multiword string |
name | type | description |
---|---|---|
str | string | str |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | createDescriptionFromCaseSensitiveMultiwordString |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationHeader |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
CSgenerateHTMLdocumentation.hpp | createDescriptionFromCaseSensitiveMultiwordString |
CSgenerateHTMLdocumentation.hpp | createDescriptionFromCaseSensitiveMultiwordString |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromString |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionOrClassArgumentsFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | createDescriptionFromCaseSensitiveMultiwordString |
name | return type | description |
---|---|---|
generateHTMLdocumentationFunctionReferenceList | void | generate HTML documentation function reference list |
name | type | description |
---|---|---|
function | CSfunction* | function |
HTMLdocumentationFunctionReferenceList | string* | HTML documentation function reference list |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionReferenceList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateHTMLdocumentationImagePlaceHolder | string | generate HTML documentation image place holder |
name | type | description |
---|---|---|
traceImageFileName | const string* | trace image file name |
imageTitle | const string | image title |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationImagePlaceHolder |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateFileDiagramFunctionsHeirachy | void | generate file diagram functions heirachy |
name | type | description |
---|---|---|
currentFileObject | CSfile* | current file object |
outputSVGFileNameFile | const string | output SVGF ile name file |
firstObjectInTopLevelBelowListContainer | CSfileContainer* | first object in top level below list container |
usePredefinedGrid | bool | use predefined grid |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateFileDiagramFunctionsHeirachy |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
writeStringPointerToFileObject | void | write string pointer to file object |
name | type | description |
---|---|---|
s | string* | s |
writeFileObject | ofstream* | write file object |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | writeStringPointerToFileObject |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | writeStringPointerToFileObject |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
CSgenerateHTMLdocumentation.hpp | writeStringPointerToFileObject |
name | return type | description |
---|---|---|
addToHTMLdocumentationFileFunctionList | void | add to HTML documentation file function list |
name | type | description |
---|---|---|
currentFunctionObject | CSfunction* | current function object |
HTMLdocumentationFileFunctionList | string* | HTML documentation file function list |
previousIndentation | int* | previous indentation |
previousIndentationFirst | bool* | previous indentation first |
isFunctionOrFunctionReferenceList | const bool | is function or function reference list |
externalFunction | const bool | external function |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | addToHTMLdocumentationFileFunctionList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionReferenceList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
name | return type | description |
---|---|---|
generateClassHTMLdocumentationFromCustomCSclassFormat | void | generate class HTML documentation from custom CS class format |
location | current function being traced |
---|---|
CSmain.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
getFunctionNameFromFunctionNameFull | string | get function name from function name full |
name | type | description |
---|---|---|
functionNameFull | const string* | function name full |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | getFunctionNameFromFunctionNameFull |
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
CSmain.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
generateClassHTMLdocumentationFromCustomCSclassFormat | void | generate class HTML documentation from custom CS class format |
name | type | description |
---|---|---|
CSclassFileName | const string | CS class file name |
CSclassFileContents | const vector<string>* | CS class file contents |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
CSmain.hpp | generateClassHTMLdocumentationFromCustomCSclassFormat |
name | return type | description |
---|---|---|
convertIndentedListToHTMLlist | void | convert indented list to HTML list |
location | current function being traced |
---|---|
CSmain.hpp | convertIndentedListToHTMLlist |
name | return type | description |
---|---|---|
readIndentedListFile | bool | read indented list file |
name | type | description |
---|---|---|
indentedListFileName | const string | indented list file name |
indentedListVector | vector<string>* | indented list vector |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | readIndentedListFile |
CSmain.hpp | convertIndentedListToHTMLlist |
name | return type | description |
---|---|---|
generateHTMLdocumentationIndentedList | void | generate HTML documentation indented list |
name | type | description |
---|---|---|
indentedListVector | vector<string>* | indented list vector |
HTMLdocumentationIndentationList | string* | HTML documentation indentation list |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationIndentedList |
CSmain.hpp | convertIndentedListToHTMLlist |
name | return type | description |
---|---|---|
addToHTMLdocumentationIndentedList | void | add to HTML documentation indented list |
name | type | description |
---|---|---|
currentFunctionObjectName | const string | current function object name |
currentFunctionObjectIndentation | int | current function object indentation |
HTMLdocumentationFileFunctionList | string* | HTML documentation file function list |
previousIndentation | int* | previous indentation |
previousIndentationFirst | bool* | previous indentation first |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | addToHTMLdocumentationIndentedList |
CSgenerateHTMLdocumentation.hpp | addToHTMLdocumentationFileFunctionList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionReferenceList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |
CSgenerateHTMLdocumentation.hpp | addToHTMLdocumentationIndentedList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationIndentedList |
name | return type | description |
---|---|---|
generateFunctionString | string | generate function string |
name | type | description |
---|---|---|
currentFunction | const CSfunction* | current function |
isFunctionOrFunctionReferenceList | const bool | is function or function reference list |
externalFunction | const bool | external function |
location | current function being traced |
---|---|
CSgenerateHTMLdocumentation.hpp | generateFunctionString |
CSgenerateHTMLdocumentation.hpp | addToHTMLdocumentationFileFunctionList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationFunctionReferenceList |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForFunction |
CSgenerateHTMLdocumentation.hpp | generateHTMLdocumentationForAllFunctions |
CSexecflow.hpp | generateHTMLdocumentationFunctions |
CSmain.hpp | generateCodeStructure |