浏览该文件的文档.
18 #ifndef DEFINITIONIMPL_H
19 #define DEFINITIONIMPL_H
21 #include <unordered_map>
31 const QCString &defFileName,
int defLine,
int defColumn,
130 const std::unordered_map<std::string,const MemberDef *> &members,
bool)
const;
147 const QCString &defFileName,
int defLine,
int defColumn,
149 bool isSymbol=
TRUE) :
m_impl(this,defFileName,defLine,defColumn,
name,b,d,isSymbol) {}
virtual Definition * toDefinition_()
virtual QCString briefFile() const
virtual QCString getSourceFileBase() const =0
virtual QCString getDefFileExtension() const =0
virtual bool hasBriefDescription() const =0
returns TRUE if this class has a brief description
virtual bool hasUserDocumentation() const
virtual bool isReference() const
QCString getReference() const
bool isArtificial() const
virtual QCString briefDescription(bool abbreviate=FALSE) const
QCString getDefFileName() const
virtual void addSectionsToIndex()
void _setSymbolName(const QCString &name)
virtual bool hasSourceReffedBy() const
void setRefItems(const RefItemVector &sli)
virtual int docLine() const =0
void writeSummaryLinks(OutputList &) const
virtual void _setSymbolName(const QCString &name)
QCString pathFragment() const
virtual QCString getReference() const
virtual const RefItemVector & xrefListItems() const
virtual QCString inbodyDocumentation() const
virtual int getStartBodyLine() const
void writeInlineCode(OutputList &ol, const QCString &scopeName) const
void setLanguage(SrcLangExt lang)
virtual ~DefinitionAliasMixin()=default
virtual void setDefFile(const QCString &df, int defLine, int defColumn)
virtual int getDefColumn() const =0
The common base class of all entity definitions found in the sources.
virtual int getStartDefLine() const
virtual QCString id() const =0
virtual int getStartDefLine() const
virtual bool isHidden() const
virtual const RefItemVector & xrefListItems() const
QCString inbodyFile() const
int getEndBodyLine() const
virtual void setArtificial(bool b)
DefinitionImpl(Definition *def, const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
QCString briefDescription(bool abbreviate=FALSE) const
virtual void writeDocAnchorsToTagFile(TextStream &fs) const
virtual bool isAlias() const
virtual int getDefLine() const =0
virtual QCString docFile() const
void addInnerCompound(const Definition *d)
virtual QCString pathFragment() const
void setBodyDef(const FileDef *fd)
virtual void writeToc(OutputList &ol, const LocalToc <) const
virtual const Definition * findInnerCompound(const QCString &name) const =0
virtual bool hasBriefDescription() const
virtual const GroupList & partOfGroups() const
const MemberVector & getReferencesMembers() const
virtual void setBodyDef(const FileDef *fd)
virtual QCString externalReference(const QCString &relPath) const
virtual const Definition * findInnerCompound(const QCString &name) const
const RefItemVector & xrefListItems() const
virtual int getDefLine() const
virtual QCString _symbolName() const
virtual QCString id() const
virtual const MemberVector & getReferencedByMembers() const =0
SrcLangExt
Language as given by extension
virtual Definition * toDefinition_()
virtual QCString navigationPathAsString() const
void setBriefDescription(const QCString &b, const QCString &briefFile, int briefLine)
virtual ~DefinitionAliasImpl()
virtual int getEndBodyLine() const
virtual Definition * getOuterScope() const
SrcLangExt getLanguage() const
virtual void makePartOfGroup(const GroupDef *gd)
virtual bool isHidden() const =0
virtual void setId(const QCString &name)
virtual bool isAnonymous() const
virtual QCString inbodyFile() const
virtual Definition * getOuterScope() const
virtual bool hasSources() const
virtual SrcLangExt getLanguage() const
QCString inbodyDocumentation() const
void mergeReferencedBy(const Definition *other)
virtual int inbodyLine() const =0
void writeSourceRefs(OutputList &ol, const QCString &scopeName) const
virtual const DefinitionImpl * toDefinitionImpl_() const
virtual QCString name() const
Text streaming class that buffers data.
virtual QCString name() const
QCString externalReference(const QCString &relPath) const
virtual QCString getDefFileName() const
virtual int briefLine() const =0
int _getXRefListId(const QCString &listName) const
virtual QCString pathFragment() const =0
virtual int briefLine() const
void writeNavigationPath(OutputList &ol) const
QCString getSourceFileBase() const
static QCString abbreviate(const QCString &s, const QCString &name)
void _setBriefDescription(const QCString &b, const QCString &briefFile, int briefLine)
virtual QCString getDefFileExtension() const
virtual bool hasBriefDescription() const
void _setInbodyDocumentation(const QCString &d, const QCString &docFile, int docLine)
virtual QCString docFile() const =0
bool isLinkableViaGroup() const
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual void mergeReferences(const Definition *other)
bool hasUserDocumentation() const
virtual int inbodyLine() const
QCString localName() const
virtual QCString pathFragment() const
virtual bool isHidden() const
virtual QCString getSourceAnchor() const
virtual ~DefinitionImpl()
A model of a group of symbols.
virtual QCString qualifiedName() const
virtual QCString externalReference(const QCString &relPath) const
virtual const FileDef * getBodyDef() const =0
Class representing a list of output generators that are written to in parallel.
virtual void addInnerCompound(const Definition *def)
A model of a class/file/namespace member symbol.
virtual const MemberVector & getReferencedByMembers() const
virtual void writeSourceDef(OutputList &ol, const QCString &scopeName) const
virtual void writeInlineCode(OutputList &ol, const QCString &scopeName) const
virtual QCString briefDescription(bool abbreviate=FALSE) const
virtual bool isAlias() const
Private data associated with a Symbol DefinitionImpl object.
void setDocumentation(const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
Definition * getOuterScope() const
DefinitionAliasMixin(const Definition *scope, const Definition *alias)
void setInbodyDocumentation(const QCString &d, const QCString &docFile, int docLine)
virtual QCString externalReference(const QCString &relPath) const =0
int getStartDefLine() const
void _setDocumentation(const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace, bool atTop)
virtual bool isReference() const
virtual bool hasSections() const =0
virtual QCString inbodyDocumentation() const
virtual const MemberVector & getReferencesMembers() const =0
virtual bool isAnonymous() const =0
void mergeRefItems(Definition *d)
virtual QCString symbolName() const =0
virtual QCString qualifiedName() const
virtual int getStartBodyLine() const
void _writeSourceRefList(OutputList &ol, const QCString &scopeName, const QCString &text, const std::unordered_map< std::string, const MemberDef * > &members, bool) const
void addSourceReferences(const MemberDef *d)
virtual QCString getSourceFileBase() const
bool _docsAlreadyAdded(const QCString &doc, QCString &sigList)
virtual bool isVisible() const =0
virtual bool isReference() const =0
virtual bool isArtificial() const
virtual QCString inbodyDocumentation() const =0
virtual void writeQuickMemberLinks(OutputList &ol, const MemberDef *md) const
const Definition * findInnerCompound(const QCString &name) const
virtual bool hasSections() const
virtual QCString documentation() const
QCString _symbolName() const
virtual QCString _symbolName() const
virtual bool isLinkableViaGroup() const
virtual QCString inbodyFile() const =0
virtual const FileDef * getBodyDef() const
virtual int getEndBodyLine() const
virtual bool isVisibleInProject() const
virtual void setBriefDescription(const QCString &brief, const QCString &briefFile, int briefLine)
virtual bool isLinkableViaGroup() const
virtual int inbodyLine() const
virtual QCString id() const
virtual int getDefColumn() const
virtual QCString localName() const
virtual const SectionRefs & getSectionRefs() const
virtual const DefinitionImpl * toDefinitionImpl_() const
void setLocalName(const QCString &name)
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
bool hasSourceReffedBy() const
virtual int getStartBodyLine() const =0
A vector of MemberDef object
virtual int getEndBodyLine() const =0
void setOuterScope(Definition *d)
virtual void setDocumentation(const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual void setBodySegment(int defLine, int bls, int ble)
virtual QCString symbolName() const
QCString briefFile() const
QCString qualifiedName() const
virtual QCString navigationPathAsString() const =0
QCString getSourceAnchor() const
virtual const GroupList & partOfGroups() const =0
virtual DefinitionMutable * toDefinitionMutable_()
virtual QCString briefFile() const
virtual void writeSummaryLinks(OutputList &ol) const
virtual void setHidden(bool b)
virtual int docLine() const
virtual bool hasDocumentation() const
void setBodySegment(int defLine, int bls, int ble)
const GroupList & partOfGroups() const
virtual DefinitionMutable * toDefinitionMutable_()
virtual QCString inbodyFile() const
virtual QCString briefFile() const =0
virtual int getDefColumn() const
const Definition * m_alias
virtual const SectionRefs & getSectionRefs() const =0
returns the section dictionary, only of importance for pagedef
virtual QCString getSourceAnchor() const
virtual bool isAnonymous() const
virtual QCString localName() const
virtual bool hasSources() const =0
virtual const MemberVector & getReferencedByMembers() const
virtual const MemberVector & getReferencesMembers() const
void addSectionsToDefinition(const std::vector< const SectionInfo * > &anchorList)
virtual QCString getReference() const =0
void makePartOfGroup(const GroupDef *gd)
virtual QCString documentation() const
void addSourceReferencedBy(const MemberDef *d)
virtual QCString symbolName() const
virtual void setLocalName(const QCString &name)
DefinitionMixin(const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
QCString documentation() const
QCString getDefFileExtension() const
QCString symbolName() const
void writeSourceDef(OutputList &ol, const QCString &scopeName) const
virtual const Definition * findInnerCompound(const QCString &name) const
std::vector< RefItem * > RefItemVector
virtual void setInbodyDocumentation(const QCString &doc, const QCString &docFile, int docLine)
void setName(const QCString &name)
void writeToc(OutputList &ol, const LocalToc <) const
virtual void mergeReferencedBy(const Definition *other)
virtual void _setSymbolName(const QCString &name)
QCString qualifiedName() const
const Definition * m_scope
virtual bool isVisible() const
virtual bool hasDocumentation() const =0
void setDefFile(const QCString &df, int defLine, int defColumn)
void addSectionsToIndex()
virtual bool hasSections() const
void writeQuickMemberLinks(OutputList &, const MemberDef *) const
virtual void addSourceReferencedBy(const MemberDef *md)
const MemberVector & getReferencedByMembers() const
virtual QCString documentation() const =0
virtual void writeSourceRefs(OutputList &ol, const QCString &scopeName) const
void mergeReferences(const Definition *other)
virtual bool hasDocumentation() const
virtual const FileDef * getBodyDef() const
bool hasBriefDescription() const
virtual const MemberVector & getReferencesMembers() const
virtual int docLine() const
virtual bool isArtificial() const =0
class that represents a list of constant references to sections.
bool hasDocumentation() const
virtual int briefLine() const
QCString navigationPathAsString() const
QCString briefDescriptionAsTooltip() const
virtual QCString getDefFileName() const =0
virtual bool isVisibleInProject() const =0
virtual void computeTooltip()
void writeDocAnchorsToTagFile(TextStream &) const
virtual QCString briefDescriptionAsTooltip() const
virtual bool hasSourceRefs() const
virtual void setName(const QCString &name)
bool isVisibleInProject() const
const Definition * m_scope
virtual const GroupList & partOfGroups() const
void setArtificial(bool b)
A model of a file symbol.
virtual void addSourceReferences(const MemberDef *md)
virtual void setReference(const QCString &r)
virtual bool isArtificial() const
const SectionRefs & getSectionRefs() const
virtual bool hasUserDocumentation() const
virtual void writeNavigationPath(OutputList &ol) const
virtual QCString navigationPathAsString() const
virtual bool isLinkableViaGroup() const =0
virtual const RefItemVector & xrefListItems() const =0
virtual int getDefLine() const
virtual ~DefinitionMixin()
virtual QCString briefDescriptionAsTooltip() const
virtual const SectionRefs & getSectionRefs() const
bool hasSourceRefs() const
virtual bool isVisibleInProject() const
DefinitionAliasImpl m_impl
void setReference(const QCString &r)
void writeSourceReffedBy(OutputList &ol, const QCString &scopeName) const
virtual QCString briefDescriptionAsTooltip() const =0
const Definition * getScope() const
virtual void mergeRefItems(Definition *def)
virtual QCString getDefFileExtension() const
virtual void setRefItems(const RefItemVector &sli)
virtual int getStartDefLine() const =0
virtual SrcLangExt getLanguage() const
virtual bool hasSources() const
virtual QCString localName() const =0
virtual QCString getDefFileName() const
virtual QCString docFile() const
virtual void setOuterScope(Definition *def)
virtual void setLanguage(SrcLangExt lang)
virtual void writeSourceReffedBy(OutputList &ol, const QCString &scopeName) const
const Definition * getAlias() const
virtual bool isVisible() const
const FileDef * getBodyDef() const
virtual QCString getSourceFileBase() const
virtual void addSectionsToDefinition(const std::vector< const SectionInfo * > &anchorList)
void setId(const QCString &name)
virtual QCString getReference() const
virtual QCString getSourceAnchor() const =0
virtual bool hasUserDocumentation() const =0
DefinitionAliasImpl(Definition *def, const Definition *scope, const Definition *alias)
int getStartBodyLine() const
This is an alternative implementation of QCString.