27 #pragma warning( disable: 4250 ) 98 virtual DefType definitionType()
const = 0;
101 virtual CodeSymbolType codeSymbolType()
const = 0;
104 virtual bool isAlias()
const = 0;
107 virtual const QCString &name()
const = 0;
112 virtual bool isAnonymous()
const = 0;
115 virtual QCString displayName(
bool includeScope=TRUE)
const = 0;
118 virtual const QCString &localName()
const = 0;
122 virtual QCString qualifiedName()
const = 0;
126 virtual QCString symbolName()
const = 0;
131 virtual QCString getOutputFileBase()
const = 0;
134 virtual QCString anchor()
const = 0;
137 virtual QCString getSourceFileBase()
const = 0;
140 virtual QCString getSourceAnchor()
const = 0;
143 virtual QCString documentation()
const = 0;
146 virtual int docLine()
const = 0;
151 virtual QCString docFile()
const = 0;
154 virtual QCString briefDescription(
bool abbreviate=FALSE)
const = 0;
159 virtual QCString briefDescriptionAsTooltip()
const = 0;
162 virtual int briefLine()
const = 0;
165 virtual QCString inbodyDocumentation()
const = 0;
168 virtual QCString inbodyFile()
const = 0;
172 virtual int inbodyLine()
const = 0;
177 virtual QCString briefFile()
const = 0;
180 virtual QCString getDefFileName()
const = 0;
183 virtual QCString getDefFileExtension()
const = 0;
186 virtual int getDefLine()
const = 0;
189 virtual int getDefColumn()
const = 0;
195 virtual bool hasDocumentation()
const = 0;
198 virtual bool hasUserDocumentation()
const = 0;
203 virtual bool isLinkableInProject()
const = 0;
208 virtual bool isLinkable()
const = 0;
213 virtual bool isVisibleInProject()
const = 0;
216 virtual bool isVisible()
const = 0;
219 virtual bool isHidden()
const = 0;
224 virtual bool isArtificial()
const = 0;
227 virtual bool isExported()
const = 0;
234 virtual QCString getReference()
const = 0;
237 virtual bool isReference()
const = 0;
243 virtual int getStartDefLine()
const = 0;
248 virtual int getStartBodyLine()
const = 0;
253 virtual int getEndBodyLine()
const = 0;
258 virtual const FileDef *getBodyDef()
const = 0;
263 virtual const GroupList &partOfGroups()
const = 0;
264 virtual bool isLinkableViaGroup()
const = 0;
266 virtual const RefItemVector &xrefListItems()
const = 0;
269 virtual Definition *getOuterScope()
const = 0;
271 virtual const MemberVector &getReferencesMembers()
const = 0;
272 virtual const MemberVector &getReferencedByMembers()
const = 0;
274 virtual bool hasSections()
const = 0;
275 virtual bool hasSources()
const = 0;
278 virtual bool hasBriefDescription()
const = 0;
283 virtual const SectionRefs &getSectionRefs()
const = 0;
285 virtual QCString navigationPathAsString()
const = 0;
286 virtual QCString pathFragment()
const = 0;
291 virtual void _setSymbolName(
const QCString &name) = 0;
292 virtual QCString _symbolName()
const = 0;
315 virtual void setName(
const QCString &name) = 0;
318 virtual void setId(
const QCString &name) = 0;
321 virtual void setDefFile(
const QCString& df,
int defLine,
int defColumn) = 0;
329 virtual void setBriefDescription(
const QCString &b,
const QCString &briefFile,
int briefLine) = 0;
335 virtual void setInbodyDocumentation(
const QCString &d,
const QCString &docFile,
int docLine) = 0;
338 virtual void setReference(
const QCString &r) = 0;
341 virtual void setBodySegment(
int defLine,
int bls,
int ble) = 0;
342 virtual void setBodyDef(
const FileDef *fd) = 0;
344 virtual void setRefItems(
const RefItemVector &sli) = 0;
345 virtual void setOuterScope(
Definition *d) = 0;
347 virtual void setHidden(
bool b) = 0;
349 virtual void setArtificial(
bool b) = 0;
350 virtual void setExported(
bool b) = 0;
351 virtual void setLanguage(
SrcLangExt lang) = 0;
352 virtual void setLocalName(
const QCString &name) = 0;
358 virtual void makePartOfGroup(
GroupDef *gd) = 0;
363 virtual void addSectionsToDefinition(
const std::vector<const SectionInfo*> &anchorList) = 0;
364 virtual void addSourceReferencedBy(
MemberDef *d) = 0;
365 virtual void addSourceReferences(
MemberDef *d) = 0;
366 virtual void mergeRefItems(
Definition *d) = 0;
367 virtual void addInnerCompound(
Definition *d) = 0;
368 virtual void addSectionsToIndex() = 0;
369 virtual void mergeReferences(
const Definition *other) = 0;
370 virtual void mergeReferencedBy(
const Definition *other) = 0;
371 virtual void computeTooltip() = 0;
378 virtual bool hasSourceRefs()
const = 0;
379 virtual bool hasSourceReffedBy()
const = 0;
382 virtual void writeNavigationPath(
OutputList &ol)
const = 0;
384 virtual void writeSummaryLinks(
OutputList &)
const = 0;
385 virtual void writeDocAnchorsToTagFile(
TextStream &)
const = 0;
404 bool readCodeFragment(
const QCString &fileName,
bool isMacro,
405 int &startLine,
int &endLine,
This file contains a number of basic enums and types.
The common base class of all entity definitions found in the sources.
Definition: definition.h:74
A model of a class/file/namespace member symbol.
Definition: memberdef.h:47
A vector of MemberDef object.
Definition: memberlist.h:32
Text streaming class that buffers data.
Definition: textstream.h:34
A model of a file symbol.
Definition: filedef.h:98
SrcLangExt
Language as given by extension.
Definition: types.h:41
class that represents a list of constant references to sections.
Definition: section.h:104
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
Definition: stringutil.h:72
Definition: definition.h:305
Data associated with description found in the body.
Definition: definition.h:61
Data associated with a brief description.
Definition: definition.h:52
Definition: definitionimpl.h:27
class that provide information about a section.
Definition: section.h:55
Class representing a list of output generators that are written to in parallel.
Definition: outputlist.h:530
Data associated with a detailed description.
Definition: definition.h:44
Definition: groupdef.h:134
DefType
Definition: definition.h:78
This is an alternative implementation of QCString.
Definition: qcstring.h:93
A model of a group of symbols.
Definition: groupdef.h:51