doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Definition Class Referenceabstract

The common base class of all entity definitions found in the sources. More...

#include <definition.h>

+ Inheritance diagram for Definition:
+ Collaboration diagram for Definition:

Classes

struct  Cookie
 

Public Member Functions

virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString displayName (bool includeScope=TRUE) const =0
 
virtual QCString localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () const =0
 
virtual QCString getSourceFileBase () const =0
 
virtual QCString getSourceAnchor () const =0
 
virtual QCString documentation () const =0
 
virtual int docLine () const =0
 
virtual QCString docFile () const =0
 
virtual QCString briefDescription (bool abbreviate=FALSE) const =0
 
virtual QCString briefDescriptionAsTooltip () const =0
 
virtual int briefLine () const =0
 
virtual QCString inbodyDocumentation () const =0
 
virtual QCString inbodyFile () const =0
 
virtual int inbodyLine () const =0
 
virtual QCString briefFile () const =0
 
virtual QCString getDefFileName () const =0
 
virtual QCString getDefFileExtension () const =0
 
virtual int getDefLine () const =0
 
virtual int getDefColumn () const =0
 
virtual bool hasDocumentation () const =0
 
virtual bool hasUserDocumentation () const =0
 
virtual bool isLinkableInProject () const =0
 
virtual bool isLinkable () const =0
 
virtual bool isVisibleInProject () const =0
 
virtual bool isVisible () const =0
 
virtual bool isHidden () const =0
 
virtual bool isArtificial () const =0
 
virtual QCString getReference () const =0
 
virtual bool isReference () const =0
 
virtual QCString externalReference (const QCString &relPath) const =0
 
virtual int getStartDefLine () const =0
 
virtual int getStartBodyLine () const =0
 
virtual int getEndBodyLine () const =0
 
virtual FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const std::vector< RefItem * > & xrefListItems () const =0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () const =0
 
virtual bool hasSections () const =0
 
virtual bool hasSources () const =0
 
virtual bool hasBriefDescription () const =0
 returns TRUE if this class has a brief description More...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef More...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const std::vector< RefItem * > &sli)=0
 
virtual void setOuterScope (Definition *d)=0
 
virtual void setHidden (bool b)=0
 
virtual void setArtificial (bool b)=0
 
virtual void setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString name)=0
 
virtual void makePartOfGroup (GroupDef *gd)=0
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (const Definition *d)=0
 
virtual void addSectionsToIndex ()=0
 
virtual void writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
 
virtual void writeSummaryLinks (OutputList &) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
- Public Member Functions inherited from DefinitionIntf
 DefinitionIntf ()
 
virtual ~DefinitionIntf ()
 
virtual DefType definitionType () const =0
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

Detailed Description

The common base class of all entity definitions found in the sources.

This can be a class or a member function, or a file, or a namespace, etc. Use definitionType() to find which type of definition this is.

Definition at line 99 of file definition.h.

Member Function Documentation

◆ _setSymbolName()

virtual void Definition::_setSymbolName ( const QCString name)
pure virtual

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by addToMap().

◆ _symbolName()

virtual QCString Definition::_symbolName ( ) const
pure virtual

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by removeFromMap().

◆ addInnerCompound()

◆ addSectionsToDefinition()

virtual void Definition::addSectionsToDefinition ( const std::vector< const SectionInfo * > &  anchorList)
pure virtual

◆ addSectionsToIndex()

virtual void Definition::addSectionsToIndex ( )
pure virtual

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by writeGroupTreeNode(), and writePages().

◆ addSourceReferencedBy()

virtual void Definition::addSourceReferencedBy ( const MemberDef d)
pure virtual

◆ addSourceReferences()

virtual void Definition::addSourceReferences ( const MemberDef d)
pure virtual

◆ anchor()

◆ briefDescription()

◆ briefDescriptionAsTooltip()

◆ briefFile()

◆ briefLine()

◆ cookie()

◆ displayName()

