doxygen
Public Member Functions | List of all members
ConceptDefImpl Class Reference
Inheritance diagram for ConceptDefImpl:
Inheritance graph
[legend]
Collaboration diagram for ConceptDefImpl:
Collaboration graph
[legend]

Public Member Functions

 ConceptDefImpl (const QCString &fileName, int startLine, int startColumn, const QCString &name, const QCString &tagRef=QCString(), const QCString &tagFile=QCString())
 
ConceptDefresolveAlias ()
 
DefType definitionType () const override
 
CodeSymbolType codeSymbolType () const override
 
QCString getOutputFileBase () const override
 
bool hasDetailedDescription () const override
 
QCString displayName (bool includeScope=true) const override
 
const IncludeInfoincludeInfo () const override
 
ArgumentList getTemplateParameterList () const override
 
QCString anchor () const override
 
bool isLinkableInProject () const override
 
bool isLinkable () const override
 
QCString initializer () const override
 
void writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const override
 
const NamespaceDefgetNamespaceDef () const override
 
const FileDefgetFileDef () const override
 
const ModuleDefgetModuleDef () const override
 
QCString title () const override
 
int groupId () const override
 
void setIncludeFile (FileDef *fd, const QCString &incName, bool local, bool force) override
 
void setTemplateArguments (const ArgumentList &al) override
 
void setNamespace (NamespaceDef *nd) override
 
void setFileDef (FileDef *fd) override
 
void setModuleDef (ModuleDef *mod) override
 
void writeTagFile (TextStream &) override
 
void writeDocumentation (OutputList &) override
 
void setInitializer (const QCString &init) override
 
void findSectionsInDocumentation () override
 
void setGroupId (int id) override
 
void writeBriefDescription (OutputList &) const
 
void writeAuthorSection (OutputList &ol) const
 
void writeIncludeFiles (OutputList &ol) const
 
void writeDetailedDescription (OutputList &ol, const QCString &title) const
 
void writeDefinition (OutputList &ol, const QCString &title) const
 
void addConceptAttributes (OutputList &ol) const
 
- Public Member Functions inherited from DefinitionMixin< ConceptDefMutable >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
 
bool isAlias () const override
 
const QCStringname () const override
 
bool isAnonymous () const override
 
const QCStringlocalName () const override
 
QCString qualifiedName () const override
 
QCString symbolName () const override
 
QCString getSourceFileBase () const override
 
QCString getSourceAnchor () const override
 
QCString documentation () const override
 
int docLine () const override
 
QCString docFile () const override
 
QCString briefDescription (bool abbreviate=FALSE) const override
 
QCString briefDescriptionAsTooltip () const override
 
int briefLine () const override
 
QCString inbodyDocumentation () const override
 
QCString inbodyFile () const override
 
int inbodyLine () const override
 
QCString briefFile () const override
 
QCString getDefFileName () const override
 
QCString getDefFileExtension () const override
 
int getDefLine () const override
 
int getDefColumn () const override
 
bool hasDocumentation () const override
 
bool hasUserDocumentation () const override
 
bool isVisibleInProject () const override
 
bool isVisible () const override
 
bool isHidden () const override
 
bool isArtificial () const override
 
bool isExported () const override
 
QCString getReference () const override
 
bool isReference () const override
 
QCString externalReference (const QCString &relPath) const override
 
int getStartDefLine () const override
 
int getStartBodyLine () const override
 
int getEndBodyLine () const override
 
const FileDefgetBodyDef () const override
 
SrcLangExt getLanguage () const override
 
const GroupListpartOfGroups () const override
 
bool isLinkableViaGroup () const override
 
const RefItemVector & xrefListItems () const override
 
const DefinitionfindInnerCompound (const QCString &name) const override
 
DefinitiongetOuterScope () const override
 
const MemberVectorgetReferencesMembers () const override
 
const MemberVectorgetReferencedByMembers () const override
 
bool hasSections () const override
 
bool hasSources () const override
 
bool hasBriefDescription () const override
 
QCString id () const override
 
const SectionRefsgetSectionRefs () const override
 
void setName (const QCString &name) override
 
void setId (const QCString &name) override
 
void setDefFile (const QCString &df, int defLine, int defColumn) override
 
void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
 
void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override
 
void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override
 
void setReference (const QCString &r) override
 
void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
 
void setBodySegment (int defLine, int bls, int ble) override
 
void setBodyDef (const FileDef *fd) override
 
void addSourceReferencedBy (MemberDef *md) override
 
void addSourceReferences (MemberDef *md) override
 
void setRefItems (const RefItemVector &sli) override
 
void mergeRefItems (Definition *def) override
 
void mergeReferences (const Definition *other) override
 
void mergeReferencedBy (const Definition *other) override
 
void addInnerCompound (Definition *def) override
 
void setOuterScope (Definition *def) override
 
void setHidden (bool b) override
 
void setArtificial (bool b) override
 
void setExported (bool b) override
 
void setLanguage (SrcLangExt lang) override
 
void writeSourceDef (OutputList &ol, const QCString &scopeName) const override
 
void writeInlineCode (OutputList &ol, const QCString &scopeName) const override
 
bool hasSourceRefs () const override
 
bool hasSourceReffedBy () const override
 
void writeSourceRefs (OutputList &ol, const QCString &scopeName) const override
 
void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override
 
void makePartOfGroup (GroupDef *gd) override
 
void writeNavigationPath (OutputList &ol) const override
 
QCString navigationPathAsString () const override
 
void writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
 
void writeSummaryLinks (OutputList &ol) const override
 
QCString pathFragment () const override
 
void writeDocAnchorsToTagFile (TextStream &fs) const override
 
void setLocalName (const QCString &name) override
 
void addSectionsToIndex () override
 
void writeToc (OutputList &ol, const LocalToc &lt) const override
 
void computeTooltip () override
 
void _setSymbolName (const QCString &name) override
 
QCString _symbolName () const override
 

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
}
 
- Protected Member Functions inherited from DefinitionMixin< ConceptDefMutable >
 DefinitionMixin (const DefinitionMixin &def)=default
 

Member Function Documentation

◆ anchor()

QCString ConceptDefImpl::anchor ( ) const
overridevirtual

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

Implements ConceptDef.

◆ codeSymbolType()

CodeSymbolType ConceptDefImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

◆ definitionType()

Definition::DefType ConceptDefImpl::definitionType ( ) const
overridevirtual

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

Implements ConceptDef.

◆ displayName()

QCString ConceptDefImpl::displayName ( bool  includeScope = true) const
overridevirtual

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

Implements ConceptDef.

◆ getOutputFileBase()

QCString ConceptDefImpl::getOutputFileBase ( ) const
overridevirtual

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

Implements ConceptDef.

◆ isLinkable()

bool ConceptDefImpl::isLinkable ( ) const
overridevirtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements ConceptDef.

◆ isLinkableInProject()

bool ConceptDefImpl::isLinkableInProject ( ) const
overridevirtual

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

Implements ConceptDef.


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