#include <definition.h>
Inheritance diagram for Definition:
Public Member Functions | |
| Definition (const char *defFileName, int defLine, const char *name, const char *b=0, const char *d=0, bool isSymbol=TRUE) | |
| virtual | ~Definition () |
| const QCString & | name () const |
| QCString | localName () const |
| virtual QCString | qualifiedName () const |
| QCString | symbolName () const |
| virtual QCString | getOutputFileBase () const=0 |
| virtual QCString | getSourceFileBase () const |
| QCString | documentation () const |
| int | docLine () const |
| QCString | docFile () const |
| QCString | briefDescription () const |
| QCString | briefDescriptionAsTooltip () const |
| int | briefLine () const |
| QCString | briefFile () const |
| QCString | getDefFileName () const |
| QCString | getDefFileExtension () const |
| int | getDefLine () const |
| virtual bool | hasDocumentation () const |
| virtual bool | hasUserDocumentation () const |
| virtual bool | isLinkableInProject () const=0 |
| virtual bool | isLinkable () const=0 |
| virtual bool | isVisibleInProject () const |
| virtual bool | isVisible () const |
| bool | isHidden () const |
| bool | isArtificial () const |
| virtual QCString | getReference () const |
| virtual bool | isReference () const |
| int | getStartBodyLine () const |
| int | getEndBodyLine () const |
| FileDef * | getBodyDef () |
| LockingPtr< GroupList > | partOfGroups () const |
| LockingPtr< QList< ListItemInfo > > | xrefListItems () const |
| virtual Definition * | findInnerCompound (const char *name) |
| virtual Definition * | getOuterScope () const |
| LockingPtr< MemberSDict > | getReferencesMembers () const |
| LockingPtr< MemberSDict > | getReferencedByMembers () const |
| void | setName (const char *name) |
| void | setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE) |
| void | setBriefDescription (const char *b, const char *briefFile, int briefLine) |
| void | setReference (const char *r) |
| void | addSectionsToDefinition (QList< SectionInfo > *anchorList) |
| void | setBodySegment (int bls, int ble) |
| void | setBodyDef (FileDef *fd) |
| void | addSourceReferencedBy (MemberDef *d) |
| void | addSourceReferences (MemberDef *d) |
| void | setRefItems (const QList< ListItemInfo > *sli) |
| void | mergeRefItems (Definition *d) |
| virtual void | addInnerCompound (Definition *d) |
| virtual void | setOuterScope (Definition *d) |
| void | setHidden (bool b) |
| void | setArtificial (bool b) |
| QCString | convertNameToFile (const char *name, bool allowDots=FALSE) const |
| void | writeSourceDef (OutputList &ol, const char *scopeName) |
| void | writeInlineCode (OutputList &ol, const char *scopeName) |
| void | writeSourceRefs (OutputList &ol, const char *scopeName) |
| void | writeSourceReffedBy (OutputList &ol, const char *scopeName) |
| void | makePartOfGroup (GroupDef *gd) |
| void | writePathFragment (OutputList &ol) const |
| void | writeNavigationPath (OutputList &ol) const |
| virtual void | writeQuickMemberLinks (OutputList &, MemberDef *) const |
| void | writeDocAnchorsToTagFile () |
Protected Member Functions | |
| void | setLocalName (const QCString name) |
| virtual void | flushToDisk () const |
| virtual void | loadFromDisk () const |
| virtual void | makeResident () const |
| void | lock () const |
| void | unlock () const |
Definition at line 98 of file definition.h.
| Definition::Definition | ( | const char * | defFileName, | |
| int | defLine, | |||
| const char * | name, | |||
| const char * | b = 0, |
|||
| const char * | d = 0, |
|||
| bool | isSymbol = TRUE | |||
| ) |
Create a new definition
Definition at line 274 of file definition.cpp.
References DefinitionImpl::hidden, and DefinitionImpl::init().
| Definition::~Definition | ( | ) | [virtual] |
Destroys the definition
Definition at line 291 of file definition.cpp.
| const QCString& Definition::name | ( | ) | const [inline] |
Returns the name of the definition
Reimplemented in FileDef.
Definition at line 116 of file definition.h.
Referenced by accessibleViaUsingNamespace(), GroupDef::addExample(), DocSets::addIndexItem(), MemberDef::addListReference(), GroupDef::addListReferences(), addMemberToGroups(), GroupDef::addNamespace(), GroupDef::addPage(), addRelatedPage(), VariableContext::addVariable(), buildDirectories(), DotGroupCollaboration::buildGraph(), ClassDef::ClassDef(), MemberDef::createTemplateInstanceMember(), NamespaceDef::displayName(), DotGroupCollaboration::DotGroupCollaboration(), extractNamespaceName(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateXML(), MemberDef::getClassDefOfAnonymousType(), MemberDef::getOutputFileBase(), DirDef::getOutputFileBase(), getResolvedClassRec(), ClassDef::getVariableInstance(), DocPara::handleInheritDoc(), NamespaceDef::insertMember(), GroupDef::insertMember(), NamespaceDef::insertNamespace(), FileDef::insertNamespace(), ClassDef::insertTemplateInstance(), isAccessibleFromWithExpScope(), ClassDef::isBaseClass(), MemberDef::isConstructor(), MemberDef::isDestructor(), MemberDef::isDocumentedFriendClass(), NamespaceDef::isLinkableInProject(), MemberDef::isLinkableInProject(), ClassDef::isLinkableInProject(), ClassDef::isVisibleInHierarchy(), linkifyText(), FileDef::name(), MemberDef::objCMethodName(), MemberDef::qualifiedName(), qualifiedName(), resolveLink(), MemberDef::setAnchor(), GroupDef::setGroupTitle(), validatingParseDoc(), MemberDef::virtualness(), MemberDef::warnIfUndocumented(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassDef::writeDeclaration(), ClassDef::writeDetailedDescription(), writeDirTreeNode(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeExampleIndex(), writeGroupTreeNode(), writeIndex(), NamespaceDef::writeMemberPages(), GroupDef::writeMemberPages(), writePageIndex(), and VhdlDocGen::writeVHDLDeclaration().
| QCString Definition::localName | ( | ) | const |
Returns the local name without any scope qualifiers.
Definition at line 1045 of file definition.cpp.
References DefinitionImpl::localName, and makeResident().
Referenced by NamespaceDef::addInnerCompound(), ClassDef::addInnerCompound(), ClassDef::insertTemplateInstance(), MemberDef::isConstructor(), ClassDef::qualifiedNameWithTemplateParameters(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), ClassDef::writeDocumentation(), NamespaceDef::writeQuickMemberLinks(), GroupDef::writeQuickMemberLinks(), FileDef::writeQuickMemberLinks(), and VhdlDocGen::writeVHDLDeclaration().
| QCString Definition::qualifiedName | ( | ) | const [virtual] |
Returns the fully qualified name of this definition
Reimplemented in MemberDef.
Definition at line 982 of file definition.cpp.
References DefinitionIntf::definitionType(), getOuterScope(), DefinitionImpl::localName, makeResident(), name(), DefinitionImpl::outerScope, qualifiedName(), and DefinitionImpl::qualifiedName.
Referenced by FileDef::addIncludedUsingDirectives(), DocSets::addIndexItem(), NamespaceDef::addUsingDeclaration(), FileDef::addUsingDeclaration(), NamespaceDef::addUsingDirective(), FileDef::addUsingDirective(), MemberDef::qualifiedName(), qualifiedName(), ClassDef::qualifiedNameWithTemplateParameters(), validatingParseDoc(), and GroupDef::writeDocumentation().
| QCString Definition::symbolName | ( | ) | const |
Returns the name of this definition as it appears in the symbol map.
Definition at line 1202 of file definition.cpp.
| virtual QCString Definition::getOutputFileBase | ( | ) | const [pure virtual] |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implemented in ClassDef, DirDef, FileDef, GroupDef, MemberDef, NamespaceDef, and PageDef.
Referenced by DocSets::addIndexItem(), DocLink::DocLink(), DocRef::DocRef(), generateRef(), validatingParseDoc(), MemberDef::writeDeclaration(), MemberDef::writeDocumentation(), and writePathFragment().
| virtual QCString Definition::getSourceFileBase | ( | ) | const [inline, virtual] |
Returns the name of the source listing of this file.
Reimplemented in ClassDef, and FileDef.
Definition at line 135 of file definition.h.
Referenced by DocLink::DocLink(), and DocRef::DocRef().
| QCString Definition::documentation | ( | ) | const |
Returns the detailed description of this definition
Definition at line 1207 of file definition.cpp.
References DefinitionImpl::details, DocInfo::doc, makeResident(), and QCString.
Referenced by ClassDef::addMembersToTemplateInstance(), VhdlDocGen::debugClassName(), MemberGroup::distributeMemberGroupDocumentation(), PageDef::findSectionsInDocumentation(), NamespaceDef::findSectionsInDocumentation(), MemberDef::findSectionsInDocumentation(), GroupDef::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), ClassDef::findSectionsInDocumentation(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), DocPara::handleInheritDoc(), MemberDef::isBriefSectionVisible(), MemberDef::isDetailedSectionLinkable(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), PageDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), and ClassDef::writeDocumentation().
| int Definition::docLine | ( | ) | const |
Returns the line number at which the detailed documentation was found.
Definition at line 1213 of file definition.cpp.
References DefinitionImpl::details, DocInfo::line, and makeResident().
Referenced by ClassDef::addMembersToTemplateInstance(), MemberGroup::distributeMemberGroupDocumentation(), PerlModGenerator::generatePerlModForPage(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), PageDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), and writeTypeConstraints().
| QCString Definition::docFile | ( | ) | const |
Returns the file in which the detailed documentation block was found. This can differ from getDefFileName().
Definition at line 1219 of file definition.cpp.
References DefinitionImpl::details, DocInfo::file, makeResident(), and QCString.
Referenced by ClassDef::addMembersToTemplateInstance(), MemberGroup::distributeMemberGroupDocumentation(), PageDef::findSectionsInDocumentation(), NamespaceDef::findSectionsInDocumentation(), MemberDef::findSectionsInDocumentation(), GroupDef::findSectionsInDocumentation(), FileDef::findSectionsInDocumentation(), ClassDef::findSectionsInDocumentation(), PerlModGenerator::generatePerlModForPage(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), PageDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), and writeTypeConstraints().
| QCString Definition::briefDescription | ( | ) | const |
Returns the brief description of this definition. This can include commands.
Definition at line 1225 of file definition.cpp.
References DefinitionImpl::brief, BriefInfo::doc, makeResident(), and QCString.
Referenced by ClassDef::addMembersToTemplateInstance(), MemberGroup::distributeMemberGroupDocumentation(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), DocPara::handleInheritDoc(), MemberDef::isDetailedSectionLinkable(), writeAnnotatedClassList(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeFileIndex(), writeNamespaceIndex(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().
| QCString Definition::briefDescriptionAsTooltip | ( | ) | const |
Returns a plain text version of the brief description suitable for use as a tool tip.
Definition at line 1231 of file definition.cpp.
References DefinitionImpl::brief, BriefInfo::doc, BriefInfo::file, BriefInfo::line, makeResident(), parseCommentAsText(), QCString, and BriefInfo::tooltip.
Referenced by DotGroupCollaboration::buildGraph(), DotCallGraph::buildGraph(), and DotClassGraph::DotClassGraph().
| int Definition::briefLine | ( | ) | const |
Returns the line number at which the brief description was found.
Definition at line 1254 of file definition.cpp.
References DefinitionImpl::brief, BriefInfo::line, and makeResident().
Referenced by ClassDef::addMembersToTemplateInstance(), MemberGroup::distributeMemberGroupDocumentation(), writeAnnotatedClassList(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeFileIndex(), writeNamespaceIndex(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().
| QCString Definition::briefFile | ( | ) | const |
Returns the file in which the brief description was found. This can differ from getDefFileName().
Definition at line 1260 of file definition.cpp.
References DefinitionImpl::brief, BriefInfo::file, makeResident(), and QCString.
Referenced by ClassDef::addMembersToTemplateInstance(), MemberGroup::distributeMemberGroupDocumentation(), writeAnnotatedClassList(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeFileIndex(), writeNamespaceIndex(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().
| QCString Definition::getDefFileName | ( | ) | const |
returns the file in which this definition was found
Definition at line 1266 of file definition.cpp.
References DefinitionImpl::defFileName, and makeResident().
Referenced by MemberDef::createTemplateInstanceMember(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), MemberDef::getOutputFileBase(), newResolveTypedef(), MemberDef::virtualness(), MemberDef::warnIfUndocumented(), writeDirTreeNode(), writeGroupTreeNode(), and writeIndex().
| QCString Definition::getDefFileExtension | ( | ) | const |
returns the extension of the file in which this definition was found
Definition at line 1272 of file definition.cpp.
References DefinitionImpl::defFileExt, and makeResident().
Referenced by OutputList::parseDoc(), FileDef::parseSource(), MemberDef::writeDocumentation(), FileDef::writeSource(), and writeXMLCodeBlock().
| int Definition::getDefLine | ( | ) | const |
returns the line number at which the definition was found
Definition at line 1278 of file definition.cpp.
References DefinitionImpl::defLine, and makeResident().
Referenced by MemberDef::createTemplateInstanceMember(), generateDEFForClass(), generateDEFForFile(), generateDEFForMember(), generateDEFForNamespace(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), MemberDef::getOutputFileBase(), MemberDef::virtualness(), MemberDef::warnIfUndocumented(), writeDirTreeNode(), writeGroupTreeNode(), and writeIndex().
| bool Definition::hasDocumentation | ( | ) | const [virtual] |
Returns TRUE iff the definition is documented (which could be generated documentation)
Reimplemented in ClassDef, and MemberDef.
Definition at line 900 of file definition.cpp.
References DefinitionImpl::brief, Config_getBool, DefinitionImpl::details, BriefInfo::doc, DocInfo::doc, and makeResident().
Referenced by MemberDef::hasDocumentation(), ClassDef::hasDocumentation(), PageDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), and FileDef::isLinkableInProject().
| bool Definition::hasUserDocumentation | ( | ) | const [virtual] |
Returns TRUE iff the definition is documented by the user.
Reimplemented in MemberDef.
Definition at line 915 of file definition.cpp.
References DefinitionImpl::brief, DefinitionImpl::details, BriefInfo::doc, DocInfo::doc, and makeResident().
Referenced by MemberDef::hasUserDocumentation().
| virtual bool Definition::isLinkableInProject | ( | ) | const [pure virtual] |
Returns TRUE iff it is possible to link to this item within this project.
Implemented in ClassDef, DirDef, FileDef, GroupDef, MemberDef, NamespaceDef, and PageDef.
Referenced by isVisibleInProject().
| virtual bool Definition::isLinkable | ( | ) | const [pure virtual] |
Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.
Implemented in ClassDef, DirDef, FileDef, GroupDef, MemberDef, NamespaceDef, and PageDef.
Referenced by DocSets::addIndexItem(), DocLink::DocLink(), DocRef::DocRef(), generateRef(), isVisible(), and writePathFragment().
| bool Definition::isVisibleInProject | ( | ) | const [virtual] |
Returns TRUE iff the name is part of this project and may appear in the output
Definition at line 1290 of file definition.cpp.
References DefinitionImpl::hidden, and isLinkableInProject().
| bool Definition::isVisible | ( | ) | const [virtual] |
Returns TRUE iff the name may appear in the output
Definition at line 1295 of file definition.cpp.
References DefinitionImpl::hidden, and isLinkable().
| bool Definition::isHidden | ( | ) | const |
Returns TRUE iff this item is supposed to be hidden from the output.
Definition at line 1284 of file definition.cpp.
References DefinitionImpl::hidden, and makeResident().
Referenced by GroupDef::addClass(), GroupDef::addDir(), GroupDef::addExample(), GroupDef::addFile(), GroupDef::addNamespace(), GroupDef::addPage(), DotClassGraph::DotClassGraph(), getResolvedClass(), ClassDef::hasNonReferenceSuperClass(), FileDef::insertClass(), NamespaceDef::insertMember(), GroupDef::insertMember(), FileDef::insertMember(), FileDef::insertNamespace(), ClassDef::insertTemplateInstance(), NamespaceDef::isLinkableInProject(), MemberDef::isLinkableInProject(), ClassDef::isLinkableInProject(), and setOuterScope().
| bool Definition::isArtificial | ( | ) | const |
returns TRUE if this entity was artificially introduced, for instance because it is used to show a template instantiation relation.
Definition at line 1300 of file definition.cpp.
References DefinitionImpl::isArtificial.
Referenced by NamespaceDef::isLinkableInProject(), ClassDef::isLinkableInProject(), ClassDef::isVisibleInHierarchy(), and FileDef::writeDocumentation().
| QCString Definition::getReference | ( | ) | const [virtual] |
If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict
Reimplemented in ClassDef, and MemberDef.
Definition at line 1305 of file definition.cpp.
References makeResident(), and DefinitionImpl::ref.
Referenced by addGroupListToTitle(), buildDirectories(), DotGroupCollaboration::buildGraph(), DocLink::DocLink(), DocRef::DocRef(), DotGroupCollaboration::DotGroupCollaboration(), DotInclDepGraph::DotInclDepGraph(), generateFileRef(), generateRef(), MemberDef::getReference(), ClassDef::getReference(), ClassDef::showUsedFiles(), writeAlphabeticalClassList(), NamespaceSDict::writeDeclaration(), writeDirTreeNode(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGroupIndexItem(), writeGroupTreeNode(), writeNamespaceIndex(), writePageIndex(), and writePathFragment().
| bool Definition::isReference | ( | ) | const [virtual] |
Returns TRUE if this definition is imported via a tag file.
Reimplemented in ClassDef.
Definition at line 1311 of file definition.cpp.
References makeResident(), and DefinitionImpl::ref.
Referenced by countGroups(), PageDef::documentedPage(), LatexGenerator::endIndexSection(), generateDEFForFile(), generateDEFForNamespace(), FileName::generateDiskNames(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateRef(), FileDef::generateSourceFile(), NamespaceDef::getOutputFileBase(), GroupDef::getOutputFileBase(), MemberDef::isDetailedSectionVisible(), PageDef::isLinkable(), NamespaceDef::isLinkable(), MemberDef::isLinkable(), FileDef::isLinkable(), DirDef::isLinkable(), PageDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), MemberDef::isLinkableInProject(), GroupDef::isLinkableInProject(), FileDef::isLinkableInProject(), DirDef::isLinkableInProject(), ClassDef::isReference(), linkifyText(), setAnchors(), LatexGenerator::startIndexSection(), PageDef::visibleInIndex(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), writeDirTreeNode(), GroupDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeFileIndex(), writeGroupTreeNode(), writeIndex(), and writePageIndex().
| int Definition::getStartBodyLine | ( | ) | const |
Returns the first line of the body of this item (applicable to classes and functions).
Definition at line 1317 of file definition.cpp.
References DefinitionImpl::body, makeResident(), and BodyInfo::startLine.
Referenced by MemberDef::createTemplateInstanceMember(), generateDEFForMember(), PerlModGenerator::generatePerlModForClass(), and ClassDef::writeDetailedDescription().
| int Definition::getEndBodyLine | ( | ) | const |
Returns the last line of the body of this item (applicable to classes and functions).
Definition at line 1323 of file definition.cpp.
References DefinitionImpl::body, BodyInfo::endLine, and makeResident().
Referenced by MemberDef::createTemplateInstanceMember(), and PerlModGenerator::generatePerlModForClass().
| FileDef * Definition::getBodyDef | ( | ) |
Returns the file in which the body of this item is located or 0 if no body is available.
Definition at line 1329 of file definition.cpp.
References DefinitionImpl::body, BodyInfo::fileDef, and makeResident().
Referenced by MemberDef::createTemplateInstanceMember(), generateDEFForMember(), getDefs(), MemberDef::writeDeclaration(), ClassDef::writeDetailedDescription(), and MemberDef::writeDocumentation().
| LockingPtr< GroupList > Definition::partOfGroups | ( | ) | const |
Definition at line 1335 of file definition.cpp.
References makeResident(), and DefinitionImpl::partOfGroups.
Referenced by addGroupListToTitle(), DotGroupCollaboration::buildGraph(), PageDef::getGroupDef(), and GroupDef::isASubGroup().
| LockingPtr< QList< ListItemInfo > > Definition::xrefListItems | ( | ) | const |
Definition at line 1120 of file definition.cpp.
References makeResident(), and DefinitionImpl::xrefListItems.
Referenced by MemberDef::addListReference(), NamespaceDef::addListReferences(), GroupDef::addListReferences(), FileDef::addListReferences(), ClassDef::addListReferences(), and mergeRefItems().
| Definition * Definition::findInnerCompound | ( | const char * | name | ) | [virtual] |
Reimplemented in ClassDef, and NamespaceDef.
Definition at line 972 of file definition.cpp.
Referenced by resolveTypeDef().
| Definition * Definition::getOuterScope | ( | ) | const [virtual] |
Definition at line 1341 of file definition.cpp.
References makeResident(), and DefinitionImpl::outerScope.
Referenced by accessibleViaUsingNamespace(), MemberDef::addListReference(), DotCallGraph::buildGraph(), DotCallGraph::DotCallGraph(), VhdlDocGen::findMember(), PerlModGenerator::generatePerlModForMember(), getDefs(), ClassDef::getTemplateParameterLists(), DocPara::handleInheritDoc(), GroupDef::insertMember(), ClassDef::insertTemplateInstance(), isAccessibleFrom(), isAccessibleFromWithExpScope(), newResolveTypedef(), qualifiedName(), ClassDef::qualifiedNameWithTemplateParameters(), resolveTypeDef(), PageDef::visibleInIndex(), MemberDef::writeDeclaration(), writeDirHierarchy(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), ClassDef::writeDocumentation(), and VhdlDocGen::writeVHDLDeclaration().
| LockingPtr< MemberSDict > Definition::getReferencesMembers | ( | ) | const |
Definition at line 1347 of file definition.cpp.
References makeResident(), and DefinitionImpl::sourceRefsDict.
Referenced by DotCallGraph::buildGraph(), and generateDEFForMember().
| LockingPtr< MemberSDict > Definition::getReferencedByMembers | ( | ) | const |
Definition at line 1353 of file definition.cpp.
References makeResident(), and DefinitionImpl::sourceRefByDict.
Referenced by DotCallGraph::buildGraph(), and generateDEFForMember().
| void Definition::setName | ( | const char * | name | ) |
Sets a new name for the definition
Definition at line 304 of file definition.cpp.
References DefinitionImpl::localName, makeResident(), and stripScope().
Referenced by VhdlDocGen::adjustRecordMember(), and FileName::generateDiskNames().
| void Definition::setDocumentation | ( | const char * | d, | |
| const char * | docFile, | |||
| int | docLine, | |||
| bool | stripWhiteSpace = TRUE | |||
| ) |
Sets the documentation of this definition to d.
Definition at line 439 of file definition.cpp.
References makeResident().
Referenced by ClassDef::addMembersToTemplateInstance(), addRelatedPage(), MemberGroup::distributeMemberGroupDocumentation(), VhdlDocGen::findFunction(), and PageDef::PageDef().
| void Definition::setBriefDescription | ( | const char * | b, | |
| const char * | briefFile, | |||
| int | briefLine | |||
| ) |
Sets the brief description of this definition to b. A dot is added to the sentence if not available.
Definition at line 490 of file definition.cpp.
References makeResident().
Referenced by ClassDef::addMembersToTemplateInstance(), MemberGroup::distributeMemberGroupDocumentation(), and VhdlDocGen::findFunction().
| void Definition::setReference | ( | const char * | r | ) |
Sets the tag file id via which this definition was imported.
Definition at line 1359 of file definition.cpp.
References makeResident(), and DefinitionImpl::ref.
Referenced by addRelatedPage(), ClassDef::ClassDef(), FileDef::FileDef(), NamespaceDef::NamespaceDef(), and MemberDef::setTagInfo().
| void Definition::addSectionsToDefinition | ( | QList< SectionInfo > * | anchorList | ) |
Add the list of anchors that mark the sections that are found in the documentation.
Definition at line 330 of file definition.cpp.
References SectionInfo::definition, SectionInfo::label, makeResident(), DefinitionImpl::sectionDict, and Doxygen::sectionDict.
| void Definition::setBodySegment | ( | int | bls, | |
| int | ble | |||
| ) |
Definition at line 728 of file definition.cpp.
References DefinitionImpl::body, BodyInfo::endLine, makeResident(), and BodyInfo::startLine.
Referenced by MemberDef::createTemplateInstanceMember().
| void Definition::setBodyDef | ( | FileDef * | fd | ) |
Definition at line 737 of file definition.cpp.
References DefinitionImpl::body, BodyInfo::fileDef, and makeResident().
Referenced by MemberDef::createTemplateInstanceMember().
| void Definition::addSourceReferencedBy | ( | MemberDef * | d | ) |
Definition at line 924 of file definition.cpp.
References SDict< T >::find(), MemberDef::getScopeString(), SDict< T >::inSort(), makeResident(), MemberDef::name, QCString, and DefinitionImpl::sourceRefByDict.
| void Definition::addSourceReferences | ( | MemberDef * | d | ) |
Definition at line 948 of file definition.cpp.
References SDict< T >::find(), MemberDef::getScopeString(), SDict< T >::inSort(), makeResident(), MemberDef::name, QCString, and DefinitionImpl::sourceRefsDict.
| void Definition::setRefItems | ( | const QList< ListItemInfo > * | sli | ) |
Definition at line 1058 of file definition.cpp.
References makeResident(), and DefinitionImpl::xrefListItems.
Referenced by addRelatedPage().
| void Definition::mergeRefItems | ( | Definition * | d | ) |
Definition at line 1078 of file definition.cpp.
References makeResident(), ListItemInfo::type, DefinitionImpl::xrefListItems, and xrefListItems().
| void Definition::addInnerCompound | ( | Definition * | d | ) | [virtual] |
Reimplemented in ClassDef, NamespaceDef, and PageDef.
Definition at line 977 of file definition.cpp.
References err().
| void Definition::setOuterScope | ( | Definition * | d | ) | [virtual] |
Definition at line 1034 of file definition.cpp.
References DefinitionImpl::hidden, isHidden(), makeResident(), DefinitionImpl::outerScope, and DefinitionImpl::qualifiedName.
Referenced by PageDef::addInnerCompound(), DirDef::addSubDir(), MemberDef::setMemberClass(), and MemberDef::setNamespace().
| void Definition::setHidden | ( | bool | b | ) |
Definition at line 1370 of file definition.cpp.
References DefinitionImpl::hidden, and makeResident().
| void Definition::setArtificial | ( | bool | b | ) |
Definition at line 1376 of file definition.cpp.
References DefinitionImpl::isArtificial, and makeResident().
| QCString Definition::convertNameToFile | ( | const char * | name, | |
| bool | allowDots = FALSE | |||
| ) | const |
Definition at line 1127 of file definition.cpp.
References convertNameToFile(), makeResident(), and DefinitionImpl::ref.
Referenced by ClassDef::getInstanceOutputFileBase(), NamespaceDef::getOutputFileBase(), GroupDef::getOutputFileBase(), FileDef::getOutputFileBase(), ClassDef::getOutputFileBase(), FileDef::getSourceFileBase(), ClassDef::getSourceFileBase(), and FileDef::includeName().
| void Definition::writeSourceDef | ( | OutputList & | ol, | |
| const char * | scopeName | |||
| ) |
Write a reference to the source code defining this definition
Definition at line 637 of file definition.cpp.
References DefinitionImpl::body, Config_getBool, OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enableAll(), OutputList::endParagraph(), err(), BodyInfo::fileDef, FileDef::getSourceFileBase(), OutputGenerator::Html, makeResident(), FileDef::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, BodyInfo::startLine, OutputList::startParagraph(), theTranslator, Translator::trDefinedAtLineInSourceFile(), Htags::useHtags, and OutputList::writeObjectLink().
Referenced by ClassDef::writeDetailedDescription(), and MemberDef::writeDocumentation().
| void Definition::writeInlineCode | ( | OutputList & | ol, | |
| const char * | scopeName | |||
| ) |
Write code of this definition into the documentation
Definition at line 745 of file definition.cpp.
References FileDef::absFilePath(), DefinitionImpl::body, Config_getBool, DefinitionImpl::defFileExt, DefinitionIntf::definitionType(), OutputList::endCodeFragment(), BodyInfo::endLine, BodyInfo::fileDef, ParserManager::getParser(), makeResident(), OutputList::newParagraph(), ParserInterface::parseCode(), Doxygen::parserManager, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, ParserInterface::resetCodeParserState(), OutputList::startCodeFragment(), BodyInfo::startLine, and DefinitionIntf::TypeMember.
Referenced by MemberDef::writeDocumentation().
| void Definition::writeSourceRefs | ( | OutputList & | ol, | |
| const char * | scopeName | |||
| ) |
Definition at line 891 of file definition.cpp.
References Config_getBool, makeResident(), DefinitionImpl::sourceRefsDict, theTranslator, and Translator::trReferences().
Referenced by MemberDef::writeDocumentation().
| void Definition::writeSourceReffedBy | ( | OutputList & | ol, | |
| const char * | scopeName | |||
| ) |
Definition at line 882 of file definition.cpp.
References Config_getBool, makeResident(), DefinitionImpl::sourceRefByDict, theTranslator, and Translator::trReferencedBy().
Referenced by MemberDef::writeDocumentation().
| void Definition::makePartOfGroup | ( | GroupDef * | gd | ) |
Definition at line 1051 of file definition.cpp.
References makeResident(), and DefinitionImpl::partOfGroups.
Referenced by addClassToGroups(), addDirToGroups(), addExampleToGroups(), addNamespaceToGroups(), and GroupDef::addPage().
| void Definition::writePathFragment | ( | OutputList & | ol | ) | const |
Definition at line 1140 of file definition.cpp.
References Config_getBool, DefinitionIntf::definitionType(), OutputList::docify(), OutputList::endBold(), getOutputFileBase(), getReference(), Doxygen::globalScope, isLinkable(), DefinitionImpl::localName, makeResident(), DefinitionImpl::outerScope, OutputList::startBold(), DefinitionIntf::TypeClass, DefinitionIntf::TypeGroup, DefinitionIntf::TypeNamespace, DefinitionIntf::TypePage, OutputList::writeObjectLink(), and writePathFragment().
Referenced by DirRelation::writeDocumentation(), writeNavigationPath(), and writePathFragment().
| void Definition::writeNavigationPath | ( | OutputList & | ol | ) | const |
Definition at line 1190 of file definition.cpp.
References OutputList::disableAllBut(), OutputGenerator::Html, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), writePathFragment(), and OutputList::writeString().
Referenced by PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberList::writeDocumentationPage(), and FileDef::writeSource().
| virtual void Definition::writeQuickMemberLinks | ( | OutputList & | , | |
| MemberDef * | ||||
| ) | const [inline, virtual] |
Reimplemented in ClassDef, FileDef, GroupDef, and NamespaceDef.
Definition at line 293 of file definition.h.
Referenced by MemberList::writeDocumentationPage().
| void Definition::writeDocAnchorsToTagFile | ( | ) |
Writes the documentation anchors of the definition to the Doxygen::tagFile stream.
Definition at line 359 of file definition.cpp.
References Config_getString, DefinitionIntf::definitionType(), SectionInfo::fileName, SectionInfo::generated, SectionInfo::label, makeResident(), DefinitionImpl::sectionDict, Doxygen::tagFile, and DefinitionIntf::TypeMember.
Referenced by MemberDef::writeDeclaration(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), and writeIndex().
| void Definition::setLocalName | ( | const QCString | name | ) | [protected] |
Definition at line 1382 of file definition.cpp.
References DefinitionImpl::localName, and makeResident().
Referenced by DirDef::DirDef().
| void Definition::flushToDisk | ( | ) | const [protected, virtual] |
Reimplemented in MemberDef.
Definition at line 1393 of file definition.cpp.
References DefinitionImpl::body, DefinitionImpl::brief, DefinitionImpl::defFileExt, DefinitionImpl::defFileName, DefinitionImpl::defLine, DefinitionImpl::details, DefinitionImpl::docSignatures, END_MARKER, DefinitionImpl::hidden, DefinitionImpl::isArtificial, DefinitionImpl::localName, m_impl, marshalBodyInfo(), marshalBool(), marshalBriefInfo(), marshalDocInfo(), marshalGroupList(), marshalInt(), marshalItemInfoList(), marshalMemberSDict(), marshalObjPointer(), marshalQCString(), marshalSectionDict(), marshalUInt(), DefinitionImpl::outerScope, DefinitionImpl::partOfGroups, DefinitionImpl::qualifiedName, DefinitionImpl::ref, DefinitionImpl::sectionDict, DefinitionImpl::sourceRefByDict, DefinitionImpl::sourceRefsDict, START_MARKER, Doxygen::symbolStorage, and DefinitionImpl::xrefListItems.
Referenced by MemberDef::flushToDisk().
| void Definition::loadFromDisk | ( | ) | const [protected, virtual] |
Reimplemented in MemberDef.
Definition at line 1422 of file definition.cpp.
References DefinitionImpl::body, DefinitionImpl::brief, DefinitionImpl::defFileExt, DefinitionImpl::defFileName, DefinitionImpl::defLine, DefinitionImpl::details, DefinitionImpl::docSignatures, END_MARKER, DefinitionImpl::hidden, DefinitionImpl::isArtificial, DefinitionImpl::localName, m_impl, DefinitionImpl::outerScope, DefinitionImpl::partOfGroups, DefinitionImpl::qualifiedName, DefinitionImpl::ref, DefinitionImpl::sectionDict, DefinitionImpl::sourceRefByDict, DefinitionImpl::sourceRefsDict, START_MARKER, Doxygen::symbolStorage, unmarshalBodyInfo(), unmarshalBool(), unmarshalBriefInfo(), unmarshalDocInfo(), unmarshalGroupList(), unmarshalInt(), unmarshalItemInfoList(), unmarshalMemberSDict(), unmarshalObjPointer(), unmarshalQCString(), unmarshalSectionDict(), unmarshalUInt(), and DefinitionImpl::xrefListItems.
Referenced by MemberDef::loadFromDisk().
| void Definition::makeResident | ( | ) | const [protected, virtual] |
Definition at line 1388 of file definition.cpp.
Referenced by addSectionsToDefinition(), addSourceReferencedBy(), addSourceReferences(), briefDescription(), briefDescriptionAsTooltip(), briefFile(), briefLine(), convertNameToFile(), docFile(), docLine(), documentation(), getBodyDef(), getDefFileExtension(), getDefFileName(), getDefLine(), getEndBodyLine(), getOuterScope(), getReference(), getReferencedByMembers(), getReferencesMembers(), getStartBodyLine(), hasDocumentation(), hasUserDocumentation(), isHidden(), isReference(), localName(), makePartOfGroup(), mergeRefItems(), partOfGroups(), qualifiedName(), setArtificial(), setBodyDef(), setBodySegment(), setBriefDescription(), setDocumentation(), setHidden(), setLocalName(), setName(), setOuterScope(), setReference(), setRefItems(), writeDocAnchorsToTagFile(), writeInlineCode(), writePathFragment(), writeSourceDef(), writeSourceReffedBy(), writeSourceRefs(), and xrefListItems().
| void Definition::lock | ( | ) | const [inline, protected, virtual] |
Called when the object is locked.
Implements LockableObj.
Definition at line 306 of file definition.h.
| void Definition::unlock | ( | ) | const [inline, protected, virtual] |
Called when the object is unlocked.
Implements LockableObj.
Definition at line 307 of file definition.h.
1.5.1