doxygen
|
Public Member Functions | |
FileDefImpl (const QCString &p, const QCString &n, const QCString &ref=QCString(), const QCString &dn=QCString()) | |
~FileDefImpl () override | |
DefType | definitionType () const override |
CodeSymbolType | codeSymbolType () const override |
const QCString & | name () const override |
QCString | displayName (bool=TRUE) const override |
QCString | fileName () const override |
QCString | getOutputFileBase () const override |
QCString | anchor () const override |
QCString | getSourceFileBase () const override |
QCString | includeName () const override |
QCString | includeDependencyGraphFileName () const override |
QCString | includedByDependencyGraphFileName () const override |
QCString | absFilePath () const override |
const QCString & | docName () const override |
bool | isSource () const override |
bool | isDocumentationFile () const override |
const Definition * | getSourceDefinition (int lineNr) const override |
const MemberDef * | getSourceMember (int lineNr) const override |
QCString | getPath () const override |
QCString | getVersion () const override |
bool | isLinkableInProject () const override |
bool | isLinkable () const override |
bool | isIncluded (const QCString &name) const override |
DirDef * | getDirDef () const override |
ModuleDef * | getModuleDef () const override |
const LinkedRefMap< NamespaceDef > & | getUsedNamespaces () const override |
const LinkedRefMap< ClassDef > & | getUsedClasses () const override |
const IncludeInfoList & | includeFileList () const override |
const IncludeInfoList & | includedByFileList () const override |
void | getAllIncludeFilesRecursively (StringVector &incFiles) const override |
MemberList * | getMemberList (MemberListType lt) const override |
const MemberLists & | getMemberLists () const override |
const MemberGroupList & | getMemberGroups () const override |
const NamespaceLinkedRefMap & | getNamespaces () const override |
const ConceptLinkedRefMap & | getConcepts () const override |
const ClassLinkedRefMap & | getClasses () const override |
QCString | title () const override |
bool | hasDetailedDescription () const override |
QCString | fileVersion () const override |
bool | subGrouping () const override |
void | countMembers () override |
int | numDocMembers () const override |
int | numDecMembers () const override |
void | addSourceRef (int line, const Definition *d, const MemberDef *md) override |
void | writeDocumentation (OutputList &ol) override |
void | writeMemberPages (OutputList &ol) override |
void | writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const override |
void | writeSummaryLinks (OutputList &ol) const override |
void | writeTagFile (TextStream &t) override |
void | writeSourceHeader (OutputList &ol) override |
void | writeSourceBody (OutputList &ol, ClangTUParser *clangParser) override |
void | writeSourceFooter (OutputList &ol) override |
void | parseSource (ClangTUParser *clangParser) override |
void | setDiskName (const QCString &name) override |
void | insertMember (MemberDef *md) override |
void | insertClass (ClassDef *cd) override |
void | insertConcept (ConceptDef *cd) override |
void | insertNamespace (NamespaceDef *nd) override |
void | computeAnchors () override |
void | setDirDef (DirDef *dd) override |
void | setModuleDef (ModuleDef *mod) override |
void | addUsingDirective (NamespaceDef *nd) override |
void | addUsingDeclaration (ClassDef *cd) override |
void | combineUsingRelations () override |
bool | generateSourceFile () const override |
void | sortMemberLists () override |
void | addIncludeDependency (const FileDef *fd, const QCString &incName, IncludeKind kind) override |
void | addIncludedByDependency (const FileDef *fd, const QCString &incName, IncludeKind kind) override |
void | addMembersToMemberGroup () override |
void | distributeMemberGroupDocumentation () override |
void | findSectionsInDocumentation () override |
void | addIncludedUsingDirectives (FileDefSet &visitedFiles) override |
void | addListReferences () override |
bool | hasIncludeGraph () const override |
bool | hasIncludedByGraph () const override |
void | overrideIncludeGraph (bool e) override |
void | overrideIncludedByGraph (bool e) override |
Public Member Functions inherited from DefinitionMixin< FileDef > | |
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 QCString & | name () const override |
bool | isAnonymous () const override |
const QCString & | localName () 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 FileDef * | getBodyDef () const override |
SrcLangExt | getLanguage () const override |
const GroupList & | partOfGroups () const override |
bool | isLinkableViaGroup () const override |
const RefItemVector & | xrefListItems () const override |
const Definition * | findInnerCompound (const QCString &name) const override |
Definition * | getOuterScope () const override |
const MemberVector & | getReferencesMembers () const override |
const MemberVector & | getReferencedByMembers () const override |
bool | hasSections () const override |
bool | hasSources () const override |
bool | hasBriefDescription () const override |
QCString | id () const override |
const SectionRefs & | getSectionRefs () 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 <) 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< FileDef > | |
DefinitionMixin (const DefinitionMixin &def)=default | |
FileDefImpl::FileDefImpl | ( | const QCString & | p, |
const QCString & | nm, | ||
const QCString & | lref = QCString() , |
||
const QCString & | dn = QCString() |
||
) |
create a new file definition, where p is the file path, nm the file name, and lref is an HTML anchor name if the file was read from a tag file or nullptr otherwise
|
override |
destroy the file definition
|
inlineoverridevirtual |
Returns the absolute path including the file name.
Implements FileDef.
|
inlineoverridevirtual |
Returns the anchor within a page where this item can be found
Implements FileDef.
|
inlineoverridevirtual |
Used for syntax highlighting symbol class
Implements Definition.
|
overridevirtual |
Compute the HTML anchor names for all members in the class
Implements FileDef.
|
inlineoverridevirtual |
Use this for dynamic inspection of the type of the derived class
Implements FileDef.
|
inlineoverridevirtual |
Returns the name of the definition as it appears in the output
Implements FileDef.
|
inlineoverridevirtual |
Returns the name as it is used in the documentation
Implements FileDef.
|
overridevirtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
Implements FileDef.
|
inlineoverridevirtual |
Returns the absolute path of this file.
Implements FileDef.
|
overridevirtual |
Returns the name of the source listing of this definition.
Implements FileDef.
|
inlineoverridevirtual |
Returns version of this file.
Implements FileDef.
|
overridevirtual |
Returns the name of the verbatim copy of this file (if any).
Implements FileDef.
|
overridevirtual |
Adds compound definition cd to the list of all compounds of this file
Implements FileDef.
|
overridevirtual |
Adds member definition md to the list of all members of this file
Implements FileDef.
|
overridevirtual |
Adds namespace definition nd to the list of all compounds of this file
Implements FileDef.
|
inlineoverridevirtual |
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 FileDef.
|
overridevirtual |
Returns TRUE iff it is possible to link to this item within this project.
Implements FileDef.
|
inlineoverridevirtual |
Returns TRUE if this file is a source file.
Implements FileDef.
|
overridevirtual |
Returns the unique file name (this may include part of the path).
Implements FileDef.
|
overridevirtual |
Write the documentation page for this file to the file of output generators ol.
Implements FileDef.
|
overridevirtual |
Write a source listing of this file to the output
Implements FileDef.