#include <classdef.h>
Inheritance diagram for ClassDef:
A compound can be a class, struct, union, interface, or exception.
Definition at line 55 of file classdef.h.
The various compound types
Definition at line 59 of file classdef.h.
| ClassDef::ClassDef | ( | const char * | fileName, | |
| int | startLine, | |||
| const char * | name, | |||
| CompoundType | ct, | |||
| const char * | ref = 0, |
|||
| const char * | fName = 0, |
|||
| bool | isSymbol = TRUE | |||
| ) |
Creates a new compound definition.
| fileName | full path and file name in which this compound was found. | |
| startLine | line number where the definition of this compound starts. | |
| name | the name of this compound (including scope) | |
| ct | the kind of Compound | |
| ref | the tag file from which this compound is extracted or 0 if the compound doesn't come from a tag file | |
| fName | the file name as found in the tag file. This overwrites the file that doxygen normally generates based on the compound type & name. | |
| isSymbol | If TRUE this class name is added as a publicly visible (and referencable) symbol. |
Definition at line 248 of file classdef.cpp.
References compoundTypeString(), ClassDefImpl::compType, ClassDefImpl::init(), ClassDefImpl::isObjC, Definition::name(), Definition::setReference(), and visited.
Referenced by getVariableInstance(), and insertTemplateInstance().
| ClassDef::~ClassDef | ( | ) |
Destroys a compound definition.
Definition at line 265 of file classdef.cpp.
| DefType ClassDef::definitionType | ( | ) | const [inline, virtual] |
Used for RTTI, this is a class
Implements DefinitionIntf.
Definition at line 95 of file classdef.h.
References DefinitionIntf::TypeClass.
Referenced by VhdlDocGen::debugClassName().
| QCString ClassDef::getOutputFileBase | ( | ) | const [virtual] |
Returns the unique base name (without extension) of the class's file on disk
Implements Definition.
Definition at line 2714 of file classdef.cpp.
References Definition::convertNameToFile(), ClassDefImpl::fileName, getOutputFileBase(), isReference(), and ClassDefImpl::templateMaster.
Referenced by addListReferences(), DotGroupCollaboration::buildGraph(), VhdlDocGen::debugClassName(), DotClassGraph::DotClassGraph(), LatexGenerator::endIndexSection(), DiagramItem::fileName(), generateDEFForClass(), MemberDef::getOutputFileBase(), getOutputFileBase(), linkifyText(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeClassDiagrams(), writeClassTree(), writeClassTreeNode(), ClassSDict::writeDeclaration(), MemberDef::writeDocumentation(), writeDocumentation(), writeGroupTreeNode(), writeMemberList(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLTypeDocumentation().
| QCString ClassDef::getInstanceOutputFileBase | ( | ) | const |
Definition at line 2730 of file classdef.cpp.
References Definition::convertNameToFile(), ClassDefImpl::fileName, and isReference().
| QCString ClassDef::getFileBase | ( | ) | const |
Definition at line 2742 of file classdef.cpp.
References ClassDefImpl::fileName, getFileBase(), and ClassDefImpl::templateMaster.
Referenced by VhdlDocGen::debugClassName(), and getFileBase().
| QCString ClassDef::getSourceFileBase | ( | ) | const [virtual] |
Returns the base name for the source code file
Reimplemented from Definition.
Definition at line 2754 of file classdef.cpp.
References Definition::convertNameToFile(), ClassDefImpl::fileName, getSourceFileBase(), and ClassDefImpl::templateMaster.
Referenced by getSourceFileBase().
| QCString ClassDef::getReference | ( | ) | const [virtual] |
If this class originated from a tagfile, this will return the tag file reference
Reimplemented from Definition.
Definition at line 2963 of file classdef.cpp.
References Definition::getReference(), getReference(), and ClassDefImpl::templateMaster.
Referenced by DotGroupCollaboration::buildGraph(), VhdlDocGen::debugClassName(), DotClassGraph::DotClassGraph(), MemberDef::getReference(), getReference(), linkifyText(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeClassDiagrams(), writeClassTree(), writeClassTreeNode(), ClassSDict::writeDeclaration(), MemberDef::writeDocumentation(), writeGroupTreeNode(), writeMemberList(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLTypeDocumentation().
| bool ClassDef::isReference | ( | ) | const [virtual] |
Returns TRUE if this class is imported via a tag file
Reimplemented from Definition.
Definition at line 2975 of file classdef.cpp.
References Definition::isReference(), isReference(), and ClassDefImpl::templateMaster.
Referenced by generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), getInstanceOutputFileBase(), getOutputFileBase(), hasNonReferenceSuperClass(), isLinkable(), isLinkableInProject(), isReference(), isVisibleInHierarchy(), writeClassTree(), and ClassSDict::writeDeclaration().
| bool ClassDef::isLocal | ( | ) | const |
Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES
Definition at line 3212 of file classdef.cpp.
References ClassDefImpl::isLocal.
Referenced by ClassSDict::writeDeclaration().
| ClassSDict * ClassDef::getInnerClasses | ( | ) |
returns the classes nested into this class
Definition at line 3217 of file classdef.cpp.
References ClassDefImpl::innerClasses.
Referenced by PerlModGenerator::generatePerlModForClass().
| bool ClassDef::hasDocumentation | ( | ) | const [virtual] |
returns TRUE if this class has documentation
Reimplemented from Definition.
Definition at line 2099 of file classdef.cpp.
References Definition::hasDocumentation().
Referenced by isLinkableInProject(), and isVisibleInHierarchy().
| QCString ClassDef::displayName | ( | ) | const |
Returns the name as it is appears in the documentation
Definition at line 275 of file classdef.cpp.
References ClassDefImpl::className, ClassDefImpl::compType, Config_getBool, VhdlDocGen::getClassName(), Protocol, QCString, qualifiedNameWithTemplateParameters(), and substitute().
Referenced by addListReferences(), DotClassGraph::DotClassGraph(), VhdlDocGen::getClassTitle(), MemberDef::getScopeString(), DiagramItem::label(), writeAnnotatedClassList(), writeClassDiagrams(), writeClassTree(), writeClassTreeNode(), ClassSDict::writeDeclaration(), MemberDef::writeDocumentation(), writeDocumentation(), writeGroupTreeNode(), and writeMemberList().
| ClassDef::CompoundType ClassDef::compoundType | ( | ) | const |
Returns the type of compound this is, i.e. class/struct/union/..
Definition at line 3222 of file classdef.cpp.
References ClassDefImpl::compType.
Referenced by DocSets::addIndexItem(), writeAnnotatedClassList(), ClassSDict::writeDeclaration(), and MemberDef::writeDocumentation().
| QCString ClassDef::compoundTypeString | ( | ) | const |
Returns the type of compound as a string
Definition at line 2681 of file classdef.cpp.
References Category, Class, ClassDefImpl::compType, Config_getBool, Exception, Interface, ClassDefImpl::isObjC, Protocol, Struct, and Union.
Referenced by ClassDef(), VhdlDocGen::debugClassName(), generateDEFForClass(), validatingParseDoc(), writeAnnotatedClassList(), ClassSDict::writeDeclaration(), writeDeclaration(), and writeDocumentation().
| BaseClassList * ClassDef::baseClasses | ( | ) | const |
Returns the list of base classes from which this class directly inherits.
Definition at line 3227 of file classdef.cpp.
References ClassDefImpl::inherits.
Referenced by generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), hasVisibleRoot(), initClassHierarchy(), DiagramRow::insertClass(), isBaseClass(), mergeMembers(), minClassDistance(), trimBaseClassScope(), and writeClassTree().
| BaseClassList * ClassDef::subClasses | ( | ) | const |
Returns the list of sub classes that directly derive from this class
Definition at line 3232 of file classdef.cpp.
References ClassDefImpl::inheritedBy.
Referenced by generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), DiagramRow::insertClass(), writeClassTree(), and writeClassTreeNode().
| MemberNameInfoSDict * ClassDef::memberNameInfoSDict | ( | ) | const |
Returns a dictionary of all members. This includes any inherited members. Members are sorted alphabetically.
Definition at line 3237 of file classdef.cpp.
References ClassDefImpl::allMemberNameInfoSDict.
Referenced by PerlModGenerator::addListOfAllMembers(), addMembersToTemplateInstance(), and mergeCategory().
| Protection ClassDef::protection | ( | ) | const |
Return the protection level (Public,Protected,Private) in which this compound was found.
Definition at line 3242 of file classdef.cpp.
References ClassDefImpl::prot.
Referenced by VhdlDocGen::computeVhdlComponentRelations(), VhdlDocGen::findComponent(), VhdlDocGen::findMember(), VhdlDocGen::getClassName(), VhdlDocGen::getClassTitle(), VhdlDocGen::writeClassType(), writeDocumentationForInnerClasses(), VhdlDocGen::writeInlineClassLink(), and VhdlDocGen::writeVHDLDeclaration().
| bool ClassDef::isLinkableInProject | ( | ) | const [virtual] |
returns TRUE iff a link is possible to this item within this project.
Implements Definition.
Definition at line 2041 of file classdef.cpp.
References Config_getBool, hasDocumentation(), Definition::isArtificial(), Definition::isHidden(), isLinkableInProject(), ClassDefImpl::isLocal, isReference(), ClassDefImpl::isStatic, Definition::name(), Private, ClassDefImpl::prot, and ClassDefImpl::templateMaster.
Referenced by addClassMemberNameToIndex(), addListReferences(), countAnnotatedClasses(), LatexGenerator::endIndexSection(), hasNonReferenceSuperClass(), isLinkable(), MemberDef::isLinkableInProject(), isLinkableInProject(), linkifyText(), LatexGenerator::startIndexSection(), writeAlphabeticalClassList(), writeAnnotatedClassList(), ClassSDict::writeDeclaration(), MemberDef::writeDocumentation(), and writeDocumentationForInnerClasses().
| bool ClassDef::isLinkable | ( | ) | const [virtual] |
return TRUE iff a link to this class is possible (either within this project, or as a cross-reference to another project).
Implements Definition.
Definition at line 2060 of file classdef.cpp.
References isLinkable(), isLinkableInProject(), isReference(), and ClassDefImpl::templateMaster.
Referenced by DotClassGraph::DotClassGraph(), TreeDiagram::drawBoxes(), getDefs(), getMemberByName(), getResolvedClass(), MemberDef::isDocumentedFriendClass(), isLinkable(), linkifyText(), writeClassDiagrams(), writeClassTree(), writeClassTreeNode(), ClassSDict::writeDeclaration(), writeDeclaration(), MemberDef::writeDocumentation(), writeGroupTreeNode(), and writeMemberList().
| bool ClassDef::isVisibleInHierarchy | ( | ) |
the class is visible in a class diagram, or class hierarchy
Definition at line 2074 of file classdef.cpp.
References Config_getBool, hasDocumentation(), hasNonReferenceSuperClass(), Definition::isArtificial(), isReference(), ClassDefImpl::isStatic, Definition::name(), Private, ClassDefImpl::prot, and ClassDefImpl::templateMaster.
Referenced by hasVisibleRoot(), DiagramRow::insertClass(), writeClassDiagrams(), writeClassTree(), and writeClassTreeNode().
| ArgumentList * ClassDef::templateArguments | ( | ) | const |
Returns the template arguments of this class Will return 0 if not applicable.
Definition at line 3247 of file classdef.cpp.
References ClassDefImpl::tempArgs.
Referenced by addMembersToTemplateInstance(), VariableContext::addVariable(), getTemplateParameterLists(), insertTemplateSpecifierInScope(), and qualifiedNameWithTemplateParameters().
| NamespaceDef * ClassDef::getNamespaceDef | ( | ) | const |
Returns the namespace this compound is in, or 0 if it has a global scope.
Definition at line 3252 of file classdef.cpp.
References ClassDefImpl::nspace.
| FileDef * ClassDef::getFileDef | ( | ) | const |
Returns the file in which this compound's definition can be found. Should not return 0 (but it might be a good idea to check anyway).
Definition at line 3257 of file classdef.cpp.
References ClassDefImpl::fileDef.
Referenced by getDefs().
| MemberDef * ClassDef::getMemberByName | ( | const QCString & | ) | const |
Returns the Java package this class is in or 0 if not applicable.
Definition at line 3098 of file classdef.cpp.
References ClassDefImpl::allMemberNameInfoSDict, SDict< T >::find(), MemberDef::getClassDef(), isLinkable(), maxInheritanceDepth, MemberInfo::memberDef, and minClassDistance().
| bool ClassDef::isBaseClass | ( | ClassDef * | bcd, | |
| bool | followInstances, | |||
| int | level = 0 | |||
| ) |
Returns TRUE iff bcd is a direct or indirect base class of this class. This function will recusively traverse all branches of the inheritance tree.
Definition at line 2109 of file classdef.cpp.
References baseClasses(), err(), found, name, and Definition::name().
Referenced by isAccessibleMember(), and mergeMembers().
| bool ClassDef::isAccessibleMember | ( | MemberDef * | md | ) |
returns TRUE iff md is a member of this class or of the the public/protected members of a base class
Definition at line 3128 of file classdef.cpp.
References MemberDef::getClassDef(), and isBaseClass().
| QDict< ClassDef > * ClassDef::getTemplateInstances | ( | ) | const |
Returns a sorted dictionary with all template instances found for this template class. Returns 0 if not a template or no instances.
Definition at line 3262 of file classdef.cpp.
References ClassDefImpl::templateInstances.
| ClassDef * ClassDef::templateMaster | ( | ) | const |
Returns the template master of which this class is an instance. Returns 0 if not applicable.
Definition at line 3267 of file classdef.cpp.
References ClassDefImpl::templateMaster.
Referenced by addClassMemberNameToIndex(), countAnnotatedClasses(), LatexGenerator::endIndexSection(), generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), LatexGenerator::startIndexSection(), writeAlphabeticalClassList(), writeAnnotatedClassList(), and writeDocumentationForInnerClasses().
| bool ClassDef::isTemplate | ( | ) | const |
Returns TRUE if this class is a template
Definition at line 3272 of file classdef.cpp.
References ClassDefImpl::tempArgs.
Referenced by DocSets::addIndexItem().
| IncludeInfo * ClassDef::includeInfo | ( | ) | const |
Definition at line 3277 of file classdef.cpp.
References ClassDefImpl::incInfo.
Referenced by DocSets::addIndexItem(), and PerlModGenerator::generatePerlModForClass().
| UsesClassDict * ClassDef::usedImplementationClasses | ( | ) | const |
| UsesClassDict * ClassDef::usedByImplementationClasses | ( | ) | const |
| UsesClassDict * ClassDef::usedInterfaceClasses | ( | ) | const |
| bool ClassDef::isTemplateArgument | ( | ) | const |
| Definition * ClassDef::findInnerCompound | ( | const char * | name | ) | [virtual] |
Returns the definition of a nested compound if available, or 0 otherwise.
| name | The name of the nested compound |
Reimplemented from Definition.
Definition at line 2802 of file classdef.cpp.
References SDict< T >::find(), and ClassDefImpl::innerClasses.
| void ClassDef::getTemplateParameterLists | ( | QList< ArgumentList > & | lists | ) | const |
Returns the template parameter lists that form the template declaration of this class.
Example: template<class T> class TC {}; will return a list with one ArgumentList containing one argument with type="class" and name="T".
Definition at line 2987 of file classdef.cpp.
References DefinitionIntf::definitionType(), Definition::getOuterScope(), getTemplateParameterLists(), templateArguments(), and DefinitionIntf::TypeClass.
Referenced by getTemplateParameterLists(), and MemberDef::writeDocumentation().
| QCString ClassDef::qualifiedNameWithTemplateParameters | ( | QList< ArgumentList > * | actualParams = 0 |
) | const |
Definition at line 3004 of file classdef.cpp.
References Config_getBool, DefinitionIntf::definitionType(), Definition::getOuterScope(), Definition::localName(), QCString, Definition::qualifiedName(), qualifiedNameWithTemplateParameters(), tempArgListToString(), templateArguments(), and DefinitionIntf::TypeClass.
Referenced by displayName(), and qualifiedNameWithTemplateParameters().
| bool ClassDef::isAbstract | ( | ) | const |
Returns TRUE if there is at least one pure virtual member in this class.
Definition at line 3302 of file classdef.cpp.
References ClassDefImpl::isAbstract.
| bool ClassDef::isObjectiveC | ( | ) | const |
Returns TRUE if this class is implemented in Objective-C
Definition at line 3307 of file classdef.cpp.
References ClassDefImpl::isObjC.
Referenced by MemberDef::isObjCMethod(), MemberDef::writeDocumentation(), writeDocumentation(), and writeMemberList().
| ClassDef * ClassDef::categoryOf | ( | ) | const |
Returns the class of which this is a category (Objective-C only)
Definition at line 3312 of file classdef.cpp.
References ClassDefImpl::categoryOf.
Referenced by minClassDistance().
| QCString ClassDef::className | ( | ) | const |
Returns the name of the class including outer classes, but not including namespaces.
Definition at line 3056 of file classdef.cpp.
References ClassDefImpl::className.
Referenced by PrefixIgnoreClassList::compareItems(), VhdlDocGen::debugClassName(), VhdlDocGen::getClassName(), parseVhdlCode(), writeAlphabeticalClassList(), and VhdlDocGen::writeInlineClassLink().
| MemberList * ClassDef::getMemberList | ( | MemberList::ListType | lt | ) |
Returns the members in the list identified by lt
Definition at line 3151 of file classdef.cpp.
References MemberList::listType(), and ClassDefImpl::memberLists.
Referenced by VhdlDocGen::findAllPackages(), VhdlDocGen::findFunction(), VhdlDocGen::findMemberDef(), generateDEFForClass(), and PerlModGenerator::generatePerlModForClass().
| const QList< MemberList > & ClassDef::getMemberLists | ( | ) | const |
Returns the list containing the list of members sorted per type
Definition at line 3317 of file classdef.cpp.
References ClassDefImpl::memberLists.
Referenced by generateDEFForClass().
| MemberGroupSDict * ClassDef::getMemberGroupSDict | ( | ) | const |
Returns the member groups defined for this class
Definition at line 3322 of file classdef.cpp.
References ClassDefImpl::memberGroupSDict.
Referenced by PerlModGenerator::generatePerlModForClass().
| QDict< int > * ClassDef::getTemplateBaseClassNames | ( | ) | const |
| ClassDef * ClassDef::getVariableInstance | ( | const char * | templSpec | ) |
Definition at line 2876 of file classdef.cpp.
References addMembersToTemplateInstance(), Class, ClassDef(), Debug::Classes, Definition::name(), Debug::print(), setTemplateMaster(), and ClassDefImpl::variableInstances.
Referenced by VariableContext::addVariable().
| bool ClassDef::isUsedOnly | ( | ) | const |
| void ClassDef::insertBaseClass | ( | ClassDef * | , | |
| const char * | name, | |||
| Protection | p, | |||
| Specifier | s, | |||
| const char * | t = 0 | |||
| ) |
Definition at line 305 of file classdef.cpp.
References ClassDefImpl::inherits.
Referenced by VhdlDocGen::computeVhdlComponentRelations().
| void ClassDef::insertSubClass | ( | ClassDef * | , | |
| Protection | p, | |||
| Specifier | s, | |||
| const char * | t = 0 | |||
| ) |
| void ClassDef::setIncludeFile | ( | FileDef * | fd, | |
| const char * | incName, | |||
| bool | local, | |||
| bool | force | |||
| ) |
Definition at line 738 of file classdef.cpp.
References IncludeInfo::fileDef, ClassDefImpl::incInfo, IncludeInfo::includeName, and IncludeInfo::local.
| void ClassDef::insertMember | ( | MemberDef * | ) |
Definition at line 632 of file classdef.cpp.
References MemberDef::protection().
Referenced by addMembersToTemplateInstance().
| void ClassDef::insertUsedFile | ( | const char * | ) |
Definition at line 702 of file classdef.cpp.
References ClassDefImpl::files, insertUsedFile(), and ClassDefImpl::templateInstances.
Referenced by insertUsedFile().
| bool ClassDef::addExample | ( | const char * | anchor, | |
| const char * | name, | |||
| const char * | file | |||
| ) |
Definition at line 1870 of file classdef.cpp.
References ClassDefImpl::exampleSDict, SDict< T >::find(), SDict< T >::inSort(), and SDict< T >::setAutoDelete().
| void ClassDef::mergeCategory | ( | ClassDef * | category | ) |
Merges the members of a Objective-C category into this class.
Definition at line 2399 of file classdef.cpp.
References ClassDefImpl::allMemberNameInfoSDict, MemberInfo::ambigClass, MemberInfo::ambiguityResolutionScope, SDict< T >::append(), SDict< T >::find(), MemberInfo::inherited, SDict< MemberNameInfo >::Iterator, MemberInfo::memberDef, MemberNameInfo::memberName(), memberNameInfoSDict(), MemberInfo::prot, MemberInfo::scopePath, setCategoryOf(), and MemberInfo::virt.
| void ClassDef::setNamespace | ( | NamespaceDef * | nd | ) |
| void ClassDef::setFileDef | ( | FileDef * | fd | ) |
| void ClassDef::setSubGrouping | ( | bool | enabled | ) |
| void ClassDef::setProtection | ( | Protection | p | ) |
| void ClassDef::setGroupDefForAllMembers | ( | GroupDef * | g, | |
| Grouping::GroupPri_t | pri, | |||
| const QCString & | fileName, | |||
| int | startLine, | |||
| bool | hasDocs | |||
| ) |
Definition at line 2766 of file classdef.cpp.
References GroupDef::addClass(), ClassDefImpl::allMemberNameInfoSDict, MemberDef::getClassDefOfAnonymousType(), GroupDef::insertMember(), SDict< MemberNameInfo >::Iterator, MemberInfo::memberDef, MemberDef::setGroupDef(), and setGroupDefForAllMembers().
Referenced by addMemberToGroups(), and setGroupDefForAllMembers().
| void ClassDef::addInnerCompound | ( | Definition * | d | ) | [virtual] |
Reimplemented from Definition.
Definition at line 2788 of file classdef.cpp.
References DefinitionIntf::definitionType(), ClassDefImpl::innerClasses, SDict< T >::inSort(), Definition::localName(), and DefinitionIntf::TypeClass.
| ClassDef * ClassDef::insertTemplateInstance | ( | const QCString & | fileName, | |
| int | startLine, | |||
| const QCString & | templSpec, | |||
| bool & | freshInstance | |||
| ) |
Definition at line 2853 of file classdef.cpp.
References Class, ClassDef(), Debug::Classes, Definition::getOuterScope(), Definition::isHidden(), Definition::localName(), Definition::name(), Debug::print(), and ClassDefImpl::templateInstances.
| void ClassDef::addUsedClass | ( | ClassDef * | cd, | |
| const char * | accessName | |||
| ) |
Definition at line 2446 of file classdef.cpp.
References UsesClassDef::addAccessor(), name, and ClassDefImpl::usesImplClassDict.
| void ClassDef::addUsedByClass | ( | ClassDef * | cd, | |
| const char * | accessName | |||
| ) |
Definition at line 2465 of file classdef.cpp.
References UsesClassDef::addAccessor(), name, and ClassDefImpl::usedByImplClassDict.
| void ClassDef::setIsStatic | ( | bool | b | ) |
| void ClassDef::setIsObjectiveC | ( | bool | b | ) |
| void ClassDef::setCompoundType | ( | CompoundType | t | ) |
| void ClassDef::setClassName | ( | const char * | name | ) |
| void ClassDef::setTemplateArguments | ( | ArgumentList * | al | ) |
| void ClassDef::setTemplateBaseClassNames | ( | QDict< int > * | templateNames | ) |
| void ClassDef::setTemplateMaster | ( | ClassDef * | tm | ) |
Definition at line 3362 of file classdef.cpp.
References ClassDefImpl::templateMaster.
Referenced by getVariableInstance().
| void ClassDef::setTypeConstraints | ( | ArgumentList * | al | ) |
| void ClassDef::addMembersToTemplateInstance | ( | ClassDef * | cd, | |
| const char * | templSpec | |||
| ) |
Definition at line 2920 of file classdef.cpp.
References SDict< T >::append(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), MemberDef::createTemplateInstanceMember(), Definition::docFile(), Definition::docLine(), Definition::documentation(), SDict< T >::find(), MemberDef::getMemberGroupId(), MemberDef::getMemberSpecifiers(), MemberDef::inbodyDocumentation(), MemberDef::inbodyFile(), MemberDef::inbodyLine(), insertMember(), SDict< MemberNameInfo >::Iterator, MemberInfo::memberDef, memberNameInfoSDict(), Doxygen::memberNameSDict, MemberDef::name, Definition::setBriefDescription(), Definition::setDocumentation(), MemberDef::setInbodyDocumentation(), MemberDef::setMemberClass(), MemberDef::setMemberGroupId(), MemberDef::setMemberSpecifiers(), MemberDef::setTemplateMaster(), stringToArgumentList(), and templateArguments().
Referenced by getVariableInstance().
| void ClassDef::makeTemplateArgument | ( | bool | b = TRUE |
) |
| void ClassDef::setCategoryOf | ( | ClassDef * | cd | ) |
Definition at line 3372 of file classdef.cpp.
References ClassDefImpl::categoryOf.
Referenced by mergeCategory().
| void ClassDef::setUsedOnly | ( | bool | b | ) |
| void ClassDef::findSectionsInDocumentation | ( | ) |
Definition at line 677 of file classdef.cpp.
References MemberList::detailedLists, Definition::docFile(), docFindSections(), Definition::documentation(), MemberList::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), ClassDefImpl::memberGroupSDict, and ClassDefImpl::memberLists.
| void ClassDef::addMembersToMemberGroup | ( | ) |
Definition at line 331 of file classdef.cpp.
References MemberGroup::addToDeclarationSection(), MemberGroup::allMembersInSameSection(), MemberList::detailedLists, SIntDict< MemberGroup >::Iterator, MemberList::listType(), ClassDefImpl::memberGroupSDict, ClassDefImpl::memberLists, and ClassDefImpl::subGrouping.
| void ClassDef::addListReferences | ( | ) |
Definition at line 3066 of file classdef.cpp.
References MemberList::addListReferences(), MemberGroup::addListReferences(), addRefItem(), Config_getBool, MemberList::detailedLists, displayName(), getOutputFileBase(), isLinkableInProject(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), ClassDefImpl::memberGroupSDict, ClassDefImpl::memberLists, LockingPtr< T >::pointer(), theTranslator, Translator::trClass(), Translator::trType(), and Definition::xrefListItems().
| void ClassDef::computeAnchors | ( | ) |
Definition at line 638 of file classdef.cpp.
References Config_getBool, MemberList::detailedLists, SIntDict< MemberGroup >::Iterator, MemberList::listType(), ClassDefImpl::memberGroupSDict, ClassDefImpl::memberLists, MemberGroup::setAnchors(), and setAnchors().
| void ClassDef::mergeMembers | ( | ) |
recusively merges the `all members' lists of a class base with that of this class. Must only be called for classes without subclasses!
Definition at line 2151 of file classdef.cpp.
References ClassDefImpl::allMemberNameInfoSDict, MemberInfo::ambigClass, MemberInfo::ambiguityResolutionScope, SDict< T >::append(), baseClasses(), BaseClassDef::classDef, Config_getBool, SDict< T >::find(), found, MemberDef::getClassDef(), Interface, isBaseClass(), SDict< MemberNameInfo >::Iterator, matchArguments2(), MemberInfo::memberDef, MemberNameInfo::memberName(), ClassDefImpl::membersMerged, mergeMembers(), name, Normal, LockingPtr< T >::pointer(), Private, MemberInfo::prot, BaseClassDef::prot, Protected, Public, QCString, MemberInfo::scopePath, SDict< T >::setAutoDelete(), BaseClassDef::virt, and MemberInfo::virt.
Referenced by mergeMembers().
| void ClassDef::distributeMemberGroupDocumentation | ( | ) |
Definition at line 664 of file classdef.cpp.
References MemberGroup::distributeMemberGroupDocumentation(), SIntDict< MemberGroup >::Iterator, and ClassDefImpl::memberGroupSDict.
| void ClassDef::writeDocumentation | ( | OutputList & | ol | ) |
Definition at line 1172 of file classdef.cpp.
References addGroupListToTitle(), SearchIndex::addWord(), ClassDefImpl::allMemberNameInfoSDict, MemberGroup::allMembersInSameSection(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Class, BaseClassDef::classDef, compoundTypeString(), ClassDefImpl::compType, Config_getBool, Config_getString, convertToXML(), MemberList::dcopMethods, OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::docify(), FileDef::docName(), Definition::documentation(), OutputList::enable(), OutputList::enableAll(), endFile(), OutputList::endGroupHeader(), OutputList::endMemberSections(), OutputList::endQuickIndices(), OutputList::endTextBlock(), OutputList::endTextLink(), endTitle(), OutputList::endTypewriter(), MemberList::events, IncludeInfo::fileDef, MemberList::friends, VhdlDocGen::getClassTitle(), Definition::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, hasExamples(), HLI_ClassVisible, OutputGenerator::Html, Doxygen::htmlFileExtension, ClassDefImpl::incInfo, FileDef::includeName(), IncludeInfo::includeName, ClassDefImpl::inherits, ClassDefImpl::innerClasses, Interface, ClassDefImpl::isObjC, isObjectiveC(), SIntDict< MemberGroup >::Iterator, IncludeInfo::local, Definition::localName(), OutputGenerator::Man, ClassDefImpl::memberGroupSDict, Argument::name, name, Definition::name(), OutputList::newParagraph(), MemberList::pacAttribs, MemberList::pacMethods, MemberList::pacStaticAttribs, MemberList::pacStaticMethods, MemberList::pacTypes, OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), MemberList::priAttribs, MemberList::priMethods, MemberList::priSlots, MemberList::priStaticAttribs, MemberList::priStaticMethods, MemberList::priTypes, MemberList::proAttribs, MemberList::proMethods, MemberList::properties, MemberList::proSlots, MemberList::proStaticAttribs, MemberList::proStaticMethods, MemberList::proTypes, MemberList::pubAttribs, MemberList::pubMethods, MemberList::pubSlots, MemberList::pubStaticAttribs, MemberList::pubStaticMethods, MemberList::pubTypes, OutputList::pushGeneratorState(), QCString, MemberList::related, OutputGenerator::RTF, Doxygen::searchIndex, SearchIndex::setCurrentDoc(), showUsedFiles(), OutputList::startContents(), startFile(), OutputList::startGroupHeader(), OutputList::startMemberSections(), OutputList::startTextBlock(), OutputList::startTextLink(), startTitle(), OutputList::startTypewriter(), ClassDefImpl::subGrouping, Doxygen::tagFile, ClassDefImpl::tempArgs, theTranslator, Translator::trAuthor(), Translator::trCompoundReference(), Translator::trCompoundReferenceFortran(), Translator::trDCOPMethods(), Translator::trEvents(), Translator::trFriends(), Translator::trGeneratedAutomatically(), Translator::trListOfAllMembers(), Translator::trMore(), Translator::trPackageAttribs(), Translator::trPackageMembers(), Translator::trPackageTypes(), Translator::trPrivateAttribs(), Translator::trPrivateMembers(), Translator::trPrivateSlots(), Translator::trPrivateTypes(), Translator::trProperties(), Translator::trProtectedAttribs(), Translator::trProtectedMembers(), Translator::trProtectedSlots(), Translator::trProtectedTypes(), Translator::trPublicAttribs(), Translator::trPublicMembers(), Translator::trPublicSlots(), Translator::trPublicTypes(), Translator::trRelatedFunctions(), Translator::trRelatedSubscript(), Translator::trSignals(), Translator::trStaticPackageAttribs(), Translator::trStaticPackageMembers(), Translator::trStaticPrivateAttribs(), Translator::trStaticPrivateMembers(), Translator::trStaticProtectedAttribs(), Translator::trStaticProtectedMembers(), Translator::trStaticPublicAttribs(), Translator::trStaticPublicMembers(), writeClassDiagrams(), ClassSDict::writeDeclaration(), MemberGroup::writeDeclarations(), writeDetailedDescription(), Definition::writeDocAnchorsToTagFile(), writeMemberDocumentation(), writeMemberPages(), Definition::writeNavigationPath(), OutputList::writeObjectLink(), OutputList::writeString(), and OutputList::writeSynopsis().
Referenced by writeDocumentationForInnerClasses().
| void ClassDef::writeClassDiagrams | ( | OutputList & | ol | ) |
Definition at line 1000 of file classdef.cpp.
References BaseClassDef::classDef, DotNode::Collaboration, Config_getBool, Config_getString, convertToXML(), OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::docify(), OutputList::enable(), OutputList::enableAll(), OutputList::endClassDiagram(), OutputList::endDotGraph(), err(), getOutputFileBase(), getReference(), DotNode::Inheritance, ClassDefImpl::inheritedBy, ClassDefImpl::inherits, isLinkable(), DotClassGraph::isTooBig(), DotClassGraph::isTrivial(), isVisibleInHierarchy(), OutputGenerator::Man, name, OutputList::newParagraph(), OutputList::parseText(), OutputList::popGeneratorState(), Private, BaseClassDef::prot, Protected, OutputList::pushGeneratorState(), QCString, OutputList::startClassDiagram(), OutputList::startDotGraph(), Doxygen::tagFile, BaseClassDef::templSpecifiers, theTranslator, Translator::trClassDiagram(), Translator::trCollaborationDiagram(), Translator::trInheritedByList(), Translator::trInheritsList(), BaseClassDef::virt, Virtual, and OutputList::writeObjectLink().
Referenced by writeDocumentation().
| void ClassDef::writeDocumentationForInnerClasses | ( | OutputList & | ol | ) |
Definition at line 1632 of file classdef.cpp.
References Config_getBool, ClassDefImpl::innerClasses, isLinkableInProject(), SDict< ClassDef >::Iterator, msg(), name, Private, protection(), templateMaster(), writeDocumentation(), writeDocumentationForInnerClasses(), and writeMemberList().
Referenced by writeDocumentationForInnerClasses().
| void ClassDef::writeMemberDocumentation | ( | OutputList & | ol | ) |
Definition at line 1524 of file classdef.cpp.
References Config_getBool, MemberList::constructors, OutputList::disable(), OutputList::enable(), MemberList::enumMembers, MemberList::eventMembers, MemberList::functionMembers, OutputGenerator::Html, MemberList::relatedMembers, Doxygen::suppressDocWarnings, theTranslator, Translator::trConstructorDocumentation(), Translator::trEventDocumentation(), Translator::trMemberDataDocumentation(), Translator::trMemberEnumerationDocumentation(), Translator::trMemberFunctionDocumentation(), Translator::trMemberFunctionDocumentationFortran(), Translator::trMemberTypedefDocumentation(), Translator::trPropertyDocumentation(), Translator::trRelatedFunctionDocumentation(), and MemberList::variableMembers.
Referenced by writeDocumentation().
| void ClassDef::writeMemberPages | ( | OutputList & | ol | ) |
Definition at line 1560 of file classdef.cpp.
References MemberList::detailedLists, OutputList::disableAllBut(), OutputGenerator::Html, MemberList::listType(), ClassDefImpl::memberLists, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and MemberList::writeDocumentationPage().
Referenced by writeDocumentation().
| void ClassDef::writeMemberList | ( | OutputList & | ol | ) |
Definition at line 1656 of file classdef.cpp.
References ClassDefImpl::allMemberNameInfoSDict, MemberInfo::ambiguityResolutionScope, MemberDef::anchor, MemberDef::argsString(), Config_getBool, OutputList::disableAllBut(), displayName(), OutputList::docify(), OutputList::endBold(), endFile(), endTitle(), OutputList::endTypewriter(), MemberDef::getClassDef(), MemberDef::getMemberSpecifiers(), MemberDef::getOutputFileBase(), getOutputFileBase(), MemberDef::getReference(), getReference(), HLI_ClassVisible, OutputGenerator::Html, MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isExplicit(), MemberDef::isFriend(), MemberDef::isFunction(), MemberDef::isInline(), MemberDef::isLinkable(), isLinkable(), MemberDef::isMutable(), ClassDefImpl::isObjC, MemberDef::isObjCMethod(), isObjectiveC(), MemberDef::isRelated(), MemberDef::isSignal(), MemberDef::isSlot(), MemberDef::isStatic(), MemberDef::isTypedef(), SDict< MemberNameInfo >::Iterator, MemberInfo::memberDef, MemberDef::name, Normal, Package, OutputList::parseText(), OutputList::popGeneratorState(), Private, MemberInfo::prot, Protected, MemberDef::protection(), Public, Pure, OutputList::pushGeneratorState(), QCString, OutputList::startBold(), startFile(), startTitle(), OutputList::startTypewriter(), theTranslator, Translator::trDefinedIn(), Translator::trEnumName(), Translator::trEnumValue(), Translator::trIncludingInheritedMembers(), Translator::trMemberList(), Translator::trThisIsTheListOfAllMembers(), VhdlDocGen::trVhdlType(), MemberDef::typeString(), Virtual, MemberDef::virtualness(), OutputList::writeObjectLink(), and OutputList::writeString().
Referenced by writeDocumentationForInnerClasses().
| void ClassDef::writeDeclaration | ( | OutputList & | ol, | |
| MemberDef * | md, | |||
| bool | inGroup | |||
| ) |
called from MemberDef::writeDeclaration() to (recusively) write the definition of an annonymous struct, union or class.
Definition at line 1966 of file classdef.cpp.
References MemberDef::anchor, compoundTypeString(), Config_getBool, MemberList::dcopMethods, OutputList::docify(), OutputList::endBold(), OutputList::endMemberItem(), MemberList::events, MemberList::friends, isLinkable(), SIntDict< MemberGroup >::Iterator, ClassDefImpl::memberGroupSDict, Definition::name(), MemberList::pacAttribs, MemberList::pacMethods, MemberList::pacStaticAttribs, MemberList::pacStaticMethods, MemberList::pacTypes, MemberList::priAttribs, MemberList::priMethods, MemberList::priSlots, MemberList::priStaticAttribs, MemberList::priStaticMethods, MemberList::priTypes, MemberList::proAttribs, MemberList::proMethods, MemberList::properties, MemberList::proSlots, MemberList::proStaticAttribs, MemberList::proStaticMethods, MemberList::proTypes, MemberList::pubAttribs, MemberList::pubMethods, MemberList::pubSlots, MemberList::pubStaticAttribs, MemberList::pubStaticMethods, MemberList::pubTypes, QCString, MemberList::related, MemberGroup::setInGroup(), OutputList::startBold(), OutputList::writeObjectLink(), and MemberGroup::writePlainDeclarations().
Referenced by MemberDef::writeDeclaration().
| void ClassDef::writeDetailedDescription | ( | OutputList & | ol, | |
| const QCString & | pageType, | |||
| bool | exampleFlag | |||
| ) |
Definition at line 846 of file classdef.cpp.
References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Definition::docFile(), Definition::docLine(), Definition::documentation(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endSimpleSect(), OutputList::endTextBlock(), BaseOutputDocInterface::Examples, ClassDefImpl::exampleSDict, Definition::getBodyDef(), Definition::getStartBodyLine(), OutputGenerator::Latex, OutputGenerator::Man, Definition::name(), OutputList::newParagraph(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startGroupHeader(), OutputList::startSimpleSect(), OutputList::startTextBlock(), theTranslator, Translator::trDetailedDescription(), Translator::trExamples(), ClassDefImpl::typeConstraints, OutputList::writeAnchor(), OutputList::writeDescItem(), writeExample(), OutputList::writeRuler(), Definition::writeSourceDef(), OutputList::writeString(), and writeTypeConstraints().
Referenced by writeDocumentation().
| void ClassDef::writeQuickMemberLinks | ( | OutputList & | ol, | |
| MemberDef * | md | |||
| ) | const [virtual] |
Reimplemented from Definition.
Definition at line 1582 of file classdef.cpp.
References ClassDefImpl::allMemberNameInfoSDict, MemberDef::anchor, Config_getBool, createSubDirs(), MemberDef::getClassDef(), MemberDef::getOutputFileBase(), Doxygen::htmlFileExtension, MemberDef::isLinkable(), MemberDef::isLinkableInProject(), SDict< MemberNameInfo >::Iterator, MemberInfo::memberDef, MemberDef::name, and OutputList::writeString().
| void ClassDef::addUsedInterfaceClasses | ( | MemberDef * | md, | |
| const char * | typeStr | |||
| ) | [protected] |
| bool ClassDef::hasExamples | ( | ) | [protected] |
Definition at line 1891 of file classdef.cpp.
References SDict< T >::count(), and ClassDefImpl::exampleSDict.
Referenced by writeDocumentation().
| bool ClassDef::hasNonReferenceSuperClass | ( | ) | [protected] |
Returns TRUE iff this class or a class inheriting from this class is not defined in an external tag file.
Definition at line 1929 of file classdef.cpp.
References found, ClassDefImpl::inheritedBy, Definition::isHidden(), isLinkableInProject(), and isReference().
Referenced by isVisibleInHierarchy().
| void ClassDef::showUsedFiles | ( | OutputList & | ol | ) | [protected] |
Definition at line 911 of file classdef.cpp.
References Class, ClassDefImpl::compType, Config_getBool, OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::endItemList(), ClassDefImpl::files, findFileDef(), FileDef::generateSourceFile(), FileDef::getOutputFileBase(), FileDef::getPath(), Definition::getReference(), FileDef::getSourceFileBase(), FileDef::getVersion(), OutputGenerator::Html, Doxygen::inputNameDict, Interface, FileDef::isLinkable(), ClassDefImpl::isObjC, FileDef::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, OutputList::startItemList(), stripFromPath(), theTranslator, Translator::trGeneratedFromFiles(), Translator::trGeneratedFromFilesFortran(), OutputList::writeListItem(), OutputList::writeObjectLink(), and OutputList::writeRuler().
Referenced by writeDocumentation().
| bool ClassDef::visited |
Definition at line 318 of file classdef.h.
Referenced by ClassDef(), clearVisitFlags(), initClassHierarchy(), writeClassTree(), and writeClassTreeNode().
| QCString ClassDef::name |
Definition at line 1222 of file doxytag.cpp.
Referenced by GroupDef::addClass(), PerlModGenerator::addListOfAllMembers(), addUsedByClass(), addUsedClass(), MemberNameInfo::compareItems(), MemberName::compareItems(), BaseClassList::compareItems(), generateDEFForClass(), generateDEFForMember(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), MemberDef::getClassDefOfAnonymousType(), VhdlDocGen::getClassName(), getDefs(), NamespaceDef::insertClass(), FileDef::insertClass(), NamespaceDef::insertMember(), GroupDef::insertMember(), FileDef::insertMember(), isBaseClass(), main(), mergeMembers(), minClassDistance(), MemberDef::objCMethodName(), MemberDef::qualifiedName(), setAnchors(), CallContext::setClass(), trimBaseClassScope(), writeAlphabeticalClassList(), writeClassDiagrams(), writeClassTree(), ClassSDict::writeDeclaration(), MemberDef::writeDocumentation(), writeDocumentation(), writeDocumentationForInnerClasses(), and VhdlDocGen::writeVHDLTypeDocumentation().
| QStrList ClassDef::bases |
| QCString ClassDef::fileName |
| bool ClassDef::isFile |
1.5.1