doxygen
Classes | Public Member Functions | List of all members
DefinitionImpl Class Reference

Classes

class  Private
 Private data associated with a Symbol DefinitionImpl object. More...
 

Public Member Functions

 DefinitionImpl (Definition *def, const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
 
 DefinitionImpl (const DefinitionImpl &d)
 
DefinitionImploperator= (const DefinitionImpl &d)
 
 DefinitionImpl (DefinitionImpl &&d)=delete
 
DefinitionImploperator= (DefinitionImpl &&d)=delete
 
const QCStringname () const
 
bool isAnonymous () const
 
const QCStringlocalName () const
 
QCString qualifiedName () const
 
QCString symbolName () const
 
QCString getSourceFileBase () const
 
QCString getSourceAnchor () const
 
QCString documentation () const
 
int docLine () const
 
QCString docFile () const
 
QCString briefDescription (bool abbreviate=FALSE) const
 
QCString briefDescriptionAsTooltip () const
 
int briefLine () const
 
QCString inbodyDocumentation () const
 
QCString inbodyFile () const
 
int inbodyLine () const
 
QCString briefFile () const
 
QCString getDefFileName () const
 
QCString getDefFileExtension () const
 
int getDefLine () const
 
int getDefColumn () const
 
bool hasDocumentation () const
 
bool hasUserDocumentation () const
 
bool isVisibleInProject () const
 
bool isVisible () const
 
bool isHidden () const
 
bool isArtificial () const
 
bool isExported () const
 
QCString getReference () const
 
bool isReference () const
 
QCString externalReference (const QCString &relPath) const
 
int getStartDefLine () const
 
int getStartBodyLine () const
 
int getEndBodyLine () const
 
const FileDefgetBodyDef () const
 
SrcLangExt getLanguage () const
 
const GroupListpartOfGroups () const
 
bool isLinkableViaGroup () const
 
const RefItemVector & xrefListItems () const
 
const DefinitionfindInnerCompound (const QCString &name) const
 
DefinitiongetOuterScope () const
 
const MemberVectorgetReferencesMembers () const
 
const MemberVectorgetReferencedByMembers () const
 
bool hasSections () const
 
bool hasSources () const
 
bool hasBriefDescription () const
 
QCString id () const
 
const SectionRefsgetSectionRefs () const
 
void setName (const QCString &name)
 
void setId (const QCString &name)
 
void setDefFile (const QCString &df, int defLine, int defColumn)
 
void setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
 
void setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)
 
void setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)
 
void setReference (const QCString &r)
 
void addSectionsToDefinition (const std::vector< const SectionInfo *> &anchorList)
 
void setBodySegment (int defLine, int bls, int ble)
 
void setBodyDef (const FileDef *fd)
 
void addSourceReferencedBy (MemberDef *d, const QCString &sourceRefName)
 
void addSourceReferences (MemberDef *d, const QCString &sourceRefName)
 
void setRefItems (const RefItemVector &sli)
 
void mergeRefItems (Definition *d)
 
void mergeReferences (const Definition *other)
 
void mergeReferencedBy (const Definition *other)
 
void addInnerCompound (Definition *d)
 
void setOuterScope (Definition *d)
 
void setHidden (bool b)
 
void setArtificial (bool b)
 
void setExported (bool b)
 
void setLanguage (SrcLangExt lang)
 
void writeSourceDef (OutputList &ol) const
 
void writeInlineCode (OutputList &ol, const QCString &scopeName) const
 
bool hasSourceRefs () const
 
bool hasSourceReffedBy () const
 
void writeSourceRefs (OutputList &ol, const QCString &scopeName) const
 
void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const
 
void makePartOfGroup (GroupDef *gd)
 
void writeNavigationPath (OutputList &ol) const
 
QCString navigationPathAsString () const
 
void writeQuickMemberLinks (OutputList &, const MemberDef *) const
 
void writeSummaryLinks (OutputList &) const
 
void writePageNavigation (OutputList &ol) const
 
QCString pathFragment () const
 
void writeDocAnchorsToTagFile (TextStream &) const
 
void setLocalName (const QCString &name)
 
void writeToc (OutputList &ol, const LocalToc &lt) const
 
void computeTooltip ()
 
void _setSymbolName (const QCString &name)
 
QCString _symbolName () const
 

Member Function Documentation

◆ navigationPathAsString()

QCString DefinitionImpl::navigationPathAsString ( ) const

Returns the string used in the footer for $navpath when GENERATE_TREEVIEW is enabled

◆ writeInlineCode()

void DefinitionImpl::writeInlineCode ( OutputList ol,
const QCString scopeName 
) const

Write code of this definition into the documentation

◆ writeSourceDef()

void DefinitionImpl::writeSourceDef ( OutputList ol) const

Write a reference to the source code defining this definition


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