A model of a file symbol. More...
#include <filedef.h>
Inheritance diagram for FileDef:
Collaboration diagram for FileDef:
Public Member Functions | |
| virtual DString | fileName () const =0 |
| virtual DString | includeName () const =0 |
| virtual DString | includeDependencyGraphFileName () const =0 |
| virtual DString | includedByDependencyGraphFileName () const =0 |
| virtual DString | absFilePath () const =0 |
| virtual const DString & | docName () const =0 |
| virtual bool | isSource () const =0 |
| virtual bool | isDocumentationFile () const =0 |
| virtual const Definition * | getSourceDefinition (int lineNr) const =0 |
| virtual const MemberDef * | getSourceMember (int lineNr) const =0 |
| virtual DString | getPath () const =0 |
| virtual DString | getVersion () const =0 |
| virtual bool | isIncluded (const DString &name) const =0 |
| virtual DirDef * | getDirDef () const =0 |
| virtual ModuleDef * | getModuleDef () const =0 |
| virtual const LinkedRefMap< NamespaceDef > & | getUsedNamespaces () const =0 |
| virtual const LinkedRefMap< const Definition > & | getUsedDefinitions () const =0 |
| virtual const IncludeInfoList & | includeFileList () const =0 |
| virtual const IncludeInfoList & | includedByFileList () const =0 |
| virtual void | getAllIncludeFilesRecursively (StringVector &incFiles) const =0 |
| virtual MemberList * | getMemberList (MemberListType lt) const =0 |
| virtual const MemberLists & | getMemberLists () const =0 |
| virtual const MemberGroupList & | getMemberGroups () const =0 |
| virtual const NamespaceLinkedRefMap & | getNamespaces () const =0 |
| virtual const ConceptLinkedRefMap & | getConcepts () const =0 |
| virtual const ClassLinkedRefMap & | getClasses () const =0 |
| virtual DString | title () const =0 |
| virtual bool | hasDetailedDescription () const =0 |
| virtual DString | fileVersion () const =0 |
| virtual bool | subGrouping () const =0 |
| virtual void | countMembers ()=0 |
| virtual int | numDocMembers () const =0 |
| virtual int | numDecMembers () const =0 |
| virtual void | addSourceRef (int line, const Definition *d, const MemberDef *md)=0 |
| virtual void | writeDocumentation (OutputList &ol)=0 |
| virtual void | writeMemberPages (OutputList &ol)=0 |
| virtual void | writeTagFile (TextStream &t)=0 |
| virtual void | writeSourceHeader (OutputList &ol)=0 |
| virtual void | writeSourceBody (OutputList &ol, ClangTUParser *clangParser)=0 |
| virtual void | writeSourceFooter (OutputList &ol)=0 |
| virtual void | parseSource (ClangTUParser *clangParser)=0 |
| virtual void | setDiskName (const DString &name)=0 |
| virtual void | insertMember (MemberDef *md)=0 |
| virtual void | insertClass (ClassDef *cd)=0 |
| virtual void | insertConcept (ConceptDef *cd)=0 |
| virtual void | insertNamespace (NamespaceDef *nd)=0 |
| virtual void | removeMember (MemberDef *md)=0 |
| virtual void | computeAnchors ()=0 |
| virtual void | setDirDef (DirDef *dd)=0 |
| virtual void | setModuleDef (ModuleDef *mod)=0 |
| virtual void | addUsingDirective (NamespaceDef *nd)=0 |
| virtual void | addUsingDeclaration (const Definition *d)=0 |
| virtual void | combineUsingRelations ()=0 |
| virtual bool | generateSourceFile () const =0 |
| virtual void | sortMemberLists ()=0 |
| virtual void | setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force)=0 |
| virtual void | addIncludeDependency (const FileDef *fd, const DString &incName, IncludeKind kind)=0 |
| virtual void | addIncludedByDependency (const FileDef *fd, const DString &incName, IncludeKind kind)=0 |
| virtual void | addMembersToMemberGroup ()=0 |
| virtual void | distributeMemberGroupDocumentation ()=0 |
| virtual void | findSectionsInDocumentation ()=0 |
| virtual void | addIncludedUsingDirectives (FileDefSet &visitedFiles)=0 |
| virtual void | addListReferences ()=0 |
| virtual void | addRequirementReferences ()=0 |
| virtual bool | hasIncludeGraph () const =0 |
| virtual bool | hasIncludedByGraph () const =0 |
| virtual void | overrideIncludeGraph (bool e)=0 |
| virtual void | overrideIncludedByGraph (bool e)=0 |
| virtual bool | visibleInIndex (bool &genSourceFile) const =0 |
| Returns true if this file is visible in the index. More... | |
 Public Member Functions inherited from DefinitionMutable | |