◆ docFile()

◆ docLine()

◆ documentation()

◆ externalReference()

virtual QCString Definition::externalReference ( const QCString relPath) const
pure virtual

◆ findInnerCompound()

◆ getBodyDef()

◆ getDefColumn()

virtual int Definition::getDefColumn ( ) const
pure virtual

◆ getDefFileExtension()

virtual QCString Definition::getDefFileExtension ( ) const
pure virtual

◆ getDefFileName()

◆ getDefLine()

◆ getEndBodyLine()

◆ getLanguage()

virtual SrcLangExt Definition::getLanguage ( ) const
pure virtual

Returns the programming language this definition was written in.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by accessibleViaUsingNamespace(), ClassListContext::Private::addClasses(), NestingNodeContext::Private::addClasses(), NestingContext::Private::addClasses(), NestingContext::Private::addClassHierarchy(), DotGfxHierarchyTable::addClassList(), NestingContext::Private::addDerivedClasses(), DocSets::addIndexItem(), ClassContext::Private::additionalInheritedMembers(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), DotCallGraph::buildGraph(), buildNamespaceList(), checkArgumentName(), checkUnOrMultipleDocumentedParams(), classHasVisibleChildren(), combineDeclarationAndDefinition(), compoundIcon(), computeTemplateClassRelations(), createTagLessInstance(), NamespaceContext::Private::detailedFunctions(), FileContext::Private::detailedFunctions(), ModuleContext::Private::detailedFunctions(), DocRef::DocRef(), DotCallGraph::DotCallGraph(), findClassWithinClassContext(), findScopeFromQualifiedName(), findUsedClassesForClass(), findUsingDirectives(), NamespaceContext::Private::functions(), FileContext::Private::functions(), ModuleContext::Private::functions(), generateDEFForMember(), generateLink(), FTVHelp::generateTree(), generateXMLForClass(), generateXMLForFile(), generateXMLForNamespace(), getDefs(), DefinitionAliasImpl::getLanguage(), getResolvedClass(), getResolvedClassRec(), MemberContext::Private::handleNameWithContextFor(), ClassContext::Private::includeInfo(), FileContext::Private::includeList(), MemberDefImpl::IMPL::init(), DefinitionContext< FileContext::Private >::language(), linkifyText(), ClassIndexContext::Private::list(), parseCode(), ClassContext::Private::publicMethods(), ClassContext::Private::publicStaticMethods(), resolveClassNestingRelations(), SymbolContext::Private::scope(), SearchIndex::setCurrentDoc(), GroupDefImpl::updateLanguage(), validatingParseDoc(), MemberDefImpl::warnIfUndocumented(), writeAlphabeticalClassList(), writeAnnotatedClassList(), DotNode::writeBox(), writeClassTree(), writeClassTreeForList(), NamespaceSDict::writeDeclaration(), writeDefArgumentList(), FileDefImpl::writeIncludeFiles(), writeJavaScriptSearchIndex(), ClassDefImpl::writeMemberList(), writeMemberReference(), writeNamespaceIndex(), writeNamespaceTree(), MemberList::writeTagFile(), and FileDefImpl::writeTagFile().

◆ getOuterScope()

