Doxygen
Public 成员函数 | 所有成员列表
ConceptDef类 参考abstract

#include <conceptdef.h>

+ 类 ConceptDef 继承关系图:
+ ConceptDef 的协作图:

Public 成员函数

virtual DefType definitionType () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual bool hasDetailedDescription () const =0
 
virtual QCString displayName (bool includeScope=true) const =0
 
virtual const IncludeInfo * includeInfo () const =0
 
virtual ArgumentList getTemplateParameterList () const =0
 
virtual QCString anchor () const =0
 
virtual bool isLinkableInProject () const =0
 
virtual bool isLinkable () const =0
 
virtual QCString initializer () const =0
 
virtual void writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const =0
 
virtual const NamespaceDef * getNamespaceDef () const =0
 
virtual const FileDef * getFileDef () const =0
 
virtual QCString title () const =0
 
- Public 成员函数 继承自 Definition
virtual CodeSymbolType codeSymbolType () const =0
 
virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () 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 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 const FileDef * getBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. 更多...
 
virtual const GroupList & partOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVector & xrefListItems () const =0
 
virtual const Definition * findInnerCompound (const QCString &name) const =0
 
virtual Definition * getOuterScope () const =0
 
virtual const MemberVector & getReferencesMembers () const =0
 
virtual const MemberVector & getReferencedByMembers () 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 更多...
 
virtual QCString id () const =0
 
virtual const SectionRefs & getSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef 更多...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
virtual ~Definition ()=default
 

额外继承的成员函数

- Public 类型 继承自 Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
}
 

详细描述

在文件 conceptdef.h 第 22 行定义.

成员函数说明

◆ anchor()

virtual QCString ConceptDef::anchor ( ) const
pure virtual

Returns the anchor within a page where this item can be found

实现了 Definition.

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::anchor(), linkifyText() , 以及 resolveLink().

◆ definitionType()

virtual DefType ConceptDef::definitionType ( ) const
pure virtual

Use this for dynamic inspection of the type of the derived class

实现了 Definition.

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

◆ displayName()

virtual QCString ConceptDef::displayName ( bool  includeScope = true) const
pure virtual

Returns the name of the definition as it appears in the output

实现了 Definition.

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::displayName().

◆ getFileDef()

virtual const FileDef* ConceptDef::getFileDef ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 generateXMLForConcept(), ConceptDefAliasImpl::getFileDef() , 以及 writeTemplateList().

◆ getNamespaceDef()

virtual const NamespaceDef* ConceptDef::getNamespaceDef ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::getNamespaceDef().

◆ getOutputFileBase()

virtual QCString ConceptDef::getOutputFileBase ( ) const
pure virtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

实现了 Definition.

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 generateXMLForConcept(), ConceptDefAliasImpl::getOutputFileBase() , 以及 linkifyText().

◆ getTemplateParameterList()

virtual ArgumentList ConceptDef::getTemplateParameterList ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 addTemplateList(), ConceptContext::Private::createTemplateDecls(), ConceptDefAliasImpl::getTemplateParameterList() , 以及 writeTemplateList().

◆ hasDetailedDescription()

virtual bool ConceptDef::hasDetailedDescription ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::hasDetailedDescription() , 以及 ConceptContext::Private::hasDetails().

◆ includeInfo()

virtual const IncludeInfo* ConceptDef::includeInfo ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptContext::Private::createIncludeInfo(), PerlModGenerator::generatePerlModForConcept(), generateXMLForConcept() , 以及 ConceptDefAliasImpl::includeInfo().

◆ initializer()

virtual QCString ConceptDef::initializer ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptContext::Private::createInitializer(), ConceptContext::Private::createInitializerAsCode(), PerlModGenerator::generatePerlModForConcept(), generateXMLForConcept() , 以及 ConceptDefAliasImpl::initializer().

◆ isLinkable()

virtual bool ConceptDef::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.

实现了 Definition.

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 NestingContext::Private::addConcept(), ConceptDefAliasImpl::isLinkable() , 以及 linkifyText().

◆ isLinkableInProject()

virtual bool ConceptDef::isLinkableInProject ( ) const
pure virtual

Returns TRUE iff it is possible to link to this item within this project.

实现了 Definition.

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 generateConceptDocs(), ConceptDefAliasImpl::isLinkableInProject(), linkifyText() , 以及 writeTagFile().

◆ title()

virtual QCString ConceptDef::title ( ) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::title() , 以及 ConceptContext::Private::title().

◆ writeDeclarationLink()

virtual void ConceptDef::writeDeclarationLink ( OutputList &  ol,
bool &  found,
const QCString &  header,
bool  localNames 
) const
pure virtual

在 ConceptDefAliasImpl , 以及 ConceptDefImpl 内被实现.

被这些函数引用 ConceptDefAliasImpl::writeDeclarationLink().

该类的文档由以下文件生成: