doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

FileDef Class Referenceabstract

A model of a file symbol. More...

#include <filedef.h>

+ Inheritance diagram for FileDef:
+ Collaboration diagram for FileDef:

Public Member Functions

 ~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 QCStringdocName () const =0
 
virtual bool isSource () const =0
 
virtual bool isDocumentationFile () const =0
 
virtual DefinitiongetSourceDefinition (int lineNr) const =0
 
virtual MemberDefgetSourceMember (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 DirDefgetDirDef () const =0
 
virtual NamespaceSDictgetUsedNamespaces () const =0
 
virtual SDict< Definition > * getUsedClasses () const =0
 
virtual QList< IncludeInfo > * includeFileList () const =0
 
virtual QList< IncludeInfo > * includedByFileList () const =0
 
virtual void getAllIncludeFilesRecursively (QStrList &incFiles) const =0
 
virtual MemberListgetMemberList (MemberListType lt) const =0
 
virtual const QList< MemberList > & getMemberLists () const =0
 
virtual MemberGroupSDictgetMemberGroupSDict () const =0
 
virtual NamespaceSDictgetNamespaceSDict () const =0
 
virtual ClassSDictgetClassSDict () 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, Definition *d, 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 (FTextStream &t)=0
 
virtual void startParsing ()=0
 
virtual void writeSource (OutputList &ol, bool sameTu, QStrList &filesInSameTu)=0
 
virtual void parseSource (bool sameTu, QStrList &filesInSameTu)=0
 
virtual void finishParsing ()=0
 
virtual void setDiskName (const QCString &name)=0
 
virtual void insertMember (MemberDef *md)=0
 
virtual void insertClass (ClassDef *cd)=0
 
virtual void insertNamespace (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 (Definition *def)=0
 
virtual void combineUsingRelations ()=0
 
virtual bool generateSourceFile () const =0
 
virtual void sortMemberLists ()=0
 
virtual void addIncludeDependency (FileDef *fd, const char *incName, bool local, bool imported, bool indirect)=0
 
virtual void addIncludedByDependency (FileDef *fd, const char *incName, bool local, bool imported)=0
 
virtual void addMembersToMemberGroup ()=0
 
virtual void distributeMemberGroupDocumentation ()=0
 
virtual void findSectionsInDocumentation ()=0
 
virtual void addIncludedUsingDirectives ()=0
 
virtual void addListReferences ()=0
 
virtual void setVisited (bool v)=0
 
virtual bool isVisited () const =0
 
- Public Member Functions inherited from Definition
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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. More...
 
virtual GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const std::vector< RefItem * > & xrefListItems () const =0
 
virtual DefinitionfindInnerCompound (const char *name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual MemberSDictgetReferencesMembers () const =0
 
virtual MemberSDictgetReferencedByMembers () 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 More...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef More...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual void setName (const char *name)=0
 
virtual void setId (const char *name)=0
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)=0
 
virtual void setDocumentation (const char *d, const char *docFile, int docLine, bool stripWhiteSpace=TRUE)=0
 
virtual void setBriefDescription (const char *b, const char *briefFile, int briefLine)=0
 
virtual void setInbodyDocumentation (const char *d, const char *docFile, int docLine)=0
 
virtual void setReference (const char *r)=0
 
virtual void setBodySegment (int defLine, int bls, int ble)=0
 
virtual void setBodyDef (FileDef *fd)=0
 
virtual void setRefItems (const std::vector< RefItem * > &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 (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 writeSourceDef (OutputList &ol, const char *scopeName) const =0
 
virtual void writeInlineCode (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceRefs (OutputList &ol, const char *scopeName) const =0
 
virtual void writeSourceReffedBy (OutputList &ol, const char *scopeName) const =0
 
virtual void writeNavigationPath (OutputList &ol) const =0
 
virtual void writeDocAnchorsToTagFile (FTextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual void setCookie (Cookie *cookie) const =0
 
virtual Cookiecookie () const =0
 
virtual void _setSymbolName (const QCString &name)=0
 
virtual QCString _symbolName () const =0
 
- Public Member Functions inherited from DefinitionIntf
 DefinitionIntf ()
 
virtual ~DefinitionIntf ()
 

Additional Inherited Members

- Public Types inherited from DefinitionIntf
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeSymbolList = 8
}
 

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.

Definition at line 64 of file filedef.h.

Constructor & Destructor Documentation

◆ ~FileDef()

FileDef::~FileDef ( )
inline

Definition at line 67 of file filedef.h.

Member Function Documentation

◆ absFilePath()

◆ addIncludedByDependency()

virtual void FileDef::addIncludedByDependency ( FileDef fd,
const char *  incName,
bool  local,
bool  imported 
)
pure virtual

Implemented in FileDefImpl.

◆ addIncludeDependency()

virtual void FileDef::addIncludeDependency ( FileDef fd,
const char *  incName,
bool  local,
bool  imported,
bool  indirect 
)
pure virtual

Implemented in FileDefImpl.

◆ addIncludedUsingDirectives()

virtual void FileDef::addIncludedUsingDirectives ( )
pure virtual

◆ addListReferences()

virtual void FileDef::addListReferences ( )
pure virtual

Implemented in FileDefImpl.

◆ addMembersToMemberGroup()

virtual void FileDef::addMembersToMemberGroup ( )
pure virtual

Implemented in FileDefImpl.

◆ addSourceRef()

virtual void FileDef::addSourceRef ( int  line,
Definition d,
MemberDef md 
)
pure virtual

Implemented in FileDefImpl.

Referenced by addSourceReferences().

◆ addUsingDeclaration()

virtual void FileDef::addUsingDeclaration ( Definition def)
pure virtual

Implemented in FileDefImpl.

Referenced by findUsingDeclarations().

◆ addUsingDirective()

virtual void FileDef::addUsingDirective ( const NamespaceDef nd)
pure virtual

Implemented in FileDefImpl.

Referenced by findUsingDirectives().

◆ anchor()

virtual QCString FileDef::anchor ( ) const
pure virtual

Returns the anchor within a page where this item can be found

Implements Definition.

Implemented in FileDefImpl.

Referenced by MemberDefImpl::_writeGroupInclude().

◆ combineUsingRelations()

virtual void FileDef::combineUsingRelations ( )
pure virtual

Implemented in FileDefImpl.

◆ computeAnchors()

virtual void FileDef::computeAnchors ( )
pure virtual

Implemented in FileDefImpl.

◆ countMembers()

virtual void FileDef::countMembers ( )
pure virtual

Implemented in FileDefImpl.

◆ definitionType()

virtual DefType FileDef::definitionType ( ) const
pure virtual

Use this for dynamic inspection of the type of the derived class

Implements DefinitionIntf.

Implemented in FileDefImpl.

◆ displayName()

virtual QCString FileDef::displayName ( bool  includeScope = TRUE) const
pure virtual

Returns the name of the definition as it appears in the output

Implements Definition.

Implemented in FileDefImpl.

Referenced by writeDirTreeNode(), MemberDefImpl::writeDocumentation(), and writeGroupTreeNode().

◆ distributeMemberGroupDocumentation()

virtual void FileDef::distributeMemberGroupDocumentation ( )
pure virtual

Implemented in FileDefImpl.

◆ docName()

virtual const QCString& FileDef::docName ( ) const
pure virtual

◆ fileName()

virtual QCString FileDef::fileName ( ) const
pure virtual

Implemented in FileDefImpl.

◆ fileVersion()

virtual QCString FileDef::fileVersion ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by FileContext::Private::version().

◆ findSectionsInDocumentation()

virtual void FileDef::findSectionsInDocumentation ( )
pure virtual

Implemented in FileDefImpl.

◆ finishParsing()

virtual void FileDef::finishParsing ( )
pure virtual

Implemented in FileDefImpl.

◆ generateSourceFile()

◆ getAllIncludeFilesRecursively()

virtual void FileDef::getAllIncludeFilesRecursively ( QStrList incFiles) const
pure virtual

Implemented in FileDefImpl.

Referenced by parseFile().

◆ getClassSDict()

virtual ClassSDict* FileDef::getClassSDict ( ) const
pure virtual

◆ getDirDef()

virtual DirDef* FileDef::getDirDef ( ) const
pure virtual

◆ getMemberGroupSDict()

virtual MemberGroupSDict* FileDef::getMemberGroupSDict ( ) const
pure virtual

◆ getMemberList()

virtual MemberList* FileDef::getMemberList ( MemberListType  lt) const
pure virtual

◆ getMemberLists()

virtual const QList<MemberList>& FileDef::getMemberLists ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by generateXMLForFile().

◆ getNamespaceSDict()

virtual NamespaceSDict* FileDef::getNamespaceSDict ( ) const
pure virtual

◆ getOutputFileBase()

◆ getPath()

virtual QCString FileDef::getPath ( ) const
pure virtual

Returns the absolute path of this file.

Implemented in FileDefImpl.

Referenced by findFileDef(), ClassDefImpl::showUsedFiles(), and writeSingleFileIndex().

◆ getSourceDefinition()

virtual Definition* FileDef::getSourceDefinition ( int  lineNr) const
pure virtual

Implemented in FileDefImpl.

◆ getSourceFileBase()

virtual QCString FileDef::getSourceFileBase ( ) const
pure virtual

◆ getSourceMember()

virtual MemberDef* FileDef::getSourceMember ( int  lineNr) const
pure virtual

Implemented in FileDefImpl.

◆ getUsedClasses()

virtual SDict<Definition>* FileDef::getUsedClasses ( ) const
pure virtual

◆ getUsedNamespaces()

◆ getVersion()

virtual QCString FileDef::getVersion ( ) const
pure virtual

Returns version of this file.

Implemented in FileDefImpl.

Referenced by format_warn(), ClassDefImpl::showUsedFiles(), and FileContext::Private::versionInfo().

◆ hasDetailedDescription()

virtual bool FileDef::hasDetailedDescription ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by FileContext::Private::hasDetails().

◆ includedByDependencyGraphFileName()

virtual QCString FileDef::includedByDependencyGraphFileName ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by DotInclDepGraph::DotInclDepGraph().

◆ includedByFileList()

virtual QList<IncludeInfo>* FileDef::includedByFileList ( ) const
pure virtual

◆ includeDependencyGraphFileName()

virtual QCString FileDef::includeDependencyGraphFileName ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by DotInclDepGraph::DotInclDepGraph().

◆ includeFileList()

◆ includeName()

virtual QCString FileDef::includeName ( ) const
pure virtual

◆ insertClass()

virtual void FileDef::insertClass ( ClassDef cd)
pure virtual

Implemented in FileDefImpl.

Referenced by addClassToContext(), and createTagLessInstance().

◆ insertMember()

virtual void FileDef::insertMember ( MemberDef md)
pure virtual

◆ insertNamespace()

virtual void FileDef::insertNamespace ( NamespaceDef nd)
pure virtual

Implemented in FileDefImpl.

Referenced by buildNamespaceList(), and findUsingDirectives().

◆ isDocumentationFile()

virtual bool FileDef::isDocumentationFile ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by fileVisibleInIndex(), and writeSingleFileIndex().

◆ isIncluded()

virtual bool FileDef::isIncluded ( const QCString name) const
pure virtual

Implemented in FileDefImpl.

◆ isLinkable()

◆ isLinkableInProject()

virtual bool FileDef::isLinkableInProject ( ) const
pure virtual

◆ isSource()

virtual bool FileDef::isSource ( ) const
pure virtual

Returns TRUE if this file is a source file.

Implemented in FileDefImpl.

Referenced by parseFiles().

◆ isVisited()

virtual bool FileDef::isVisited ( ) const
pure virtual

◆ name()

◆ numDecMembers()

virtual int FileDef::numDecMembers ( ) const
pure virtual

Implemented in FileDefImpl.

◆ numDocMembers()

virtual int FileDef::numDocMembers ( ) const
pure virtual

Implemented in FileDefImpl.

◆ packageDef()

virtual PackageDef* FileDef::packageDef ( ) const
pure virtual

Implemented in FileDefImpl.

◆ parseSource()

virtual void FileDef::parseSource ( bool  sameTu,
QStrList filesInSameTu 
)
pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

◆ setDirDef()

virtual void FileDef::setDirDef ( DirDef dd)
pure virtual

Implemented in FileDefImpl.

Referenced by DirDefImpl::addFile().

◆ setDiskName()

virtual void FileDef::setDiskName ( const QCString name)
pure virtual

Implemented in FileDefImpl.

Referenced by generateDiskNames().

◆ setPackageDef()

virtual void FileDef::setPackageDef ( PackageDef *  pd)
pure virtual

Implemented in FileDefImpl.

◆ setVisited()

virtual void FileDef::setVisited ( bool  v)
pure virtual

Implemented in FileDefImpl.

◆ sortMemberLists()

virtual void FileDef::sortMemberLists ( )
pure virtual

Implemented in FileDefImpl.

◆ startParsing()

virtual void FileDef::startParsing ( )
pure virtual

Implemented in FileDefImpl.

◆ subGrouping()

virtual bool FileDef::subGrouping ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by FileContext::Private::memberGroups().

◆ title()

virtual QCString FileDef::title ( ) const
pure virtual

Implemented in FileDefImpl.

Referenced by FileContext::Private::title().

◆ writeDocumentation()

virtual void FileDef::writeDocumentation ( OutputList ol)
pure virtual

Implemented in FileDefImpl.

◆ writeMemberPages()

virtual void FileDef::writeMemberPages ( OutputList ol)
pure virtual

Implemented in FileDefImpl.

◆ writeQuickMemberLinks()

virtual void FileDef::writeQuickMemberLinks ( OutputList ol,
const MemberDef currentMd 
) const
pure virtual

Implements Definition.

Implemented in FileDefImpl.

◆ writeSource()

virtual void FileDef::writeSource ( OutputList ol,
bool  sameTu,
QStrList filesInSameTu 
)
pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

◆ writeSummaryLinks()

virtual void FileDef::writeSummaryLinks ( OutputList ol) const
pure virtual

Implements Definition.

Implemented in FileDefImpl.

◆ writeTagFile()

virtual void FileDef::writeTagFile ( FTextStream t)
pure virtual

Implemented in FileDefImpl.


The documentation for this class was generated from the following file: