Doxygen
|
A model of a file symbol. 更多...
#include <filedef.h>
Public 成员函数 | |
~FileDef () | |
virtual DefType | definitionType () const =0 |
virtual QCString | name () const =0 |
virtual QCString | displayName (bool=TRUE) const =0 |
virtual QCString | fileName () const =0 |
virtual QCString | getOutputFileBase () const =0 |
virtual QCString | anchor () const =0 |
virtual QCString | getSourceFileBase () const =0 |
virtual QCString | includeName () const =0 |
virtual QCString | includeDependencyGraphFileName () const =0 |
virtual QCString | includedByDependencyGraphFileName () const =0 |
virtual QCString | absFilePath () const =0 |
virtual const QCString & | 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 QCString | getPath () const =0 |
virtual QCString | getVersion () const =0 |
virtual bool | isLinkableInProject () const =0 |
virtual bool | isLinkable () const =0 |
virtual bool | isIncluded (const QCString &name) const =0 |
virtual PackageDef * | packageDef () const =0 |
virtual DirDef * | getDirDef () const =0 |
virtual LinkedRefMap< const NamespaceDef > | getUsedNamespaces () const =0 |
virtual LinkedRefMap< const ClassDef > | getUsedClasses () 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 QCString | title () const =0 |
virtual bool | hasDetailedDescription () const =0 |
virtual QCString | 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 | writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const =0 |
virtual void | writeSummaryLinks (OutputList &ol) const =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 QCString &name)=0 |
virtual void | insertMember (MemberDef *md)=0 |
virtual void | insertClass (const ClassDef *cd)=0 |
virtual void | insertConcept (const ConceptDef *cd)=0 |
virtual void | insertNamespace (const NamespaceDef *nd)=0 |
virtual void | computeAnchors ()=0 |
virtual void | setPackageDef (PackageDef *pd)=0 |
virtual void | setDirDef (DirDef *dd)=0 |
virtual void | addUsingDirective (const NamespaceDef *nd)=0 |
virtual void | addUsingDeclaration (const ClassDef *cd)=0 |
virtual void | combineUsingRelations ()=0 |
virtual bool | generateSourceFile () const =0 |
virtual void | sortMemberLists ()=0 |
virtual void | addIncludeDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)=0 |
virtual void | addIncludedByDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)=0 |
virtual void | addMembersToMemberGroup ()=0 |
virtual void | distributeMemberGroupDocumentation ()=0 |
virtual void | findSectionsInDocumentation ()=0 |
virtual void | addIncludedUsingDirectives (FileDefSet &visitedFiles)=0 |
virtual void | addListReferences ()=0 |
Public 成员函数 继承自 DefinitionMutable | |
virtual void | setName (const QCString &name)=0 |
virtual void | setId (const QCString &name)=0 |
virtual void | setDefFile (const QCString &df, int defLine, int defColumn)=0 |
virtual void | setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0 |
virtual void | setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0 |
virtual void | setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0 |
virtual void | setReference (const QCString &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 | setOuterScope (Definition *d)=0 |
virtual void | setHidden (bool b)=0 |
virtual void | setArtificial (bool b)=0 |
virtual void | setLanguage (SrcLangExt lang)=0 |
virtual void | setLocalName (const QCString &name)=0 |
virtual void | makePartOfGroup (const GroupDef *gd)=0 |
virtual void | addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0 |
virtual void | addSourceReferencedBy (const MemberDef *d)=0 |
virtual void | addSourceReferences (const MemberDef *d)=0 |
virtual void | mergeRefItems (Definition *d)=0 |
virtual void | addInnerCompound (const Definition *d)=0 |
virtual void | addSectionsToIndex ()=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 QCString &scopeName) const =0 |
virtual void | writeInlineCode (OutputList &ol, const QCString &scopeName) const =0 |
virtual bool | hasSourceRefs () const =0 |
virtual bool | hasSourceReffedBy () const =0 |
virtual void | writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0 |
virtual void | writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const =0 |
virtual void | writeNavigationPath (OutputList &ol) const =0 |
virtual void | writeDocAnchorsToTagFile (TextStream &) const =0 |
virtual void | writeToc (OutputList &ol, const LocalToc <) const =0 |
virtual | ~DefinitionMutable ()=default |
Public 成员函数 继承自 Definition | |
virtual CodeSymbolType | codeSymbolType () const =0 |
virtual bool | isAlias () const =0 |
virtual bool | isAnonymous () const =0 |
virtual QCString | localName () const =0 |
virtual QCString | qualifiedName () const =0 |
virtual QCString | symbolName () const =0 |
virtual QCString | getSourceAnchor () const =0 |
virtual QCString | documentation () const =0 |
virtual int | docLine () const =0 |
virtual QCString | docFile () const =0 |
virtual QCString | briefDescription (bool abbreviate=FALSE) const =0 |
virtual QCString | briefDescriptionAsTooltip () const =0 |
virtual int | briefLine () const =0 |
virtual QCString | inbodyDocumentation () const =0 |
virtual QCString | inbodyFile () const =0 |
virtual int | inbodyLine () const =0 |
virtual QCString | briefFile () const =0 |
virtual QCString | getDefFileName () const =0 |
virtual QCString | getDefFileExtension () const =0 |
virtual int | getDefLine () const =0 |
virtual int | getDefColumn () const =0 |
virtual bool | hasDocumentation () const =0 |
virtual bool | hasUserDocumentation () const =0 |
virtual bool | isVisibleInProject () const =0 |
virtual bool | isVisible () const =0 |
virtual bool | isHidden () const =0 |
virtual bool | isArtificial () const =0 |
virtual QCString | getReference () const =0 |
virtual bool | isReference () const =0 |
virtual QCString | externalReference (const QCString &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. 更多... | |
virtual const GroupList & | partOfGroups () const =0 |
virtual bool | isLinkableViaGroup () const =0 |
virtual const RefItemVector & | xrefListItems () const =0 |
virtual const Definition * | findInnerCompound (const QCString &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 QCString | id () const =0 |
virtual const SectionRefs & | getSectionRefs () const =0 |
returns the section dictionary, only of importance for pagedef 更多... | |
virtual QCString | navigationPathAsString () const =0 |
virtual QCString | pathFragment () const =0 |
virtual void | _setSymbolName (const QCString &name)=0 |
virtual QCString | _symbolName () const =0 |
virtual | ~Definition ()=default |
额外继承的成员函数 | |
Public 类型 继承自 Definition | |
enum | DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 } |
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.
|
pure virtual |
Returns the absolute path including the file name.
在 FileDefImpl 内被实现.
被这些函数引用 FileDefImpl::addIncludedByDependency(), FileDefImpl::addIncludeDependency(), addIncludeFile(), addVariableToFile(), DotInclDepGraph::buildGraph(), VhdlDocGen::createFlowChart(), MemberContext::Private::createSourceCode(), DotInclDepGraph::DotInclDepGraph(), DocParser::findAndCopyImage(), findDefineDocumentation(), generateFileSources(), generateXMLForClass(), generateXMLForMember(), SymbolResolver::Private::getResolvedClassRec(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), parseCode(), DocParser::readTextFileByName(), DocbookDocVisitor::visitPost(), XmlDocVisitor::visitPre(), DefinitionImpl::writeInlineCode() , 以及 writeXMLCodeBlock().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 addListReferences().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 addMembersToMemberGroup().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 findUsingDeclarations().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 findUsingDirectives().
|
pure virtual |
Returns the anchor within a page where this item can be found
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 MemberDefImpl::_writeGroupInclude() , 以及 addToIndices().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 combineUsingRelations().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 computeMemberReferences().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 countMembers().
|
pure virtual |
Use this for dynamic inspection of the type of the derived class
实现了 Definition.
在 FileDefImpl 内被实现.
Returns the name of the definition as it appears in the output
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 MemberDefImpl::writeDocumentation().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 distributeMemberGroupDocumentation().
|
pure virtual |
Returns the name as it is used in the documentation
在 FileDefImpl 内被实现.
被这些函数引用 MemberDefImpl::_writeGroupInclude(), PerlModGenerator::addIncludeInfo(), DotInclDepGraph::DotInclDepGraph(), generateFileDocs(), generateFileSources() , 以及 writeIncludeInfo().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 FileContext::Private::version().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 findSectionsInDocumentation().
|
pure virtual |
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateFileSources().
|
pure virtual |
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 DefinitionImpl::navigationPathAsString() , 以及 writePartialFilePath().
|
pure virtual |
|
pure virtual |
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateXMLForFile().
|
pure virtual |
|
pure virtual |
Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 MemberDefImpl::_writeGroupInclude(), DotInclDepGraph::buildGraph(), DotInclDepGraph::DotInclDepGraph(), generateDEFForFile(), generateFileRef(), generateXMLForFile(), MemberDefImpl::getOutputFileBase(), ClassDefImpl::getOutputFileBase(), FileContext::Private::includedByGraph(), FileContext::Private::includeGraph(), FilePair::key(), node2URL(), FileDefImpl::writeIncludeFiles(), writeIncludeInfo(), writeMemberReference(), writePartialFilePath(), writeSingleFileIndex() , 以及 FileDefImpl::writeTagFile().
|
pure virtual |
Returns the absolute path of this file.
在 FileDefImpl 内被实现.
被这些函数引用 findFileDef(), generateDiskNames() , 以及 writeSingleFileIndex().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
Returns the name of the source listing of this definition.
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 DefinitionImpl::_writeSourceRefList(), DotInclDepGraph::buildGraph(), FTVHelp::generateTree(), DefinitionImpl::getSourceFileBase(), node2URL() , 以及 writeSingleFileIndex().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
|
pure virtual |
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 FileContext::Private::hasDetails().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 DotInclDepGraph::DotInclDepGraph().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 DotInclDepGraph::buildGraph(), PerlModGenerator::generatePerlModForFile() , 以及 generateXMLForFile().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 DotInclDepGraph::DotInclDepGraph().
|
pure virtual |
|
pure virtual |
Returns the name of the verbatim copy of this file (if any).
在 FileDefImpl 内被实现.
被这些函数引用 FileDefImpl::writeIncludeFiles() , 以及 writeSingleFileIndex().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 addClassToContext() , 以及 createTagLessInstance().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 addConceptToContext().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 addVariableToFile(), findEnums() , 以及 NamespaceDefImpl::insertMember().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 buildNamespaceList() , 以及 findUsingDirectives().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 fileVisibleInIndex() , 以及 writeSingleFileIndex().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 MemberDefImpl::_writeGroupInclude(), addMemberToSearchIndex(), DotInclDepGraph::buildGraph(), fileVisibleInIndex(), findMembersWithSpecificName(), generateFileRef(), getDefs(), resolveLink(), FileDefImpl::writeIncludeFiles(), writePartialFilePath() , 以及 FileDefImpl::writeTagFile().
|
pure virtual |
Returns TRUE iff it is possible to link to this item within this project.
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 MemberDefImpl::_computeLinkableInProject(), addFileMemberNameToIndex(), addToIndices(), GlobalsIndexContext::Private::createMembersFiltered(), fileVisibleInIndex(), generateFileDocs(), ClassDefImpl::isEmbeddedInOuterScope(), writeSingleFileIndex() , 以及 writeTagFile().
|
pure virtual |
Returns TRUE if this file is a source file.
在 FileDefImpl 内被实现.
被这些函数引用 generateFileSources(), parseFilesMultiThreading() , 以及 parseFilesSingleThreading().
|
pure virtual |
Returns the unique file name (this may include part of the path).
实现了 Definition.
在 FileDefImpl 内被实现.
被这些函数引用 addIncludeFile(), DocSets::addIndexItem(), compareFileDefs(), DefinitionContext< FileContext::Private >::DefinitionContext(), DocParser::findAndCopyImage(), findEnumDocumentation(), findUsingDeclarations(), generateDEFForFile(), PerlModGenerator::generatePerlModForFile(), generateXMLForFile(), getDefs(), isVarWithConstructor(), writeFileLinkForMember(), writePartialFilePath(), writeSingleFileIndex(), DefinitionImpl::writeSourceDef(), FileDefImpl::writeTagFile() , 以及 TooltipManager::writeTooltips().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateFileSources().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateDiskNames().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 sortMemberLists().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 FileContext::Private::title().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateFileDocs().
|
pure virtual |
在 FileDefImpl 内被实现.
|
pure virtual |
实现了 DefinitionMutable.
在 DefinitionMixin< FileDef > , 以及 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateFileSources().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateFileSources().
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 generateFileSources().
|
pure virtual |
实现了 DefinitionMutable.
在 DefinitionMixin< FileDef > , 以及 FileDefImpl 内被实现.
|
pure virtual |
在 FileDefImpl 内被实现.
被这些函数引用 writeTagFile().