Doxygen
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ConceptDef Class Referenceabstract

#include <src/conceptdef.h>

+ Inheritance diagram for ConceptDef:
+ Collaboration diagram for ConceptDef:

Public Member Functions

virtual bool hasDetailedDescription () const =0
 
virtual const IncludeInfo * includeInfo () const =0
 
virtual ArgumentList getTemplateParameterList () 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 const ModuleDef * getModuleDef () const =0
 
virtual QCString title () const =0
 
virtual int groupId () const =0
 
- Public Member Functions inherited from Definition
virtual DefType definitionType () const =0
 
virtual CodeSymbolType codeSymbolType () const =0
 
virtual bool isAlias () const =0
 
virtual const QCString & name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString displayName (bool includeScope=TRUE) const =0
 
virtual const 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 bool isExported () 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
 

Additional Inherited Members

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

Detailed Description

Definition at line 26 of file conceptdef.h.

Member Function Documentation

◆ getFileDef()

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

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References getFileDef().

Referenced by findModuleDef(), generateXMLForConcept(), getFileDef(), ConceptDefAliasImpl::getFileDef(), writeTemplateList(), and writeTemplateList().

◆ getModuleDef()

virtual const ModuleDef * ConceptDef::getModuleDef ( ) const
pure virtual

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References getModuleDef().

Referenced by getModuleDef(), and ConceptDefAliasImpl::getModuleDef().

◆ getNamespaceDef()

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

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References getNamespaceDef().

Referenced by getNamespaceDef(), and ConceptDefAliasImpl::getNamespaceDef().

◆ getTemplateParameterList()

virtual ArgumentList ConceptDef::getTemplateParameterList ( ) const
pure virtual

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References getTemplateParameterList().

Referenced by addTemplateList(), getTemplateParameterList(), ConceptDefAliasImpl::getTemplateParameterList(), writeTemplateList(), and writeTemplateList().

◆ groupId()

virtual int ConceptDef::groupId ( ) const
pure virtual

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References groupId().

Referenced by groupId(), and ConceptDefAliasImpl::groupId().

◆ hasDetailedDescription()

virtual bool ConceptDef::hasDetailedDescription ( ) const
pure virtual

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References hasDetailedDescription().

Referenced by hasDetailedDescription(), and ConceptDefAliasImpl::hasDetailedDescription().

◆ includeInfo()

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

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References includeInfo().

Referenced by PerlModGenerator::generatePerlModForConcept(), generateXMLForConcept(), includeInfo(), and ConceptDefAliasImpl::includeInfo().

◆ initializer()

virtual QCString ConceptDef::initializer ( ) const
pure virtual

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References initializer().

Referenced by PerlModGenerator::generatePerlModForConcept(), generateXMLForConcept(), initializer(), and ConceptDefAliasImpl::initializer().

◆ title()

virtual QCString ConceptDef::title ( ) const
pure virtual

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References title().

Referenced by title(), and ConceptDefAliasImpl::title().

◆ writeDeclarationLink()

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

Implemented in ConceptDefAliasImpl, and ConceptDefImpl.

References found, and writeDeclarationLink().

Referenced by writeDeclarationLink(), and ConceptDefAliasImpl::writeDeclarationLink().

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