Doxygen
Loading...
Searching...
No Matches
ConceptDef Class Referenceabstract

#include <src/conceptdef.h>

Inheritance diagram for ConceptDef:
Collaboration diagram for ConceptDef:

Classes

struct  Part

Public Types

enum class  PartType { Code , Doc }
using Parts = std::vector<Part>
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
}

Public Member Functions

virtual bool hasDetailedDescription () const =0
virtual const IncludeInfoincludeInfo () const =0
virtual ArgumentList getTemplateParameterList () const =0
virtual DString initializer () const =0
virtual void writeDeclarationLink (OutputList &ol, bool &found, const DString &header, bool localNames) const =0
virtual const NamespaceDefgetNamespaceDef () const =0
virtual const FileDefgetFileDef () const =0
virtual const ModuleDefgetModuleDef () const =0
virtual DString title () const =0
virtual int groupId () const =0
virtual Parts conceptParts () 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 DStringname () const =0
virtual bool isAnonymous () const =0
virtual DString displayName (bool includeScope=true) const =0
virtual const DStringlocalName () const =0
virtual DString qualifiedName () const =0
virtual DString symbolName () const =0
virtual DString getOutputFileBase () const =0
virtual DString anchor () const =0
virtual DString getSourceFileBase () const =0
virtual DString getSourceAnchor () const =0
virtual DString documentation () const =0
virtual int docLine () const =0
virtual DString docFile () const =0
virtual DString briefDescription (bool abbreviate=false) const =0
virtual DString briefDescriptionAsTooltip () const =0
virtual int briefLine () const =0
virtual DString briefFile () const =0
virtual DString inbodyDocumentation () const =0
virtual DString inbodyFile () const =0
virtual int inbodyLine () const =0
virtual DString getDefFileName () const =0
virtual DString 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 DString getReference () const =0
virtual bool isReference () const =0
virtual DString externalReference (const DString &relPath) const =0
virtual int getStartDefLine () const =0
virtual int getStartBodyLine () const =0
virtual int getEndBodyLine () const =0
virtual const FileDefgetBodyDef () const =0
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in.
virtual const GroupListpartOfGroups () const =0
virtual bool isLinkableViaGroup () const =0
virtual const RefItemVectorxrefListItems () const =0
virtual const RequirementRefsrequirementReferences () const =0
virtual const DefinitionfindInnerCompound (const DString &name) const =0
virtual DefinitiongetOuterScope () const =0
virtual const MemberVectorgetReferencesMembers () const =0
virtual const MemberVectorgetReferencedByMembers () 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 DString id () const =0
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef
virtual DString navigationPathAsString () const =0
virtual DString pathFragment () const =0
virtual void _setSymbolName (const DString &name)=0
virtual DString _symbolName () const =0

Detailed Description

Definition at line 26 of file conceptdef.h.

Member Typedef Documentation

◆ Parts

using ConceptDef::Parts = std::vector<Part>

Definition at line 40 of file conceptdef.h.

Member Enumeration Documentation

◆ PartType

enum class ConceptDef::PartType
strong
Enumerator
Code 
Doc 

Definition at line 31 of file conceptdef.h.

31{ Code, Doc };

Member Function Documentation

◆ conceptParts()

virtual Parts ConceptDef::conceptParts ( ) const
pure virtual

◆ getFileDef()

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

◆ getModuleDef()

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

◆ getNamespaceDef()

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

◆ getTemplateParameterList()

virtual ArgumentList ConceptDef::getTemplateParameterList ( ) const
pure virtual

◆ groupId()

virtual int ConceptDef::groupId ( ) const
pure virtual

◆ hasDetailedDescription()

virtual bool ConceptDef::hasDetailedDescription ( ) const
pure virtual

◆ includeInfo()

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

◆ initializer()

virtual DString ConceptDef::initializer ( ) const
pure virtual

◆ title()

virtual DString ConceptDef::title ( ) const
pure virtual

◆ writeDeclarationLink()

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

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