| Class |
Field |
Comment |
| Bootstrap_Tests | S | + $apiNames | |
| Bootstrap | S | + $appConfig | Contents of app/config.app.ini, stored in an associative array.
|
| Bootstrap | S | + $autoloadRules | Class naming convention :
|
| Documentor | | + $auxiliaries | Associative array containing the auxiliaries {@link Auxiliary} objects used by this documentor |
| Bootstrap_Tests | S | + $buildDir | 'build' directory on development environment |
| Documentor | | + $cache | Cache - used by {@link xgpLinks::linkToClass()} |
| ldeElementInheritance | | # $cache | Used to cache fields and methods computed in {@link computeInheritedElements()}
|
| Documentor | | + $calledFrom | Indicates if the documentor is called from a web page or from command line (shell)
|
| auComment | | + $client | Informations about the code ordering the creation of this comment.
|
| cdeOneConstant | | - $client | The object (ContentsGenerator) using this class |
| cdeOneField | | - $client | The object (ContentsGenerator) using this class |
| cdeOneFunction | | - $client | The object (ContentsGenerator) using this class |
| cdeOneConstant | | - $clientAbsolutePath | Absolute path of the generated documentation of the client |
| cdeOneField | | - $clientAbsolutePath | Absolute path of the generated documentation of the client |
| cdeOneFunction | | - $clientAbsolutePath | Absolute path of the generated documentation of the client |
| Report | S | + $comments | Array containing messages concerning comments
|
| Report | S | + $config | Array containing messages concerning user directives |
| ldeElementInheritance | | # $curAllElements | Auxiliary variable of {@link computeInheritedElements()} |
| ldeElementInheritance | | # $curAncestors | Auxiliary variable of {@link computeInheritedElements()} |
| ldeElementInheritance | | # $curClassIndex | Auxiliary variable of {@link computeInheritedElements()} |
| ldeMainLoader | | # $curClassIndex | Index of current class in $this->docu->data['classes']
|
| ldeElementInheritance | | # $curClassName | Auxiliary variable of {@link computeInheritedElements()} |
| ldeMainLoader | | # $curClassName | Name of current class |
| ldeMainLoader | | # $curFileIndex | Index of current file in $this->docu->data['files']
|
| ldeMainLoader | | # $curFileRelativePath | Relative path of current file in $this->docu->data['files'] |
| ldeMainLoader | | # $curOutputDir | Absolute path to the sub directory of outputDir, corresponding to files[$curFileIndex] |
| cdePackages | | # $curPackage | Currently processed package |
| cdePackages | | # $curPackageFile | Currently processed package documentation file, in source tree |
| czlPackages | | # $curPackageFile | Currently processed package documentation file |
| cdeClasses | | # $currentClass | The currently processed class |
| cphClasses | | - $currentClass | |
| cdeClasses | | # $currentClassName | Name of the currently processed class |
| cdeClasses | | # $currentConstantDoc | Current ConstantDoc object used to document constants |
| cdeFiles | | # $currentConstantDoc | Current ConstantDoc object used to document constants |
| cdeClasses | | # $currentFieldDoc | Current FieldDoc object used to document fields |
| cdeFiles | | # $currentFieldDoc | Current FieldDoc object used to document variables |
| cdeFiles | | # $currentFile | The currently processed file |
| cdeFiles | | # $currentFileName | Name of the currently processed file |
| cdeClasses | | # $currentFunctionDoc | Current FunctionDoc object used to document functions |
| cdeFiles | | # $currentFunctionDoc | Current FunctionDoc object used to document functions |
| cdeHierarchies | | - $curRootClasses | Auxiliary variable of generateClassHierarchy(), to store the root classes of the currently displayed class hierarchy.
|
| ldeMainLoader | | - $curTA | Current token array |
| Documentor | | + $data | The documentable objects of the documented API |
| deDataLoader | | # $dataLoaders | List of data loader class names
|
| zlDataLoader | | # $dataLoaders | |
| cdeDeprecated | | - $deprec | Contains the deprecated elements.
|
| auComment | | + $description | The description of the comment : text before the tags |
| deDirsAndFilesLoader | | - $dirs | Used by doCompute() ; contains directory names |
| ddeDocumentor | | + $docCoverage | Documentation coverage : proportion of documented code and missing comments |
| cdeOneConstant | | - $docu | The client's documentor |
| cdeOneField | | - $docu | The client's documentor |
| cdeOneFunction | | - $docu | The client's documentor |
| Helper | | + $docu | The {@link Documentor} instance using this Helper object |
| Documentor | | + $engineConfig | Engine (documentor type) configuration |
| cdeMissingDoc | | # $filename | Absolute file name of this page |
| deDirsAndFilesLoader | | - $files | Used by doCompute() ; contains file names |
| cdeAllClassConstants | | # $firstLast | Array containing first and last constant names, for each displayed page
|
| cdeAllClassFields | | # $firstLast | Array containing first and last class field names, for each displayed page
|
| cdeAllClassMethods | | # $firstLast | Array containing first and last method names, for each displayed page
|
| cdeAllConstants | | # $firstLast | Array containing first and last constant names, for each displayed page
|
| cdeAllFunctions | | # $firstLast | Array containing first and last function names, for each displayed page
|
| cdeAllVariables | | # $firstLast | Array containing first and last variable names, for each displayed page
|
| auComment | | + $firstSentence | First sentence of the description |
| dfxDocumentor | | + $flexibleConfig | Contents of flexible.ini |
| pdeFramesPageGenerator | S | # $footer | footer for normal pages (not defining the frameset) |
| pdeNoFramesPageGenerator | S | # $footer | footer for all pages |
| pphFramesPageGenerator | S | # $footer | footer for normal pages (not defining the frameset) |
| pdeFramesPageGenerator | S | # $header | header for normal pages (not defining the frameset) |
| pdeNoFramesPageGenerator | S | # $header | header for all pages |
| pphFramesPageGenerator | S | # $header | header for normal pages (not defining the frameset) |
| Documentor | | + $helpers | Associative array containing the main {@link Helper}s used by this documentor |
| pdeFramesPageGenerator | | # $initOK | Indicates if method init() has already been called |
| pdeNoFramesPageGenerator | | # $initOK | Indicates if method init() has already been called |
| pphFramesPageGenerator | | # $initOK | Indicates if method init() has already been called |
| ppParsePhpCode | S | + $initOK | Boolean Indicating if initialization of static variables has been done |
| ldeMainLoader | | - $knownVars | Auxiliary var of parseVariable(), to cache variable names already identified |
| Documentor | S | + $lastActiveDocumentor | Last active documentor, subclass of Documentor
|
| Log | S | - $level_max | The maximal log level that should be logged
|
| cphClasses | | - $linksToDocuments | Used to cache results |
| Log | S | - $logger | The Zend_Log used to log |
| cdeFiles | S | - $objectVocabulary | used by toHtml3, to build the href |
| cdeAllClassConstants | | # $pageIndex2 | Part of 'page index' (links to other constant pages) common to all pages |
| cdeAllClassFields | | # $pageIndex2 | Part of 'page index' (links to other class field pages) common to all pages |
| cdeAllClassMethods | | # $pageIndex2 | Part of 'page index' (links to other method pages) common to all pages |
| cdeAllConstants | | # $pageIndex2 | Part of 'page index' (links to other constant pages) common to all pages |
| cdeAllFunctions | | # $pageIndex2 | Part of 'page index' (links to other function pages) common to all pages |
| cdeAllVariables | | # $pageIndex2 | Part of 'page index' (links to other variable pages) common to all pages |
| ddeDocumentor | | + $pg | Page generator |
| dzlDocumentor | | + $pg | Page generator |
| phContentsGenerator | | - $pg | PageGenerator |
| ppParsePhpCode | S | + $phpIdentifierPattern | The php label applies to constant, variable, function and class names.
|
| pdeFramesPageGenerator | | # $publicFiles | Auxiliary files (css etc.) |
| pdeNoFramesPageGenerator | | # $publicFiles | Auxiliary files (css etc.) |
| pphFramesPageGenerator | | # $publicFiles | |
| cphHierarchies | | - $rootClasses | Auxiliary variable of generateClassHierarchy(), to store the root classes of the currebtly displayed class hierarchy.
|
| uArrays | S | - $sortByKey_keyname | Auxiliary variable of sortByKey(), for usort() |
| cdeAllClassConstants | | # $sortedConstants | Alphabetical array of constants
|
| cdeAllConstants | | # $sortedConstants | Alphabetical array of constants
|
| cdeAllClassFields | | # $sortedFields | Alphabetical array of class fields
|
| cdeAllFunctions | | # $sortedFunctions | Alphabetical array of functions
|