virtual Definition* Definition::getOuterScope ( ) const
pure virtual

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by accessibleViaUsingNamespace(), NestingContext::Private::addClasses(), NestingContext::Private::addDirs(), addMemberDocs(), addMembersToIndex(), NestingContext::Private::addNamespaces(), NestingContext::Private::addPages(), ClassContext::Private::addTemplateDecls(), DotCallGraph::buildGraph(), buildNamespaceList(), checkPageRelations(), combineDeclarationAndDefinition(), createLinkedText(), createTagLessInstance(), DotCallGraph::DotCallGraph(), dumpSymbol(), DefinitionContext< FileContext::Private >::fillPath(), findFriends(), VhdlDocGen::findMember(), findTagLessClasses(), findUsingDirectives(), generateClassList(), PerlModGenerator::generatePerlModForMember(), generateXMLForMember(), getResolvedSymbol(), MemberDefImpl::getSectionList(), ClassDefImpl::getTemplateParameterLists(), DocPara::handleInheritDoc(), GroupDefImpl::insertMember(), isAccessibleFrom(), isAccessibleFromWithExpScope(), MemberContext::Private::labels(), XRefDummyCodeGenerator::linkableSymbol(), linkifyText(), ClassDefImpl::mergeMembers(), DefinitionContext< FileContext::Private >::navigationPath(), newResolveTypedef(), resolveClassNestingRelations(), resolveRef(), resolveTypeDef(), SymbolContext::Private::scope(), scopeIsTemplate(), searchTemplateSpecs(), DefinitionImpl::setOuterScope(), MemberDefImpl::setSectionList(), transferFunctionReferences(), writeClassTree(), writeDirHierarchy(), writeIndex(), writeJavaScriptSearchIndex(), writeNamespaceTree(), writePageIndex(), and VhdlDocGen::writeVHDLDeclaration().

◆ getOutputFileBase()

◆ getReference()

◆ getReferencedByMembers()

◆ getReferencesMembers()

◆ getSectionRefs()

virtual const SectionRefs& Definition::getSectionRefs ( ) const
pure virtual

returns the section dictionary, only of importance for pagedef

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by generateXMLForPage(), and DefinitionAliasImpl::getSectionRefs().

◆ getSourceAnchor()

virtual QCString Definition::getSourceAnchor ( ) const
pure virtual

◆ getSourceFileBase()

◆ getStartBodyLine()

◆ getStartDefLine()

virtual int Definition::getStartDefLine ( ) const
pure virtual

Returns the first line of the implementation of this item. See also getDefLine()

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by addSourceReferences(), and DefinitionAliasImpl::getStartDefLine().

◆ hasBriefDescription()

virtual bool Definition::hasBriefDescription ( ) const
pure virtual

◆ hasDocumentation()

◆ hasSections()

virtual bool Definition::hasSections ( ) const
pure virtual

◆ hasSources()

virtual bool Definition::hasSources ( ) const
pure virtual

◆ hasUserDocumentation()

virtual bool Definition::hasUserDocumentation ( ) const
pure virtual

Returns TRUE iff the definition is documented by the user.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by DefinitionAliasImpl::hasUserDocumentation().

◆ id()

virtual QCString Definition::id ( ) const
pure virtual

◆ inbodyDocumentation()

◆ inbodyFile()

◆ inbodyLine()

◆ isAlias()

virtual bool Definition::isAlias ( ) const
pure virtual

◆ isAnonymous()

◆ isArtificial()

virtual bool Definition::isArtificial ( ) const
pure virtual

returns TRUE if this entity was artificially introduced, for instance because it is used to show a template instantiation relation.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by generateXMLForClass(), DefinitionAliasImpl::isArtificial(), AllMembersListContext::Private::Private(), and ClassDefImpl::writeMemberList().

◆ isHidden()

◆ isLinkable()

◆ isLinkableInProject()

◆ isLinkableViaGroup()

virtual bool Definition::isLinkableViaGroup ( ) const
pure virtual

◆ isReference()

virtual bool Definition::isReference ( ) const
pure virtual

◆ isVisible()

virtual bool Definition::isVisible ( ) const
pure virtual

◆ isVisibleInProject()

virtual bool Definition::isVisibleInProject ( ) const
pure virtual

Returns TRUE iff the name is part of this project and may appear in the output

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by DefinitionAliasImpl::isVisibleInProject().

◆ localName()

◆ makePartOfGroup()

◆ mergeRefItems()

virtual void Definition::mergeRefItems ( Definition d)
pure virtual

◆ name()

virtual QCString Definition::name ( ) const
pure virtual

Returns the name of the definition

Implemented in FileDef, DefinitionAliasImpl, FileDefImpl, and DefinitionImpl.

