Public Member Functions | |
| ClassDefImpl () | |
| ~ClassDefImpl () | |
| void | init (const char *defFileName, const char *name, const QCString &ctStr, const char *fName) |
Public Attributes | |
| QCString | fileName |
| IncludeInfo * | incInfo |
| BaseClassList * | inherits |
| BaseClassList * | inheritedBy |
| NamespaceDef * | nspace |
| FileDef * | fileDef |
| MemberNameInfoSDict * | allMemberNameInfoSDict |
| ArgumentList * | tempArgs |
| ArgumentList * | typeConstraints |
| QStrList | files |
| ExampleSDict * | exampleSDict |
| ClassDef::CompoundType | compType |
| Protection | prot |
| ClassSDict * | innerClasses |
| UsesClassDict * | usesImplClassDict |
| UsesClassDict * | usedByImplClassDict |
| UsesClassDict * | usesIntfClassDict |
| QDict< ClassDef > * | templateInstances |
| QDict< ClassDef > * | variableInstances |
| QDict< int > * | templBaseClassNames |
| ClassDef * | templateMaster |
| QCString | className |
| ClassDef * | categoryOf |
| QList< MemberList > | memberLists |
| MemberGroupSDict * | memberGroupSDict |
| bool | isAbstract |
| bool | isStatic |
| bool | isObjC |
| bool | membersMerged |
| bool | isLocal |
| bool | isTemplArg |
| bool | subGrouping |
| bool | usedOnly |
Definition at line 47 of file classdef.cpp.
| ClassDefImpl::ClassDefImpl | ( | ) |
Definition at line 224 of file classdef.cpp.
| ClassDefImpl::~ClassDefImpl | ( | ) |
Definition at line 228 of file classdef.cpp.
References allMemberNameInfoSDict, exampleSDict, incInfo, inheritedBy, inherits, innerClasses, memberGroupSDict, tempArgs, templateInstances, templBaseClassNames, typeConstraints, usedByImplClassDict, usesImplClassDict, usesIntfClassDict, and variableInstances.
| void ClassDefImpl::init | ( | const char * | defFileName, | |
| const char * | name, | |||
| const QCString & | ctStr, | |||
| const char * | fName | |||
| ) |
Definition at line 172 of file classdef.cpp.
References allMemberNameInfoSDict, categoryOf, className, Config_getBool, exampleSDict, extractNamespaceName(), fileDef, fileName, guessSection(), incInfo, inheritedBy, inherits, innerClasses, isAbstract, isLocal, isStatic, isTemplArg, memberGroupSDict, membersMerged, nspace, prot, Public, QCString, Entry::SOURCE_SEC, stripExtension(), subGrouping, tempArgs, templateInstances, templateMaster, templBaseClassNames, typeConstraints, usedByImplClassDict, usedOnly, usesImplClassDict, usesIntfClassDict, and variableInstances.
Referenced by ClassDef::ClassDef().
| QCString ClassDefImpl::fileName |
file name that forms the base for the output file containing the class documentation. For compatibility with Qt (e.g. links via tag files) this name cannot be derived from the class name directly.
Definition at line 59 of file classdef.cpp.
Referenced by ClassDef::getFileBase(), ClassDef::getInstanceOutputFileBase(), ClassDef::getOutputFileBase(), ClassDef::getSourceFileBase(), and init().
Include information about the header file should be included in the documentation. 0 by default, set by setIncludeFile().
Definition at line 64 of file classdef.cpp.
Referenced by ClassDef::includeInfo(), init(), ClassDef::setIncludeFile(), ClassDef::writeDocumentation(), and ~ClassDefImpl().
List of base class (or super-classes) from which this class derives directly.
Definition at line 69 of file classdef.cpp.
Referenced by ClassDef::baseClasses(), init(), ClassDef::insertBaseClass(), ClassDef::writeClassDiagrams(), ClassDef::writeDocumentation(), and ~ClassDefImpl().
List of sub-classes that directly derive from this class
Definition at line 73 of file classdef.cpp.
Referenced by ClassDef::hasNonReferenceSuperClass(), init(), ClassDef::insertSubClass(), ClassDef::subClasses(), ClassDef::writeClassDiagrams(), and ~ClassDefImpl().
Namespace this class is part of (this is the inner most namespace in case of nested namespaces)
Definition at line 78 of file classdef.cpp.
Referenced by ClassDef::getNamespaceDef(), init(), and ClassDef::setNamespace().
File this class is defined in
Definition at line 81 of file classdef.cpp.
Referenced by ClassDef::getFileDef(), init(), and ClassDef::setFileDef().
List of all members (including inherited members)
Definition at line 84 of file classdef.cpp.
Referenced by ClassDef::getMemberByName(), init(), ClassDef::memberNameInfoSDict(), ClassDef::mergeCategory(), ClassDef::mergeMembers(), ClassDef::setGroupDefForAllMembers(), ClassDef::writeDocumentation(), ClassDef::writeMemberList(), ClassDef::writeQuickMemberLinks(), and ~ClassDefImpl().
Template arguments of this class
Definition at line 87 of file classdef.cpp.
Referenced by init(), ClassDef::isTemplate(), ClassDef::setTemplateArguments(), ClassDef::templateArguments(), ClassDef::writeDocumentation(), and ~ClassDefImpl().
Type constraints for template parameters
Definition at line 90 of file classdef.cpp.
Referenced by init(), ClassDef::setTypeConstraints(), ClassDef::writeDetailedDescription(), and ~ClassDefImpl().
| QStrList ClassDefImpl::files |
Files that were used for generating the class documentation.
Definition at line 93 of file classdef.cpp.
Referenced by ClassDef::insertUsedFile(), and ClassDef::showUsedFiles().
Examples that use this class
Definition at line 96 of file classdef.cpp.
Referenced by ClassDef::addExample(), ClassDef::hasExamples(), init(), ClassDef::writeDetailedDescription(), and ~ClassDefImpl().
Holds the kind of "class" this is.
Definition at line 99 of file classdef.cpp.
Referenced by ClassDef::ClassDef(), ClassDef::compoundType(), ClassDef::compoundTypeString(), ClassDef::displayName(), ClassDef::setCompoundType(), ClassDef::showUsedFiles(), and ClassDef::writeDocumentation().
The protection level in which this class was found. Typically Public, but for nested classes this can also be Protected or Private.
Definition at line 105 of file classdef.cpp.
Referenced by init(), ClassDef::isLinkableInProject(), ClassDef::isVisibleInHierarchy(), ClassDef::protection(), and ClassDef::setProtection().
The inner classes contained in this class. Will be 0 if there are no inner classes.
Definition at line 110 of file classdef.cpp.
Referenced by ClassDef::addInnerCompound(), ClassDef::findInnerCompound(), ClassDef::getInnerClasses(), init(), ClassDef::writeDocumentation(), ClassDef::writeDocumentationForInnerClasses(), and ~ClassDefImpl().
Definition at line 113 of file classdef.cpp.
Referenced by ClassDef::addUsedClass(), init(), ClassDef::usedImplementationClasses(), and ~ClassDefImpl().
Definition at line 114 of file classdef.cpp.
Referenced by ClassDef::addUsedByClass(), init(), ClassDef::usedByImplementationClasses(), and ~ClassDefImpl().
Definition at line 115 of file classdef.cpp.
Referenced by init(), ClassDef::usedInterfaceClasses(), and ~ClassDefImpl().
Template instances that exists of this class, the key in the dictionary is the template argument list.
Definition at line 120 of file classdef.cpp.
Referenced by ClassDef::getTemplateInstances(), init(), ClassDef::insertTemplateInstance(), ClassDef::insertUsedFile(), and ~ClassDefImpl().
Template instances that exists of this class, as defined by variables. We do NOT want to document these individually. The key in the dictionary is the template argument list.
Definition at line 126 of file classdef.cpp.
Referenced by ClassDef::getVariableInstance(), init(), and ~ClassDefImpl().
| QDict<int>* ClassDefImpl::templBaseClassNames |
Definition at line 128 of file classdef.cpp.
Referenced by ClassDef::getTemplateBaseClassNames(), init(), ClassDef::setTemplateBaseClassNames(), and ~ClassDefImpl().
The class this class is an instance of.
Definition at line 131 of file classdef.cpp.
Referenced by ClassDef::getFileBase(), ClassDef::getOutputFileBase(), ClassDef::getReference(), ClassDef::getSourceFileBase(), init(), ClassDef::isLinkable(), ClassDef::isLinkableInProject(), ClassDef::isReference(), ClassDef::isVisibleInHierarchy(), ClassDef::setTemplateMaster(), and ClassDef::templateMaster().
| QCString ClassDefImpl::className |
class name with outer class scope, but without namespace scope.
Definition at line 134 of file classdef.cpp.
Referenced by ClassDef::className(), ClassDef::displayName(), init(), and ClassDef::setClassName().
If this class is a Objective-C category, then this points to the class which is extended.
Definition at line 139 of file classdef.cpp.
Referenced by ClassDef::categoryOf(), init(), and ClassDef::setCategoryOf().
Definition at line 141 of file classdef.cpp.
Referenced by ClassDef::addListReferences(), ClassDef::addMembersToMemberGroup(), ClassDef::computeAnchors(), ClassDef::findSectionsInDocumentation(), ClassDef::getMemberList(), ClassDef::getMemberLists(), and ClassDef::writeMemberPages().
Definition at line 144 of file classdef.cpp.
Referenced by ClassDef::addListReferences(), ClassDef::addMembersToMemberGroup(), ClassDef::computeAnchors(), ClassDef::distributeMemberGroupDocumentation(), ClassDef::findSectionsInDocumentation(), ClassDef::getMemberGroupSDict(), init(), ClassDef::writeDeclaration(), ClassDef::writeDocumentation(), and ~ClassDefImpl().
Is this an abstact class?
Definition at line 147 of file classdef.cpp.
Referenced by init(), and ClassDef::isAbstract().
Is the class part of an unnamed namespace?
Definition at line 150 of file classdef.cpp.
Referenced by init(), ClassDef::isLinkableInProject(), ClassDef::isVisibleInHierarchy(), and ClassDef::setIsStatic().
| bool ClassDefImpl::isObjC |
Is the class part implemented in Objective C?
Definition at line 153 of file classdef.cpp.
Referenced by ClassDef::ClassDef(), ClassDef::compoundTypeString(), ClassDef::isObjectiveC(), ClassDef::setIsObjectiveC(), ClassDef::showUsedFiles(), ClassDef::writeDocumentation(), and ClassDef::writeMemberList().
TRUE if classes members are merged with those of the base classes.
Definition at line 156 of file classdef.cpp.
Referenced by init(), and ClassDef::mergeMembers().
TRUE if the class is defined in a source file rather than a header file.
Definition at line 159 of file classdef.cpp.
Referenced by init(), ClassDef::isLinkableInProject(), and ClassDef::isLocal().
Definition at line 161 of file classdef.cpp.
Referenced by init(), ClassDef::isTemplateArgument(), and ClassDef::makeTemplateArgument().
Does this class group its user-grouped members as a sub-section of the normal (public/protected/..) groups?
Definition at line 167 of file classdef.cpp.
Referenced by ClassDef::addMembersToMemberGroup(), init(), ClassDef::setSubGrouping(), and ClassDef::writeDocumentation().
Definition at line 169 of file classdef.cpp.
Referenced by init(), ClassDef::isUsedOnly(), and ClassDef::setUsedOnly().
1.5.1