| virtual void | setName (const DString &name)=0 |
| virtual void | setId (const DString &name)=0 |
| virtual void | setDefFile (const DString &df, int defLine, size_t defColumn)=0 |
| virtual void | setDocumentation (const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)=0 |
| virtual void | setBriefDescription (const DString &b, const DString &briefFile, int briefLine)=0 |
| virtual void | setInbodyDocumentation (const DString &d, const DString &docFile, int docLine)=0 |
| virtual void | setReference (const DString &r)=0 |
| virtual void | setBodySegment (int defLine, int bls, int ble)=0 |
| virtual void | setBodyDef (const FileDef *fd)=0 |
| virtual void | setRefItems (const RefItemVector &sli)=0 |
| virtual void | setRequirementReferences (const RequirementRefs &rqli)=0 |
| virtual void | setOuterScope (Definition *d)=0 |
| virtual void | setHidden (bool b)=0 |
| virtual void | setArtificial (bool b)=0 |
| virtual void | setExported (bool b)=0 |
| virtual void | setLanguage (SrcLangExt lang)=0 |
| virtual void | setLocalName (const DString &name)=0 |
| virtual void | makePartOfGroup (GroupDef *gd)=0 |
| virtual void | addSectionsToDefinition (const std::vector< const SectionInfo *> &anchorList)=0 |
| virtual void | addSourceReferencedBy (MemberDef *d, const DString &sourceRefName)=0 |
| virtual void | addSourceReferences (MemberDef *d, const DString &sourceRefName)=0 |
| virtual void | mergeRefItems (Definition *d)=0 |
| virtual void | addInnerCompound (Definition *d)=0 |
| virtual void | mergeReferences (const Definition *other)=0 |
| virtual void | mergeReferencedBy (const Definition *other)=0 |
| virtual void | computeTooltip ()=0 |
| virtual void | writeSourceDef (OutputList &ol) const =0 |
| virtual void | writeInlineCode (OutputList &ol, const DString &scopeName) const =0 |
| virtual bool | hasSourceRefs () const =0 |
| virtual bool | hasSourceReffedBy () const =0 |
| virtual void | writeSourceRefs (OutputList &ol, const DString &scopeName) const =0 |
| virtual void | writeSourceReffedBy (OutputList &ol, const DString &scopeName) const =0 |
| virtual bool | hasRequirementRefs () const =0 |
| virtual void | writeRequirementRefs (OutputList &ol) const =0 |
| virtual void | writeNavigationPath (OutputList &ol) const =0 |
| virtual void | writeQuickMemberLinks (OutputList &, const MemberDef *) const =0 |
| virtual void | writeSummaryLinks (OutputList &) const =0 |
| virtual void | writePageNavigation (OutputList &) const =0 |
| virtual void | writeDocAnchorsToTagFile (TextStream &) const =0 |
| virtual void | writeToc (OutputList &ol, const LocalToc <) const =0 |
| Public Member Functions inherited from Definition | |
| virtual DefType | definitionType () const =0 |
| virtual CodeSymbolType | codeSymbolType () const =0 |
| virtual bool | isAlias () const =0 |
| virtual const DString & | name () const =0 |
| virtual bool | isAnonymous () const =0 |
| virtual DString | displayName (bool includeScope=true) const =0 |
| virtual const DString & | localName () const =0 |
| virtual DString | qualifiedName () const =0 |
| virtual DString | symbolName () const =0 |
| virtual DString | getOutputFileBase () const =0 |
| virtual DString | anchor () const =0 |
| virtual DString | getSourceFileBase () const =0 |
| virtual DString | getSourceAnchor () const =0 |
| virtual DString | documentation () const =0 |
| virtual int | docLine () const =0 |
| virtual DString | docFile () const =0 |
| virtual DString | briefDescription (bool abbreviate=false) const =0 |
| virtual DString | briefDescriptionAsTooltip () const =0 |
| virtual int | briefLine () const =0 |
| virtual DString | briefFile () const =0 |
| virtual DString | inbodyDocumentation () const =0 |
| virtual DString | inbodyFile () const =0 |
| virtual int | inbodyLine () const =0 |
| virtual DString | getDefFileName () const =0 |
| virtual DString | getDefFileExtension () const =0 |
| virtual int | getDefLine () const =0 |
| virtual size_t | getDefColumn () const =0 |
| virtual bool | hasDocumentation () const =0 |
| virtual bool | hasUserDocumentation () const =0 |
| virtual bool | isLinkableInProject () const =0 |
| virtual bool | isLinkable () const =0 |
| virtual bool | isVisibleInProject () const =0 |
| virtual bool | isVisible () const =0 |
| virtual bool | isHidden () const =0 |
| virtual bool | isArtificial () const =0 |
| virtual bool | isExported () const =0 |
| virtual DString | getReference () const =0 |
| virtual bool | isReference () const =0 |
| virtual DString | externalReference (const DString &relPath) const =0 |
| virtual int | getStartDefLine () const =0 |
| virtual int | getStartBodyLine () const =0 |
| virtual int | getEndBodyLine () const =0 |
| virtual const FileDef * | getBodyDef () const =0 |
| virtual SrcLangExt | getLanguage () const =0 |
| Returns the programming language this definition was written in. More... | |
| virtual const GroupList & | partOfGroups () const =0 |
| virtual bool | isLinkableViaGroup () const =0 |
| virtual const RefItemVector & | xrefListItems () const =0 |
| virtual const RequirementRefs & | requirementReferences () const =0 |
| virtual const Definition * | findInnerCompound (const DString &name) const =0 |
| virtual Definition * | getOuterScope () const =0 |
| virtual const MemberVector & | getReferencesMembers () const =0 |
| virtual const MemberVector & | getReferencedByMembers () const =0 |
| virtual bool | hasSections () const =0 |
| virtual bool | hasSources () const =0 |
| virtual bool | hasBriefDescription () const =0 |
| returns true if this class has a brief description | |
| virtual DString | id () const =0 |
| virtual const SectionRefs & | getSectionRefs () const =0 |
| returns the section dictionary, only of importance for pagedef | |
| virtual DString | navigationPathAsString () const =0 |
| virtual DString | pathFragment () const =0 |
| virtual void | _setSymbolName (const DString &name)=0 |
| virtual DString | _symbolName () const =0 |
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 } |
Detailed Description
A model of a file symbol.
An object of this class contains all file information that is gathered. This includes the members and compounds defined in the file.
The member writeDocumentation() can be used to generate the page of documentation to HTML and LaTeX.
Member Function Documentation
◆ absFilePath()
|
pure virtual |
Returns the absolute path including the file name.
Implemented in FileDefImpl.
◆ docName()
|
pure virtual |
Returns the name as it is used in the documentation
Implemented in FileDefImpl.
◆ fileName()
|
pure virtual |
Returns the unique file name (this may include part of the path).
Implemented in FileDefImpl.
◆ getPath()
|
pure virtual |
Returns the absolute path of this file.
Implemented in FileDefImpl.
◆ getVersion()
|
pure virtual |
Returns version of this file.
Implemented in FileDefImpl.
◆ includeName()
|
pure virtual |
Returns the name of the verbatim copy of this file (if any).
Implemented in FileDefImpl.
◆ isSource()
|
pure virtual |
Returns true if this file is a source file.
Implemented in FileDefImpl.
◆ visibleInIndex()
|
pure virtual |
Returns true if this file is visible in the index.
The parameter genSourceFile is set to true if this file is only linkable as a source file.
Implemented in FileDefImpl.
The documentation for this class was generated from the following file:
- src/filedef.h