Referenced by MemberDefImpl::_writeEnumValues(), DefinitionImpl::_writeSourceRefList(), accessibleViaUsingNamespace(), DotClassGraph::addClass(), GroupDefImpl::addClass(), DotGfxHierarchyTable::addClassList(), addClassMemberNameToIndex(), addClassToContext(), DotGroupCollaboration::addCollaborationMember(), GroupDefImpl::addExample(), addFileMemberNameToIndex(), addGlobalFunction(), addGroupToGroups(), DotGfxHierarchyTable::addHierarchy(), Qhp::addIndexItem(), DocSets::addIndexItem(), HtmlHelp::addIndexItem(), PageDefImpl::addInnerCompound(), addInstance(), PerlModGenerator::addListOfAllMembers(), MemberDefImpl::addListReference(), addMemberDocs(), addMemberFunction(), addMembersToIndex(), addMemberToGroups(), addMemberToSearchIndex(), GroupDefImpl::addNamespace(), addNamespaceMemberNameToIndex(), addOverloaded(), GroupDefImpl::addPage(), addPageToContext(), addRelatedPage(), DefinitionImpl::addSourceReferencedBy(), DefinitionImpl::addSourceReferences(), addTemplateList(), ClassDefImpl::addUsedByClass(), ClassDefImpl::addUsedClass(), addVariableToFile(), FlowChart::alignFuncProc(), buildDirectories(), buildExampleList(), buildFunctionList(), DotCallGraph::buildGraph(), DotGroupCollaboration::buildGraph(), DefinitionContext< T >::Cachable< ClassContext::Private >::Cachable(), checkArgumentName(), checkOverrideArg(), checkPageRelations(), classInformation(), classInheritedProtectionLevel(), cModule(), MemberNameInfo::compareValues(), PageSDict::compareValues(), MemberList::compareValues(), NamespaceList::compareValues(), MemberSDict::compareValues(), MemberIndexList::compareValues(), NamespaceSDict::compareValues(), DefinitionList::compareValues(), BaseClassList::compareValues(), compItems(), computeCommonDirPrefix(), computePageRelations(), computeTemplateClassRelations(), FlowChart::convertNameToFileName(), VhdlDocGen::correctMemberProperties(), MemberList::countDecMembers(), MemberList::countEnumValues(), createJavaScriptSearchIndex(), createTagLessInstance(), DefinitionAliasImpl::DefinitionAliasImpl(), DotCallGraph::DotCallGraph(), DotGroupCollaboration::DotGroupCollaboration(), dumpSymbol(), PageContext::Private::example(), extractNamespaceName(), VhdlDocGen::findAllPackages(), VhdlDocGen::findArchitecture(), findClassRelation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), VhdlDocGen::findFunction(), findGlobalMember(), findGroupScope(), findMainPage(), VhdlDocGen::findMember(), findMember(), VhdlDocGen::findMemberDef(), findMemFlow(), findScopeFromQualifiedName(), findTagLessClasses(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsedNamespace(), findUsingDeclarations(), VhdlDocGen::findVhdlClass(), functionSignature(), generateClassList(), generateDEFForClass(), generateDEFForMember(), generateDEFForNamespace(), generateExampleDocs(), generateNamespaceClassDocs(), generateNamespaceDocs(), generatePageDocs(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForGroup(), PerlModGenerator::generatePerlModForMember(), PerlModGenerator::generatePerlModForNamespace(), PerlModGenerator::generatePerlModForPage(), generateXML(), generateXMLForClass(), generateXMLForDir(), generateXMLForGroup(), generateXMLForMember(), generateXMLForNamespace(), generateXMLForPage(), getCanonicalTypeForIdentifier(), MemberDefImpl::getClassDefOfAnonymousType(), VhdlDocGen::getClassName(), getDefs(), getResolvedClassRec(), DocPara::handleInheritDoc(), MemberContext::Private::handleNameWithContextFor(), MemberDefImpl::IMPL::init(), MemberContext::Private::initializerAsCode(), NamespaceDefImpl::insertClass(), FileDefImpl::insertClass(), NamespaceDefImpl::insertMember(), GroupDefImpl::insertMember(), FileDefImpl::insertMember(), NamespaceDefImpl::insertNamespace(), FileDefImpl::insertNamespace(), ClassDefImpl::internalInsertMember(), isAccessibleFromWithExpScope(), ClassDefImpl::isBaseClass(), isStandardFunc(), ClassDefImpl::isSubClass(), VhdlDocGen::isSubClass(), DiagramItem::label(), XRefDummyCodeGenerator::linkableSymbol(), linkifyText(), listSymbol(), lookupSymbol(), mergeCategories(), ClassDefImpl::mergeMembers(), minClassDistance(), DefinitionAliasImpl::name(), normalizeNonTemplateArgumentsInString(), MemberDefImpl::objCMethodName(), DocXRefItem::parse(), processTagLessClasses(), DefinitionImpl::qualifiedName(), MemberDefImpl::qualifiedName(), referenceTo(), GroupDefImpl::removeMember(), resolveClassNestingRelations(), resolveLink(), MemberList::setAnonymousEnumType(), SearchIndex::setCurrentDoc(), MemberContext::Private::sourceCode(), PageContext::Private::title(), transferFunctionReferences(), trimBaseClassScope(), validatingParseDoc(), HtmlDocVisitor::visitPre(), MemberDefImpl::warnIfUndocumented(), writeAlphabeticalClassList(), writeBoxMemberList(), NamespaceDefImpl::writeClassesToTagFile(), FileDefImpl::writeClassesToTagFile(), writeClassToDot(), writeClassTree(), writeColumn(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), writeDirTreeNode(), MemberList::writeDocumentation(), MemberDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationForInnerClasses(), MemberList::writeDocumentationPage(), MemberDefImpl::writeEnumDeclaration(), writeExampleIndex(), writeExceptionListImpl(), writeGroupTreeNode(), ClassDefImpl::writeIncludeFilesForSlice(), writeIndex(), writeInnerClasses(), writeInnerNamespaces(), writeInnerPages(), writeJavaScriptSearchIndex(), writeLink(), writeListOfAllMembers(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeMemberList(), writeMemberReference(), VhdlDocGen::writeOverview(), PageDefImpl::writePageDocumentation(), GroupDefImpl::writePageDocumentation(), DocbookGenerator::writePageLink(), writePages(), MemberList::writePlainDeclarations(), VhdlDocGen::writePlainVHDLDeclarations(), ClassDefImpl::writeQuickMemberLinks(), VhdlDocGen::writeRecordUnit(), VhdlDocGen::writeStringLink(), NamespaceDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), VhdlDocGen::writeTagFile(), ClassDefImpl::writeTagFile(), MemberDefImpl::writeTagFile(), DocSets::writeToken(), writeUCFLink(), VhdlDocGen::writeVHDLDeclaration(), writeVhdlEntityToolTip(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ navigationPathAsString()

virtual QCString Definition::navigationPathAsString ( ) const
pure virtual

◆ partOfGroups()

◆ pathFragment()

virtual QCString Definition::pathFragment ( ) const
pure virtual

◆ qualifiedName()

◆ setArtificial()

◆ setBodyDef()

◆ setBodySegment()

◆ setBriefDescription()

virtual void Definition::setBriefDescription ( const char *  b,
const char *  briefFile,
int  briefLine 
)
pure virtual

◆ setCookie()

◆ setDefFile()

virtual void Definition::setDefFile ( const QCString df,
int  defLine,
int  defColumn 
)
pure virtual

Set a new file name and position

Implemented in DefinitionImpl, and DefinitionAliasImpl.

◆ setDocumentation()

virtual void Definition::setDocumentation ( const char *  d,
const char *  docFile,
int  docLine,
bool  stripWhiteSpace = TRUE 
)
pure virtual

◆ setHidden()

◆ setId()

virtual void Definition::setId ( const char *  name)
pure virtual

Sets a unique id for the symbol. Used for libclang integration.

Implemented in DefinitionImpl, and DefinitionAliasImpl.

Referenced by addClassToContext(), buildNamespaceList(), findUsingDeclImports(), and findUsingDirectives().

◆ setInbodyDocumentation()

virtual void Definition::setInbodyDocumentation ( const char *  d,
const char *  docFile,
int  docLine 
)
pure virtual

Set the documentation that was found inside the body of an item. If there was already some documentation set, the new documentation will be appended.

Implemented in MemberDef, MemberDefAliasImpl, MemberDefImpl, DefinitionImpl, and DefinitionAliasImpl.

Referenced by buildGroupListFiltered().

◆ setLanguage()

◆ setLocalName()

virtual void Definition::setLocalName ( const QCString  name)
pure virtual

Implemented in DefinitionAliasImpl, and DefinitionImpl.

◆ setName()

virtual void Definition::setName ( const char *  name)
pure virtual

Sets a new name for the definition

Implemented in ClassDef, ClassDefImpl, DefinitionImpl, ClassDefAliasImpl, and DefinitionAliasImpl.

Referenced by buildNamespaceList(), and VhdlDocGen::correctMemberProperties().

◆ setOuterScope()

◆ setReference()

virtual void Definition::setReference ( const char *  r)
pure virtual

Sets the tag file id via which this definition was imported.

Implemented in DefinitionImpl, and DefinitionAliasImpl.

Referenced by addRelatedPage(), buildGroupListFiltered(), and buildNamespaceList().

◆ setRefItems()

◆ symbolName()

virtual QCString Definition::symbolName ( ) const
pure virtual

Returns the name of this definition as it appears in the symbol map.

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by VhdlDocGen::findMemberDef(), and DefinitionAliasImpl::symbolName().

◆ writeDocAnchorsToTagFile()

virtual void Definition::writeDocAnchorsToTagFile ( FTextStream ) const
pure virtual

Implemented in DefinitionAliasImpl, and DefinitionImpl.

Referenced by VhdlDocGen::writeTagFile().

◆ writeInlineCode()

virtual void Definition::writeInlineCode ( OutputList ol,
const char *  scopeName 
) const
pure virtual

Implemented in DefinitionImpl, and DefinitionAliasImpl.

◆ writeNavigationPath()

◆ writeQuickMemberLinks()

virtual void Definition::writeQuickMemberLinks ( OutputList ,
const MemberDef  
) const
pure virtual

◆ writeSourceDef()

virtual void Definition::writeSourceDef ( OutputList ol,
const char *  scopeName 
) const
pure virtual

Implemented in DefinitionImpl, and DefinitionAliasImpl.

Referenced by VhdlDocGen::writeSource().

◆ writeSourceReffedBy()

virtual void Definition::writeSourceReffedBy ( OutputList ol,
const char *  scopeName 
) const
pure virtual

Implemented in DefinitionImpl, and DefinitionAliasImpl.

Referenced by VhdlDocGen::writeSource().

◆ writeSourceRefs()

virtual void Definition::writeSourceRefs ( OutputList ol,
const char *  scopeName 
) const
pure virtual

Implemented in DefinitionImpl, and DefinitionAliasImpl.

Referenced by VhdlDocGen::writeSource().

◆ writeSummaryLinks()

virtual void Definition::writeSummaryLinks ( OutputList ) const
pure virtual

◆ writeToc()

virtual void Definition::writeToc ( OutputList ol,
const LocalToc lt 
) const
pure virtual

Implemented in DefinitionImpl, and DefinitionAliasImpl.

Referenced by writeIndex().

◆ xrefListItems()

virtual const std::vector<RefItem*>& Definition::xrefListItems ( ) const
pure virtual

The documentation for this class was generated from the following file: