类 FileDefImpl 继承关系图:

FileDefImpl 的协作图:

Public 成员函数
	FileDefImpl (const QCString &p, const QCString &n, const QCString &ref=QCString(), const QCString &dn=QCString())

virtual	~FileDefImpl ()

virtual DefType	definitionType () const

virtual CodeSymbolType	codeSymbolType () const

virtual QCString	name () const

virtual QCString	displayName (bool=TRUE) const

virtual QCString	fileName () const

virtual QCString	getOutputFileBase () const

virtual QCString	anchor () const

virtual QCString	getSourceFileBase () const

virtual QCString	includeName () const

virtual QCString	includeDependencyGraphFileName () const

virtual QCString	includedByDependencyGraphFileName () const

virtual QCString	absFilePath () const

virtual const QCString &	docName () const

virtual bool	isSource () const

virtual bool	isDocumentationFile () const

virtual const Definition *	getSourceDefinition (int lineNr) const

virtual const MemberDef *	getSourceMember (int lineNr) const

virtual QCString	getPath () const

virtual QCString	getVersion () const

virtual bool	isLinkableInProject () const

virtual bool	isLinkable () const

virtual bool	isIncluded (const QCString &name) const

virtual PackageDef *	packageDef () const

virtual DirDef *	getDirDef () const

virtual LinkedRefMap< const NamespaceDef >	getUsedNamespaces () const

virtual LinkedRefMap< const ClassDef >	getUsedClasses () const

virtual const IncludeInfoList &	includeFileList () const

virtual const IncludeInfoList &	includedByFileList () const

virtual void	getAllIncludeFilesRecursively (StringVector &incFiles) const

virtual MemberList *	getMemberList (MemberListType lt) const

virtual const MemberLists &	getMemberLists () const

virtual const MemberGroupList &	getMemberGroups () const

virtual const NamespaceLinkedRefMap &	getNamespaces () const

virtual const ConceptLinkedRefMap &	getConcepts () const

virtual const ClassLinkedRefMap &	getClasses () const

virtual QCString	title () const

virtual bool	hasDetailedDescription () const

virtual QCString	fileVersion () const

virtual bool	subGrouping () const

virtual void	countMembers ()

virtual int	numDocMembers () const

virtual int	numDecMembers () const

virtual void	addSourceRef (int line, const Definition d, const MemberDef md)

virtual void	writeDocumentation (OutputList &ol)

virtual void	writeMemberPages (OutputList &ol)

virtual void	writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const

virtual void	writeSummaryLinks (OutputList &ol) const

virtual void	writeTagFile (TextStream &t)

virtual void	writeSourceHeader (OutputList &ol)

virtual void	writeSourceBody (OutputList &ol, ClangTUParser *clangParser)

virtual void	writeSourceFooter (OutputList &ol)

virtual void	parseSource (ClangTUParser *clangParser)

virtual void	setDiskName (const QCString &name)

virtual void	insertMember (MemberDef *md)

virtual void	insertClass (const ClassDef *cd)

virtual void	insertConcept (const ConceptDef *cd)

virtual void	insertNamespace (const NamespaceDef *nd)

virtual void	computeAnchors ()

virtual void	setPackageDef (PackageDef *pd)

virtual void	setDirDef (DirDef *dd)

virtual void	addUsingDirective (const NamespaceDef *nd)

virtual void	addUsingDeclaration (const ClassDef *cd)

virtual void	combineUsingRelations ()

virtual bool	generateSourceFile () const

virtual void	sortMemberLists ()

virtual void	addIncludeDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)

virtual void	addIncludedByDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)

virtual void	addMembersToMemberGroup ()

virtual void	distributeMemberGroupDocumentation ()

virtual void	findSectionsInDocumentation ()

virtual void	addIncludedUsingDirectives (FileDefSet &visitedFiles)

virtual void	addListReferences ()

Public 成员函数继承自 DefinitionMixin< FileDef >
	DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual	~DefinitionMixin ()

virtual bool	isAlias () const

virtual QCString	name () const

virtual bool	isAnonymous () const

virtual QCString	localName () const

virtual QCString	qualifiedName () const

virtual QCString	symbolName () const

virtual QCString	getSourceFileBase () const

virtual QCString	getSourceAnchor () const

virtual QCString	documentation () const

virtual int	docLine () const

virtual QCString	docFile () const

virtual QCString	briefDescription (bool abbreviate=FALSE) const

virtual QCString	briefDescriptionAsTooltip () const

virtual int	briefLine () const

virtual QCString	inbodyDocumentation () const

virtual QCString	inbodyFile () const

virtual int	inbodyLine () const

virtual QCString	briefFile () const

virtual QCString	getDefFileName () const

virtual QCString	getDefFileExtension () const

virtual int	getDefLine () const

virtual int	getDefColumn () const

virtual bool	hasDocumentation () const

virtual bool	hasUserDocumentation () const

virtual bool	isVisibleInProject () const

virtual bool	isVisible () const

virtual bool	isHidden () const

virtual bool	isArtificial () const

virtual QCString	getReference () const

virtual bool	isReference () const

virtual QCString	externalReference (const QCString &relPath) const

virtual int	getStartDefLine () const

virtual int	getStartBodyLine () const

virtual int	getEndBodyLine () const

virtual const FileDef *	getBodyDef () const

virtual SrcLangExt	getLanguage () const

virtual const GroupList &	partOfGroups () const

virtual bool	isLinkableViaGroup () const

virtual const RefItemVector &	xrefListItems () const

virtual const Definition *	findInnerCompound (const QCString &name) const

virtual Definition *	getOuterScope () const

virtual const MemberVector &	getReferencesMembers () const

virtual const MemberVector &	getReferencedByMembers () const

virtual bool	hasSections () const

virtual bool	hasSources () const

virtual bool	hasBriefDescription () const

virtual QCString	id () const

virtual const SectionRefs &	getSectionRefs () const

virtual void	setName (const QCString &name)

virtual void	setId (const QCString &name)

virtual void	setDefFile (const QCString &df, int defLine, int defColumn)

virtual void	setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)

virtual void	setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)

virtual void	setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)

virtual void	setReference (const QCString &r)

virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)

virtual void	setBodySegment (int defLine, int bls, int ble)

virtual void	setBodyDef (const FileDef *fd)

virtual void	addSourceReferencedBy (const MemberDef *md)

virtual void	addSourceReferences (const MemberDef *md)

virtual void	setRefItems (const RefItemVector &sli)

virtual void	mergeRefItems (Definition *def)

virtual void	mergeReferences (const Definition *other)

virtual void	mergeReferencedBy (const Definition *other)

virtual void	addInnerCompound (const Definition *def)

virtual void	setOuterScope (Definition *def)

virtual void	setHidden (bool b)

virtual void	setArtificial (bool b)

virtual void	setLanguage (SrcLangExt lang)

virtual void	writeSourceDef (OutputList &ol, const QCString &scopeName) const

virtual void	writeInlineCode (OutputList &ol, const QCString &scopeName) const

virtual bool	hasSourceRefs () const

virtual bool	hasSourceReffedBy () const

virtual void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const

virtual void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const

virtual void	makePartOfGroup (const GroupDef *gd)

virtual void	writeNavigationPath (OutputList &ol) const

virtual QCString	navigationPathAsString () const

virtual QCString	pathFragment () const

virtual void	writeDocAnchorsToTagFile (TextStream &fs) const

virtual void	setLocalName (const QCString &name)

virtual void	addSectionsToIndex ()

virtual void	writeToc (OutputList &ol, const LocalToc &lt) const

virtual void	computeTooltip ()

virtual void	_setSymbolName (const QCString &name)

virtual QCString	_symbolName () const

Public 成员函数继承自 FileDef
	~FileDef ()

Public 成员函数继承自 DefinitionMutable
virtual bool	hasSourceRefs () const =0

virtual bool	hasSourceReffedBy () const =0

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 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	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 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 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 QCString	_symbolName () const =0

virtual	~Definition ()=default

Private 成员函数
void	acquireFileVersion ()

void	addMemberToList (MemberListType lt, MemberDef *md)

void	writeMemberDeclarations (OutputList &ol, MemberListType lt, const QCString &title)

void	writeMemberDocumentation (OutputList &ol, MemberListType lt, const QCString &title)

void	writeIncludeFiles (OutputList &ol)

void	writeIncludeGraph (OutputList &ol)

void	writeIncludedByGraph (OutputList &ol)

void	writeMemberGroups (OutputList &ol)

void	writeAuthorSection (OutputList &ol)

void	writeSourceLink (OutputList &ol)

void	writeNamespaceDeclarations (OutputList &ol, const QCString &title, bool isConstantGroup)

void	writeClassDeclarations (OutputList &ol, const QCString &title, const ClassLinkedRefMap &list)

void	writeConcepts (OutputList &ol, const QCString &title)

void	writeInlineClasses (OutputList &ol)

void	startMemberDeclarations (OutputList &ol)

void	endMemberDeclarations (OutputList &ol)

void	startMemberDocumentation (OutputList &ol)

void	endMemberDocumentation (OutputList &ol)

void	writeDetailedDescription (OutputList &ol, const QCString &title)

void	writeBriefDescription (OutputList &ol)

void	writeClassesToTagFile (TextStream &t, const ClassLinkedRefMap &list)

Private 属性
IncludeInfoMap	m_includeMap

IncludeInfoList	m_includeList

IncludeInfoMap	m_includedByMap

IncludeInfoList	m_includedByList

LinkedRefMap< const NamespaceDef >	m_usingDirList

LinkedRefMap< const ClassDef >	m_usingDeclList

QCString	m_path

QCString	m_filePath

QCString	m_inclDepFileName

QCString	m_inclByDepFileName

QCString	m_outputDiskName

QCString	m_fileName

QCString	m_docname

DefinitionLineMap	m_srcDefMap

MemberDefLineMap	m_srcMemberMap

bool	m_isSource

QCString	m_fileVersion

PackageDef *	m_package

DirDef *	m_dir

MemberLists	m_memberLists

MemberGroupList	m_memberGroups

NamespaceLinkedRefMap	m_namespaces

ClassLinkedRefMap	m_classes

ClassLinkedRefMap	m_interfaces

ClassLinkedRefMap	m_structs

ClassLinkedRefMap	m_exceptions

ConceptLinkedRefMap	m_concepts

bool	m_subGrouping

额外继承的成员函数
Public 类型继承自 Definition
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 }

Protected 成员函数继承自 DefinitionMixin< FileDef >
	DefinitionMixin (const DefinitionMixin &def)=default

详细描述

在文件 filedef.cpp 第 56 行定义.

构造及析构函数说明

◆ FileDefImpl()

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 0 otherwise

在文件 filedef.cpp 第 229 行定义.

    : DefinitionMixin((QCString)p+nm,1,1,nm)
 {
   m_path=p;
   m_filePath=m_path+nm;
   m_fileName=nm;
   setReference(lref);
   setDiskName(!dn.isEmpty() ? dn : nm);
   m_package           = 0;
   m_isSource          = guessSection(nm)==Entry::SOURCE_SEC;
   m_docname           = nm;
   m_dir               = 0;
   if (Config_getBool(FULL_PATH_NAMES))
   {
     m_docname.prepend(stripFromPath(m_path));
   }
   setLanguage(getLanguageFromFileName(name()));
   acquireFileVersion();
   m_subGrouping=Config_getBool(SUBGROUPING);
 }

引用了 acquireFileVersion(), Config_getBool, getLanguageFromFileName(), guessSection(), QCString::isEmpty(), m_dir, m_docname, m_fileName, m_filePath, m_isSource, m_package, m_path, m_subGrouping, name(), QCString::prepend(), setDiskName(), DefinitionMixin< FileDef >::setLanguage(), DefinitionMixin< FileDef >::setReference(), Entry::SOURCE_SEC , 以及 stripFromPath().

◆ ~FileDefImpl()

FileDefImpl::~FileDefImpl ( )

virtual

destroy the file definition

在文件 filedef.cpp 第 252 行定义.

253 {

254 }

成员函数说明

◆ absFilePath()

virtual QCString FileDefImpl::absFilePath ( ) const

inlinevirtual

Returns the absolute path including the file name.

实现了 FileDef.

在文件 filedef.cpp 第 74 行定义.

74 { return m_filePath; }

引用了 m_filePath.

被这些函数引用 parseSource() , 以及 writeSourceBody().

◆ acquireFileVersion()

void FileDefImpl::acquireFileVersion ( )

private

在文件 filedef.cpp 第 1544 行定义.

 {
   QCString vercmd = Config_getString(FILE_VERSION_FILTER);
   if (!vercmd.isEmpty() && !m_filePath.isEmpty() &&
       m_filePath!="generated" && m_filePath!="graph_legend")
   {
     msg("Version of %s : ",qPrint(m_filePath));
     QCString cmd = vercmd+" \""+m_filePath+"\"";
     Debug::print(Debug::ExtCmd,0,"Executing popen(`%s`)\n",qPrint(cmd));
     FILE *f=Portable::popen(cmd,"r");
     if (!f)
     {
       err("could not execute %s\n",qPrint(vercmd));
       return;
     }
     const int bufSize=1024;
     char buf[bufSize];
     int numRead = (int)fread(buf,1,bufSize-1,f);
     Portable::pclose(f);
     if (numRead>0 && numRead<bufSize)
     {
       buf[numRead]='\0';
       m_fileVersion=QCString(buf,numRead).stripWhiteSpace();
       if (!m_fileVersion.isEmpty())
       {
         msg("%s\n",qPrint(m_fileVersion));
         return;
       }
     }
     msg("no version available\n");
   }
 }

引用了 Config_getString, err(), Debug::ExtCmd, QCString::isEmpty(), m_filePath, m_fileVersion, msg(), Portable::pclose(), Portable::popen(), Debug::print(), qPrint() , 以及 QCString::stripWhiteSpace().

被这些函数引用 FileDefImpl().

◆ addIncludedByDependency()

void FileDefImpl::addIncludedByDependency	(	const FileDef *	fd,
		const QCString &	incName,
		bool	local,
		bool	imported
	)

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1449 行定义.

 {
   //printf("FileDefImpl::addIncludedByDependency(%p,%s,%d)\n",fd,incName,local);
   QCString iName = fd ? fd->absFilePath() : incName;
   if (!iName.isEmpty() && m_includedByMap.find(iName.str())==m_includedByMap.end())
   {
     m_includedByList.emplace_back(fd,incName,local,imported);
     m_includedByMap.insert(std::make_pair(iName.str(),&m_includedByList.back()));
   }
 }

引用了 FileDef::absFilePath(), QCString::isEmpty(), m_includedByList, m_includedByMap , 以及 QCString::str().

◆ addIncludeDependency()

void FileDefImpl::addIncludeDependency	(	const FileDef *	fd,
		const QCString &	incName,
		bool	local,
		bool	imported
	)

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1391 行定义.

 {
   //printf("FileDefImpl::addIncludeDependency(%p,%s,%d)\n",fd,incName,local);
   QCString iName = fd ? fd->absFilePath() : incName;
   if (!iName.isEmpty() && m_includeMap.find(iName.str())==m_includeMap.end())
   {
     m_includeList.emplace_back(fd,incName,local,imported);
     m_includeMap.insert(std::make_pair(iName.str(),&m_includeList.back()));
   }
 }

引用了 FileDef::absFilePath(), QCString::isEmpty(), m_includeList, m_includeMap , 以及 QCString::str().

◆ addIncludedUsingDirectives()

void FileDefImpl::addIncludedUsingDirectives ( FileDefSet & visitedFiles )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1402 行定义.

 {
   if (visitedFiles.find(this)!=visitedFiles.end()) return; // file already processed
   visitedFiles.insert(this);
   //printf("( FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
  
   if (!m_includeList.empty()) // file contains #includes
   {
     {
       for (const auto &ii : m_includeList) // foreach #include...
       {
         if (ii.fileDef) // ...that is a known file
         {
           // recurse into this file
           const_cast<FileDef*>(ii.fileDef)->addIncludedUsingDirectives(visitedFiles);
         }
       }
     }
     {
       // iterate through list from last to first
       for (auto ii_it = m_includeList.rbegin(); ii_it!=m_includeList.rend(); ++ii_it)
       {
         const auto &ii = *ii_it;
         if (ii.fileDef && ii.fileDef!=this)
         {
           // add using directives
           auto unl = ii.fileDef->getUsedNamespaces();
           for (auto it = unl.rbegin(); it!=unl.rend(); ++it)
           {
             const auto *nd = *it;
             m_usingDirList.prepend(nd->qualifiedName(),nd);
           }
           // add using declarations
           auto  udl = ii.fileDef->getUsedClasses();
           for (auto it = udl.rbegin(); it!=udl.rend(); ++it)
           {
             const auto *cd = *it;
             m_usingDeclList.prepend(cd->qualifiedName(),cd);
           }
         }
       }
     }
   }
   //printf(") end FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
 }

引用了 m_includeList, m_usingDeclList, m_usingDirList , 以及 LinkedRefMap< T, Hash, KeyEqual, Map >::prepend().

◆ addListReferences()

void FileDefImpl::addListReferences ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1479 行定义.

 {
   {
     const RefItemVector &xrefItems = xrefListItems();
     addRefItem(xrefItems,
                getOutputFileBase(),
                theTranslator->trFile(TRUE,TRUE),
                getOutputFileBase(),name(),
                QCString(),
                0
               );
   }
   for (const auto &mg : m_memberGroups)
   {
     mg->addListReferences(this);
   }
   for (auto &ml : m_memberLists)
   {
     if (ml->listType()&MemberListType_documentationLists)
     {
       ml->addListReferences(this);
     }
   }
 }

引用了 addRefItem(), getOutputFileBase(), m_memberGroups, m_memberLists, MemberListType_documentationLists, name(), theTranslator, Translator::trFile(), TRUE , 以及 DefinitionMixin< FileDef >::xrefListItems().

◆ addMembersToMemberGroup()

void FileDefImpl::addMembersToMemberGroup ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1217 行定义.

 {
   for (auto &ml : m_memberLists)
   {
     if (ml->listType()&MemberListType_declarationLists)
     {
       ::addMembersToMemberGroup(ml.get(),&m_memberGroups,this);
     }
   }
  
   // add members inside sections to their groups
   for (const auto &mg : m_memberGroups)
   {
     if (mg->allMembersInSameSection() && m_subGrouping)
     {
       //printf("----> addToDeclarationSection(%s)\n",qPrint(mg->header()));
       mg->addToDeclarationSection();
     }
   }
 }

引用了 m_memberGroups, m_memberLists, m_subGrouping , 以及 MemberListType_declarationLists.

◆ addMemberToList()

void FileDefImpl::addMemberToList	(	MemberListType	lt,
		MemberDef *	md
	)

private

在文件 filedef.cpp 第 1601 行定义.

 {
   static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
   static bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
   const auto &ml = m_memberLists.get(lt,MemberListContainer::File);
   ml->setNeedsSorting(
        ((ml->listType()&MemberListType_declarationLists) && sortBriefDocs) ||
        ((ml->listType()&MemberListType_documentationLists) && sortMemberDocs));
   ml->push_back(md);
   if (ml->listType()&MemberListType_declarationLists)
   {
     MemberDefMutable *mdm = toMemberDefMutable(md);
     if (mdm)
     {
       mdm->setSectionList(this,ml.get());
     }
   }
 }

引用了 Config_getBool, File, MemberLists::get(), m_memberLists, MemberListType_declarationLists, MemberListType_documentationLists, MemberDefMutable::setSectionList() , 以及 toMemberDefMutable().

被这些函数引用 insertMember().

◆ addSourceRef()

void FileDefImpl::addSourceRef	(	int	line,
		const Definition *	d,
		const MemberDef *	md
	)

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1347 行定义.

 {
   //printf("FileDefImpl::addSourceDef(%d,%p,%p)\n",line,d,md);
   if (d)
   {
     m_srcDefMap.insert(std::make_pair(line,d));
     if (md) m_srcMemberMap.insert(std::make_pair(line,md));
     //printf("Adding member %s with anchor %s at line %d to file %s\n",
     //    md?qPrint(md->name()):"<none>",md?qPrint(md->anchor()):"<none>",line,qPrint(name()));
   }
 }

引用了 m_srcDefMap , 以及 m_srcMemberMap.

◆ addUsingDeclaration()

void FileDefImpl::addUsingDeclaration ( const ClassDef * cd )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1386 行定义.

 {
   m_usingDeclList.add(cd->qualifiedName(),cd);
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDeclList , 以及 Definition::qualifiedName().

被这些函数引用 combineUsingRelations().

◆ addUsingDirective()

void FileDefImpl::addUsingDirective ( const NamespaceDef * nd )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1374 行定义.

 {
   m_usingDirList.add(nd->qualifiedName(),nd);
   //printf("%p: FileDefImpl::addUsingDirective: %s:%d\n",this,qPrint(name()),usingDirList->count());
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDirList , 以及 Definition::qualifiedName().

被这些函数引用 combineUsingRelations().

◆ anchor()

virtual QCString FileDefImpl::anchor ( ) const

inlinevirtual

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

实现了 FileDef.

在文件 filedef.cpp 第 69 行定义.

69 { return QCString(); }

◆ codeSymbolType()

virtual CodeSymbolType FileDefImpl::codeSymbolType ( ) const

inlinevirtual

Used for syntax highlighting symbol class

实现了 Definition.

在文件 filedef.cpp 第 63 行定义.

63 { return CodeSymbolType::Default; }

引用了 Default.

◆ combineUsingRelations()

void FileDefImpl::combineUsingRelations ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1506 行定义.

 {
   LinkedRefMap<const NamespaceDef> usingDirList = m_usingDirList;
   NamespaceDefSet visitedNamespaces;
   for (auto &nd : usingDirList)
   {
     NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);
     if (ndm)
     {
       ndm->combineUsingRelations(visitedNamespaces);
     }
   }
  
   for (auto &nd : usingDirList)
   {
     // add used namespaces of namespace nd to this namespace
     for (const auto &und : nd->getUsedNamespaces())
     {
       addUsingDirective(und);
     }
     // add used classes of namespace nd to this namespace
     for (const auto &ucd : nd->getUsedClasses())
     {
       addUsingDeclaration(ucd);
     }
   }
 }

引用了 addUsingDeclaration(), addUsingDirective(), NamespaceDefMutable::combineUsingRelations(), m_usingDirList , 以及 toNamespaceDefMutable().

◆ computeAnchors()

void FileDefImpl::computeAnchors ( )

virtual

Compute the HTML anchor names for all members in the class

实现了 FileDef.

在文件 filedef.cpp 第 273 行定义.

 {
   MemberList *ml = getMemberList(MemberListType_allMembersList);
   if (ml) ml->setAnchors();
 }

引用了 getMemberList(), MemberListType_allMembersList , 以及 MemberList::setAnchors().

◆ countMembers()

void FileDefImpl::countMembers ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1743 行定义.

 {
   for (auto &ml : m_memberLists)
   {
     ml->countDecMembers();
     ml->countDocMembers();
   }
   for (const auto &mg : m_memberGroups)
   {
     mg->countDecMembers();
     mg->countDocMembers();
   }
 }

引用了 m_memberGroups , 以及 m_memberLists.

◆ definitionType()

virtual DefType FileDefImpl::definitionType ( ) const

inlinevirtual

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

实现了 FileDef.

在文件 filedef.cpp 第 62 行定义.

62 { return TypeFile; }

引用了 Definition::TypeFile.

◆ displayName()

virtual QCString FileDefImpl::displayName ( bool includeScope = TRUE ) const

inlinevirtual

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

实现了 FileDef.

在文件 filedef.cpp 第 66 行定义.

66 { return name(); }

引用了 name().

◆ distributeMemberGroupDocumentation()

void FileDefImpl::distributeMemberGroupDocumentation ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 279 行定义.

 {
   //printf("FileDefImpl::distributeMemberGroupDocumentation()\n");
   for (const auto &mg : m_memberGroups)
   {
     mg->distributeMemberGroupDocumentation();
   }
 }

引用了 m_memberGroups.

◆ docName()

virtual const QCString& FileDefImpl::docName ( ) const

inlinevirtual

Returns the name as it is used in the documentation

实现了 FileDef.

在文件 filedef.cpp 第 75 行定义.

75 { return m_docname; }

引用了 m_docname.

◆ endMemberDeclarations()

void FileDefImpl::endMemberDeclarations ( OutputList & ol )

private

在文件 filedef.cpp 第 695 行定义.

 {
   ol.endMemberSections();
 }

引用了 OutputList::endMemberSections().

被这些函数引用 writeDocumentation().

◆ endMemberDocumentation()

void FileDefImpl::endMemberDocumentation ( OutputList & ol )

private

在文件 filedef.cpp 第 709 行定义.

 {
   if (Config_getBool(SEPARATE_MEMBER_PAGES))
   {
     ol.enable(OutputGenerator::Html);
     Doxygen::suppressDocWarnings = FALSE;
   }
 }

引用了 Config_getBool, OutputList::enable(), FALSE, OutputGenerator::Html , 以及 Doxygen::suppressDocWarnings.

被这些函数引用 writeDocumentation().

◆ fileName()

virtual QCString FileDefImpl::fileName ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 67 行定义.

67 { return m_fileName; }

引用了 m_fileName.

◆ fileVersion()

QCString FileDefImpl::fileVersion ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1728 行定义.

 {
   return m_fileVersion;
 }

引用了 m_fileVersion.

◆ findSectionsInDocumentation()

void FileDefImpl::findSectionsInDocumentation ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 288 行定义.

 {
   docFindSections(briefDescription(),this,docFile());
   docFindSections(documentation(),this,docFile());
   for (const auto &mg : m_memberGroups)
   {
     mg->findSectionsInDocumentation(this);
   }
  
   for (auto &ml : m_memberLists)
   {
     if (ml->listType()&MemberListType_declarationLists)
     {
       ml->findSectionsInDocumentation(this);
     }
   }
 }

引用了 DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::docFile(), docFindSections(), DefinitionMixin< FileDef >::documentation(), m_memberGroups, m_memberLists , 以及 MemberListType_declarationLists.

◆ generateSourceFile()

bool FileDefImpl::generateSourceFile ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1467 行定义.

 {
   static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
   static bool verbatimHeaders = Config_getBool(VERBATIM_HEADERS);
   return !isReference() &&
          (sourceBrowser ||
            (verbatimHeaders && guessSection(name())==Entry::HEADER_SEC)
          ) &&
          !isDocumentationFile();
 }

引用了 Config_getBool, guessSection(), Entry::HEADER_SEC, isDocumentationFile(), DefinitionMixin< FileDef >::isReference() , 以及 name().

被这些函数引用 writeSourceHeader() , 以及 writeSourceLink().

◆ getAllIncludeFilesRecursively()

void FileDefImpl::getAllIncludeFilesRecursively ( StringVector & incFiles ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1717 行定义.

 {
   StringUnorderedSet includes;
   ::getAllIncludeFilesRecursively(includes,this,incFiles);
 }

◆ getClasses()

virtual const ClassLinkedRefMap& FileDefImpl::getClasses ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 97 行定义.

97 { return m_classes; }

引用了 m_classes.

◆ getConcepts()

virtual const ConceptLinkedRefMap& FileDefImpl::getConcepts ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 96 行定义.

96 { return m_concepts; }

引用了 m_concepts.

◆ getDirDef()

virtual DirDef* FileDefImpl::getDirDef ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 86 行定义.

86 { return m_dir; }

引用了 m_dir.

被这些函数引用 writeDocumentation() , 以及 writeSourceHeader().

◆ getMemberGroups()

virtual const MemberGroupList& FileDefImpl::getMemberGroups ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 94 行定义.

94 { return m_memberGroups; }

引用了 m_memberGroups.

◆ getMemberList()

MemberList * FileDefImpl::getMemberList ( MemberListType lt ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1659 行定义.

 {
   for (auto &ml : m_memberLists)
   {
     if (ml->listType()==lt)
     {
       return ml.get();
     }
   }
   return 0;
 }

引用了 m_memberLists.

被这些函数引用 computeAnchors(), insertMember(), numDecMembers(), numDocMembers(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeQuickMemberLinks(), writeSummaryLinks() , 以及 writeTagFile().

◆ getMemberLists()

virtual const MemberLists& FileDefImpl::getMemberLists ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 93 行定义.

93 { return m_memberLists; }

引用了 m_memberLists.

◆ getNamespaces()

virtual const NamespaceLinkedRefMap& FileDefImpl::getNamespaces ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 95 行定义.

95 { return m_namespaces; }

引用了 m_namespaces.

◆ getOutputFileBase()

QCString FileDefImpl::getOutputFileBase ( ) const

virtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

实现了 FileDef.

在文件 filedef.cpp 第 1590 行定义.

 {
   return m_outputDiskName;
 }

引用了 m_outputDiskName.

被这些函数引用 addListReferences(), writeDocumentation(), writeSourceHeader() , 以及 writeTagFile().

◆ getPath()

virtual QCString FileDefImpl::getPath ( ) const

inlinevirtual

Returns the absolute path of this file.

实现了 FileDef.

在文件 filedef.cpp 第 80 行定义.

80 { return m_path; }

引用了 m_path.

被这些函数引用 writeTagFile().

◆ getSourceDefinition()

const Definition * FileDefImpl::getSourceDefinition ( int lineNr ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1359 行定义.

 {
   auto it = m_srcDefMap.find(lineNr);
   //printf("%s::getSourceDefinition(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcDefMap.end()?qPrint(it->second->name()):"none");
   return it!=m_srcDefMap.end() ? it->second : 0;
 }

引用了 m_srcDefMap.

◆ getSourceFileBase()

QCString FileDefImpl::getSourceFileBase ( ) const

virtual

Returns the name of the source listing of this definition.

实现了 FileDef.

在文件 filedef.cpp 第 1578 行定义.

 {
   if (Htags::useHtags)
   {
     return Htags::path2URL(m_filePath);
   }
   else
   {
     return m_outputDiskName+"_source";
   }
 }

引用了 m_filePath, m_outputDiskName, Htags::path2URL() , 以及 Htags::useHtags.

被这些函数引用 includeName(), writeDetailedDescription() , 以及 writeSourceHeader().

◆ getSourceMember()

const MemberDef * FileDefImpl::getSourceMember ( int lineNr ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1366 行定义.

 {
   auto it = m_srcMemberMap.find(lineNr);
   //printf("%s::getSourceMember(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcMemberMap.end()?qPrint(it->second->name()):"none");
   return it!=m_srcMemberMap.end() ? it->second : 0;
 }

引用了 m_srcMemberMap.

◆ getUsedClasses()

virtual LinkedRefMap<const ClassDef> FileDefImpl::getUsedClasses ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 88 行定义.

88 { return m_usingDeclList; }

引用了 m_usingDeclList.

◆ getUsedNamespaces()

LinkedRefMap< const NamespaceDef > FileDefImpl::getUsedNamespaces ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1380 行定义.

 {
   //printf("%p: FileDefImpl::getUsedNamespace: %s:%d\n",this,qPrint(name()),usingDirList?usingDirList->count():0);
   return m_usingDirList;
 }

引用了 m_usingDirList.

◆ getVersion()

virtual QCString FileDefImpl::getVersion ( ) const

inlinevirtual

Returns version of this file.

实现了 FileDef.

在文件 filedef.cpp 第 81 行定义.

81 { return m_fileVersion; }

引用了 m_fileVersion.

◆ hasDetailedDescription()

bool FileDefImpl::hasDetailedDescription ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 306 行定义.

 {
   static bool repeatBrief = Config_getBool(REPEAT_BRIEF);
   static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
   return ((!briefDescription().isEmpty() && repeatBrief) ||
           !documentation().stripWhiteSpace().isEmpty() || // avail empty section
           (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef())
          );
 }

引用了 DefinitionMixin< FileDef >::briefDescription(), Config_getBool, DefinitionMixin< FileDef >::documentation(), DefinitionMixin< FileDef >::getBodyDef() , 以及 DefinitionMixin< FileDef >::getStartBodyLine().

被这些函数引用 writeDetailedDescription().

◆ includedByDependencyGraphFileName()

QCString FileDefImpl::includedByDependencyGraphFileName ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1738 行定义.

 {
   return m_inclByDepFileName;
 }

引用了 m_inclByDepFileName.

◆ includedByFileList()

virtual const IncludeInfoList& FileDefImpl::includedByFileList ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 90 行定义.

90 { return m_includedByList; }

引用了 m_includedByList.

◆ includeDependencyGraphFileName()

QCString FileDefImpl::includeDependencyGraphFileName ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1733 行定义.

 {
   return m_inclDepFileName;
 }

引用了 m_inclDepFileName.

◆ includeFileList()

virtual const IncludeInfoList& FileDefImpl::includeFileList ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 89 行定义.

89 { return m_includeList; }

引用了 m_includeList.

◆ includeName()

QCString FileDefImpl::includeName ( ) const

virtual

Returns the name of the verbatim copy of this file (if any).

实现了 FileDef.

在文件 filedef.cpp 第 1596 行定义.

 {
   return getSourceFileBase();
 }

引用了 getSourceFileBase().

被这些函数引用 writeSourceLink().

◆ insertClass()

void FileDefImpl::insertClass ( const ClassDef * cd )

virtual

Adds compound definition cd to the list of all compounds of this file

实现了 FileDef.

在文件 filedef.cpp 第 1301 行定义.

 {
   if (cd->isHidden()) return;
  
   ClassLinkedRefMap &list = m_classes;
  
   if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
   {
     if (cd->compoundType()==ClassDef::Interface)
     {
       list = m_interfaces;
     }
     else if (cd->compoundType()==ClassDef::Struct)
     {
       list = m_structs;
     }
     else if (cd->compoundType()==ClassDef::Exception)
     {
       list = m_exceptions;
     }
   }
  
   list.add(cd->name(),cd);
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), ClassDef::compoundType(), Config_getBool, ClassDef::Exception, ClassDef::Interface, Definition::isHidden(), m_classes, m_exceptions, m_interfaces, m_structs, Definition::name() , 以及 ClassDef::Struct.

◆ insertConcept()

void FileDefImpl::insertConcept ( const ConceptDef * cd )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1326 行定义.

 {
   if (cd->isHidden()) return;
   m_concepts.add(cd->name(),cd);
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::isHidden(), m_concepts , 以及 Definition::name().

◆ insertMember()

void FileDefImpl::insertMember ( MemberDef * md )

virtual

Adds member definition md to the list of all members of this file

实现了 FileDef.

在文件 filedef.cpp 第 1239 行定义.

 {
   if (md->isHidden()) return;
   //printf("%s:FileDefImpl::insertMember(%s (=%p) list has %d elements)\n",
   //    qPrint(name()),qPrint(md->name()),md,allMemberList.count());
   MemberList *allMemberList = getMemberList(MemberListType_allMembersList);
   if (allMemberList && allMemberList->contains(md))
   {
     return;
   }
  
   if (allMemberList==0)
   {
     m_memberLists.emplace_back(std::make_unique<MemberList>(MemberListType_allMembersList,MemberListContainer::File));
     allMemberList = m_memberLists.back().get();
   }
   allMemberList->push_back(md);
   //::addFileMemberNameToIndex(md);
   switch (md->memberType())
   {
     case MemberType_Variable:
     case MemberType_Property:
       addMemberToList(MemberListType_decVarMembers,md);
       addMemberToList(MemberListType_docVarMembers,md);
       break;
     case MemberType_Function:
       addMemberToList(MemberListType_decFuncMembers,md);
       addMemberToList(MemberListType_docFuncMembers,md);
       break;
     case MemberType_Typedef:
       addMemberToList(MemberListType_decTypedefMembers,md);
       addMemberToList(MemberListType_docTypedefMembers,md);
       break;
     case MemberType_Sequence:
       addMemberToList(MemberListType_decSequenceMembers,md);
       addMemberToList(MemberListType_docSequenceMembers,md);
       break;
     case MemberType_Dictionary:
       addMemberToList(MemberListType_decDictionaryMembers,md);
       addMemberToList(MemberListType_docDictionaryMembers,md);
       break;
     case MemberType_Enumeration:
       addMemberToList(MemberListType_decEnumMembers,md);
       addMemberToList(MemberListType_docEnumMembers,md);
       break;
     case MemberType_EnumValue:    // enum values are shown inside their enums
       break;
     case MemberType_Define:
       addMemberToList(MemberListType_decDefineMembers,md);
       addMemberToList(MemberListType_docDefineMembers,md);
       break;
     default:
        err("FileDefImpl::insertMembers(): "
            "member '%s' with class scope '%s' inserted in file scope '%s'!\n",
            qPrint(md->name()),
            md->getClassDef() ? qPrint(md->getClassDef()->name()) : "<global>",
            qPrint(name()));
   }
   //addMemberToGroup(md,groupId);
 }

◆ insertNamespace()

void FileDefImpl::insertNamespace ( const NamespaceDef * nd )

virtual

Adds namespace definition nd to the list of all compounds of this file

实现了 FileDef.

在文件 filedef.cpp 第 1333 行定义.

 {
   if (nd->isHidden()) return;
   m_namespaces.add(nd->name(),nd);
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::isHidden(), m_namespaces , 以及 Definition::name().

◆ isDocumentationFile()

bool FileDefImpl::isDocumentationFile ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1534 行定义.

 {
   return name().right(4)==".doc" ||
          name().right(4)==".txt" ||
          name().right(4)==".dox" ||
          name().right(3)==".md"  ||
          name().right(9)==".markdown" ||
          getLanguageFromFileName(getFileNameExtension(name())) == SrcLangExt_Markdown;
 }

引用了 getFileNameExtension(), getLanguageFromFileName(), name(), QCString::right() , 以及 SrcLangExt_Markdown.

被这些函数引用 generateSourceFile() , 以及 writeSourceHeader().

◆ isIncluded()

bool FileDefImpl::isIncluded ( const QCString & name ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1461 行定义.

 {
   if (name.isEmpty()) return FALSE;
   return m_includeMap.find(name.str())!=m_includeMap.end();
 }

引用了 FALSE, QCString::isEmpty(), m_includeMap, name() , 以及 QCString::str().

◆ isLinkable()

virtual bool FileDefImpl::isLinkable ( ) const

inlinevirtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

实现了 FileDef.

在文件 filedef.cpp 第 83 行定义.

83 { return isLinkableInProject() || isReference(); }

引用了 isLinkableInProject() , 以及 DefinitionMixin< FileDef >::isReference().

被这些函数引用 writeSourceHeader().

◆ isLinkableInProject()

bool FileDefImpl::isLinkableInProject ( ) const

virtual

Returns TRUE iff it is possible to link to this item within this project.

实现了 FileDef.

在文件 filedef.cpp 第 1695 行定义.

 {
   static bool showFiles = Config_getBool(SHOW_FILES);
   return hasDocumentation() && !isReference() && (showFiles || isLinkableViaGroup());
 }

引用了 Config_getBool, DefinitionMixin< FileDef >::hasDocumentation(), DefinitionMixin< FileDef >::isLinkableViaGroup() , 以及 DefinitionMixin< FileDef >::isReference().

被这些函数引用 isLinkable().

◆ isSource()

virtual bool FileDefImpl::isSource ( ) const

inlinevirtual

Returns TRUE if this file is a source file.

实现了 FileDef.

在文件 filedef.cpp 第 76 行定义.

76 { return m_isSource; }

引用了 m_isSource.

◆ name()

QCString FileDefImpl::name ( ) const

virtual

Returns the unique file name (this may include part of the path).

实现了 FileDef.

在文件 filedef.cpp 第 1339 行定义.

 {
   if (Config_getBool(FULL_PATH_NAMES))
     return m_fileName;
   else
     return DefinitionMixin::name();
 }

引用了 Config_getBool, m_fileName , 以及 DefinitionMixin< Base >::name().

被这些函数引用 addListReferences(), displayName(), FileDefImpl(), generateSourceFile(), insertMember(), isDocumentationFile(), isIncluded(), setDiskName(), title(), writeDetailedDescription(), writeDocumentation(), writeIncludedByGraph(), writeIncludeGraph(), writeMemberDocumentation(), writeMemberPages(), writeSourceHeader() , 以及 writeTagFile().

◆ numDecMembers()

int FileDefImpl::numDecMembers ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1763 行定义.

 {
   MemberList *ml = getMemberList(MemberListType_allMembersList);
   return ml ? ml->numDecMembers() : 0;
 }

引用了 getMemberList(), MemberListType_allMembersList , 以及 MemberList::numDecMembers().

◆ numDocMembers()

int FileDefImpl::numDocMembers ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1757 行定义.

 {
   MemberList *ml = getMemberList(MemberListType_allMembersList);
   return ml ? ml->numDocMembers() : 0;
 }

引用了 getMemberList(), MemberListType_allMembersList , 以及 MemberList::numDocMembers().

◆ packageDef()

virtual PackageDef* FileDefImpl::packageDef ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 85 行定义.

85 { return m_package; }

引用了 m_package.

◆ parseSource()

void FileDefImpl::parseSource ( ClangTUParser * clangParser )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1192 行定义.

 {
   static bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
   DevNullCodeDocInterface devNullIntf;
 #if USE_LIBCLANG
   if (Doxygen::clangAssistedParsing && clangParser &&
       (getLanguage()==SrcLangExt_Cpp || getLanguage()==SrcLangExt_ObjC))
   {
     clangParser->switchToFile(this);
     clangParser->writeSources(devNullIntf,this);
   }
   else
 #endif
   {
     auto intf = Doxygen::parserManager->getCodeParser(getDefFileExtension());
     intf->resetCodeParserState();
     intf->parseCode(
             devNullIntf,QCString(),
             fileToString(absFilePath(),filterSourceFiles,TRUE),
             getLanguage(),
             FALSE,QCString(),this
            );
   }
 }

引用了 absFilePath(), Doxygen::clangAssistedParsing, Config_getBool, FALSE, fileToString(), ParserManager::getCodeParser(), DefinitionMixin< FileDef >::getDefFileExtension(), DefinitionMixin< FileDef >::getLanguage(), Doxygen::parserManager, SrcLangExt_Cpp, SrcLangExt_ObjC, ClangTUParser::switchToFile(), TRUE , 以及 ClangTUParser::writeSources().

◆ setDirDef()

virtual void FileDefImpl::setDirDef ( DirDef * dd )

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 122 行定义.

122 { m_dir=dd; }

引用了 m_dir.

◆ setDiskName()

void FileDefImpl::setDiskName ( const QCString & name )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 256 行定义.

 {
   if (isReference())
   {
     m_outputDiskName = name;
     m_inclDepFileName = name+"_incl";
     m_inclByDepFileName = name+"_dep_incl";
   }
   else
   {
     m_outputDiskName = convertNameToFile(name);
     m_inclDepFileName = convertNameToFile(name+"_incl");
     m_inclByDepFileName = convertNameToFile(name+"_dep_incl");
   }
 }

引用了 convertNameToFile(), DefinitionMixin< FileDef >::isReference(), m_inclByDepFileName, m_inclDepFileName, m_outputDiskName , 以及 name().

被这些函数引用 FileDefImpl().

◆ setPackageDef()

virtual void FileDefImpl::setPackageDef ( PackageDef * pd )

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 121 行定义.

121 { m_package=pd; }

引用了 m_package.

◆ sortMemberLists()

void FileDefImpl::sortMemberLists ( )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1620 行定义.

 {
   for (auto &ml : m_memberLists)
   {
     if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
   }
  
   for (const auto &mg : m_memberGroups)
   {
     MemberList &mlg = const_cast<MemberList&>(mg->members());
     if (mlg.needsSorting()) { mlg.sort(); mlg.setNeedsSorting(FALSE); }
   }
  
   std::sort(m_includedByList.begin(),m_includedByList.end(),
       [](const auto &fi1,const auto &fi2) { return fi1.includeName < fi2.includeName; });
  
   if (Config_getBool(SORT_BRIEF_DOCS))
   {
     auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
     {
       return Config_getBool(SORT_BY_SCOPE_NAME)     ?
         qstricmp(c1->name(),      c2->name())<0     :
         qstricmp(c1->className(), c2->className())<0;
     };
  
     std::sort(m_classes.begin(),   m_classes.end(),   classComp);
     std::sort(m_interfaces.begin(),m_interfaces.end(),classComp);
     std::sort(m_structs.begin(),   m_structs.end(),   classComp);
     std::sort(m_exceptions.begin(),m_exceptions.end(),classComp);
  
     auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
     {
       return qstricmp(n1->name(),n2->name())<0;
     };
  
     std::sort(m_namespaces.begin(),m_namespaces.end(),namespaceComp);
   }
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::begin(), ClassDef::className(), Config_getBool, LinkedRefMap< T, Hash, KeyEqual, Map >::end(), FALSE, m_classes, m_exceptions, m_includedByList, m_interfaces, m_memberGroups, m_memberLists, m_namespaces, m_structs, Definition::name(), MemberList::needsSorting(), qstricmp(), MemberList::setNeedsSorting() , 以及 MemberVector::sort().

◆ startMemberDeclarations()

void FileDefImpl::startMemberDeclarations ( OutputList & ol )

private

在文件 filedef.cpp 第 690 行定义.

 {
   ol.startMemberSections();
 }

引用了 OutputList::startMemberSections().

被这些函数引用 writeDocumentation().

◆ startMemberDocumentation()

void FileDefImpl::startMemberDocumentation ( OutputList & ol )

private

在文件 filedef.cpp 第 700 行定义.

 {
   if (Config_getBool(SEPARATE_MEMBER_PAGES))
   {
     ol.disable(OutputGenerator::Html);
     Doxygen::suppressDocWarnings = TRUE;
   }
 }

引用了 Config_getBool, OutputList::disable(), OutputGenerator::Html, Doxygen::suppressDocWarnings , 以及 TRUE.

被这些函数引用 writeDocumentation().

◆ subGrouping()

virtual bool FileDefImpl::subGrouping ( ) const

inlinevirtual

实现了 FileDef.

在文件 filedef.cpp 第 101 行定义.

101 { return m_subGrouping; }

引用了 m_subGrouping.

◆ title()

QCString FileDefImpl::title ( ) const

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1723 行定义.

 {
   return theTranslator->trFileReference(name());
 }

引用了 name(), theTranslator , 以及 Translator::trFileReference().

被这些函数引用 writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeNamespaceDeclarations() , 以及 writeSourceHeader().

◆ writeAuthorSection()

void FileDefImpl::writeAuthorSection ( OutputList & ol )

private

在文件 filedef.cpp 第 731 行定义.

 {
   // write Author section (Man only)
   ol.pushGeneratorState();
   ol.disableAllBut(OutputGenerator::Man);
   ol.startGroupHeader();
   ol.parseText(theTranslator->trAuthor(TRUE,TRUE));
   ol.endGroupHeader();
   ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
   ol.popGeneratorState();
 }

引用了 Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), Translator::trGeneratedAutomatically() , 以及 TRUE.

被这些函数引用 writeDocumentation().

◆ writeBriefDescription()

void FileDefImpl::writeBriefDescription ( OutputList & ol )

private

在文件 filedef.cpp 第 477 行定义.

 {
   if (hasBriefDescription())
   {
     std::unique_ptr<IDocParser> parser { createDocParser() };
     std::unique_ptr<DocRoot> rootNode { validatingParseDoc(*parser.get(),
                                         briefFile(),briefLine(),this,0,
                                         briefDescription(),TRUE,FALSE,
                                         QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
  
     if (rootNode && !rootNode->isEmpty())
     {
       ol.startParagraph();
       ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Man);
       ol.writeString(" - ");
       ol.popGeneratorState();
       ol.writeDoc(rootNode.get(),this,0);
       ol.pushGeneratorState();
       ol.disable(OutputGenerator::RTF);
       ol.writeString(" \n");
       ol.enable(OutputGenerator::RTF);
  
       if (Config_getBool(REPEAT_BRIEF) ||
           !documentation().isEmpty()
          )
       {
         ol.disableAllBut(OutputGenerator::Html);
         ol.startTextLink(QCString(),"details");
         ol.parseText(theTranslator->trMore());
         ol.endTextLink();
       }
       ol.popGeneratorState();
       ol.endParagraph();
     }
   }
   ol.writeSynopsis();
 }

引用了 DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::briefFile(), DefinitionMixin< FileDef >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::documentation(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), FALSE, DefinitionMixin< FileDef >::hasBriefDescription(), OutputGenerator::Html, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, Translator::trMore(), TRUE, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString() , 以及 OutputList::writeSynopsis().

被这些函数引用 writeDocumentation().

◆ writeClassDeclarations()

void FileDefImpl::writeClassDeclarations	(	OutputList &	ol,
		const QCString &	title,
		const ClassLinkedRefMap &	list
	)

private

在文件 filedef.cpp 第 665 行定义.

 {
   // write list of classes
   list.writeDeclaration(ol,0,title,FALSE);
 }

引用了 FALSE, title() , 以及 ClassLinkedRefMap::writeDeclaration().

被这些函数引用 writeDocumentation().

◆ writeClassesToTagFile()

void FileDefImpl::writeClassesToTagFile	(	TextStream &	t,
		const ClassLinkedRefMap &	list
	)

private

在文件 filedef.cpp 第 516 行定义.

 {
   for (const auto &cd : list)
   {
     if (cd->isLinkableInProject())
     {
       tagFile << "    <class kind=\"" << cd->compoundTypeString() <<
         "\">" << convertToXML(cd->name()) << "</class>\n";
     }
   }
 }

引用了 convertToXML().

被这些函数引用 writeTagFile().

◆ writeConcepts()

void FileDefImpl::writeConcepts	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 filedef.cpp 第 671 行定义.

 {
   // write list of classes
   m_concepts.writeDeclaration(ol,title,FALSE);
 }

引用了 FALSE, m_concepts, title() , 以及 ConceptLinkedRefMap::writeDeclaration().

被这些函数引用 writeDocumentation().

◆ writeDetailedDescription()

void FileDefImpl::writeDetailedDescription	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 filedef.cpp 第 414 行定义.

 {
   if (hasDetailedDescription())
   {
     ol.pushGeneratorState();
       ol.disable(OutputGenerator::Html);
       ol.writeRuler();
     ol.popGeneratorState();
     ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Html);
       ol.writeAnchor(QCString(),"details");
     ol.popGeneratorState();
     ol.startGroupHeader();
     ol.parseText(title);
     ol.endGroupHeader();
  
     ol.startTextBlock();
     if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
     {
       ol.generateDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
     if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF) &&
         !documentation().isEmpty())
     {
       ol.pushGeneratorState();
         ol.disable(OutputGenerator::Man);
         ol.disable(OutputGenerator::RTF);
         // ol.newParagraph(); // FIXME:PARA
         ol.enableAll();
         ol.disableAllBut(OutputGenerator::Man);
         ol.enable(OutputGenerator::Latex);
         ol.writeString("\n\n");
       ol.popGeneratorState();
     }
     if (!documentation().isEmpty())
     {
       ol.generateDoc(docFile(),docLine(),this,0,documentation()+"\n",TRUE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
     //printf("Writing source ref for file %s\n",qPrint(name()));
     if (Config_getBool(SOURCE_BROWSER))
     {
       ol.startParagraph("definition");
       QCString refText = theTranslator->trDefinedInSourceFile();
       int fileMarkerPos = refText.find("@0");
       if (fileMarkerPos!=-1) // should always pass this.
       {
         ol.parseText(refText.left(fileMarkerPos)); //text left from marker 1
         ol.writeObjectLink(QCString(),getSourceFileBase(),QCString(),name());
         ol.parseText(refText.right(
               refText.length()-fileMarkerPos-2)); // text right from marker 2
       }
       else
       {
         err("translation error: invalid marker in trDefinedInSourceFile()\n");
       }
       ol.endParagraph();
     }
     ol.endTextBlock();
   }
 }

引用了 DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::briefFile(), DefinitionMixin< FileDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::docFile(), DefinitionMixin< FileDef >::docLine(), DefinitionMixin< FileDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endParagraph(), OutputList::endTextBlock(), err(), FALSE, QCString::find(), OutputList::generateDoc(), getSourceFileBase(), hasDetailedDescription(), OutputGenerator::Html, OutputGenerator::Latex, QCString::left(), QCString::length(), OutputGenerator::Man, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString::right(), OutputGenerator::RTF, OutputList::startGroupHeader(), OutputList::startParagraph(), OutputList::startTextBlock(), theTranslator, title(), Translator::trDefinedInSourceFile(), TRUE, OutputList::writeAnchor(), OutputList::writeObjectLink(), OutputList::writeRuler() , 以及 OutputList::writeString().

被这些函数引用 writeDocumentation().

◆ writeDocumentation()

void FileDefImpl::writeDocumentation ( OutputList & ol )

virtual

Write the documentation page for this file to the file of output generators ol.

实现了 FileDef.

在文件 filedef.cpp 第 814 行定义.

 {
   static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
   //funcList->countDecMembers();
  
   //QCString fn = name();
   //if (Config_getBool(FULL_PATH_NAMES))
   //{
   //  fn.prepend(stripFromPath(getPath()));
   //}
  
   //printf("WriteDocumentation diskname=%s\n",qPrint(diskname));
  
   QCString versionTitle;
   if (!m_fileVersion.isEmpty())
   {
     versionTitle=("("+m_fileVersion+")");
   }
   QCString title = m_docname+versionTitle;
   QCString pageTitle=theTranslator->trFileReference(m_docname);
  
   if (getDirDef())
   {
     startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_FileVisible,!generateTreeView);
     if (!generateTreeView)
     {
       getDirDef()->writeNavigationPath(ol);
       ol.endQuickIndices();
     }
     QCString pageTitleShort=theTranslator->trFileReference(name());
     startTitle(ol,getOutputFileBase(),this);
     ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Html);
       ol.parseText(pageTitleShort); // Html only
       ol.enableAll();
       ol.disable(OutputGenerator::Html);
       ol.parseText(pageTitle); // other output formats
     ol.popGeneratorState();
     addGroupListToTitle(ol,this);
     endTitle(ol,getOutputFileBase(),title);
   }
   else
   {
     startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_FileVisible,!generateTreeView);
     if (!generateTreeView)
     {
       ol.endQuickIndices();
     }
     startTitle(ol,getOutputFileBase(),this);
     ol.parseText(pageTitle);
     addGroupListToTitle(ol,this);
     endTitle(ol,getOutputFileBase(),title);
   }
  
   ol.startContents();
  
   if (!m_fileVersion.isEmpty())
   {
     ol.disableAllBut(OutputGenerator::Html);
     ol.startProjectNumber();
     ol.docify(versionTitle);
     ol.endProjectNumber();
     ol.enableAll();
   }
  
   //---------------------------------------- start flexible part -------------------------------
  
   SrcLangExt lang = getLanguage();
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::BriefDesc:
         writeBriefDescription(ol);
         break;
       case LayoutDocEntry::MemberDeclStart:
         startMemberDeclarations(ol);
         break;
       case LayoutDocEntry::FileIncludes:
         writeIncludeFiles(ol);
         break;
       case LayoutDocEntry::FileIncludeGraph:
         writeIncludeGraph(ol);
         break;
       case LayoutDocEntry::FileIncludedByGraph:
         writeIncludedByGraph(ol);
         break;
       case LayoutDocEntry::FileSourceLink:
         writeSourceLink(ol);
         break;
       case LayoutDocEntry::FileClasses:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeClassDeclarations(ol,ls->title(lang),m_classes);
         }
         break;
       case LayoutDocEntry::FileInterfaces:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeClassDeclarations(ol,ls->title(lang),m_interfaces);
         }
         break;
       case LayoutDocEntry::FileStructs:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeClassDeclarations(ol,ls->title(lang),m_structs);
         }
         break;
       case LayoutDocEntry::FileExceptions:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeClassDeclarations(ol,ls->title(lang),m_exceptions);
         }
         break;
       case LayoutDocEntry::FileConcepts:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeConcepts(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::FileNamespaces:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeNamespaceDeclarations(ol,ls->title(lang),false);
         }
         break;
       case LayoutDocEntry::FileConstantGroups:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeNamespaceDeclarations(ol,ls->title(lang),true);
         }
         break;
       case LayoutDocEntry::MemberGroups:
         writeMemberGroups(ol);
         break;
       case LayoutDocEntry::MemberDecl:
         {
           const LayoutDocEntryMemberDecl *lmd = (const LayoutDocEntryMemberDecl*)lde.get();
           writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
         }
         break;
       case LayoutDocEntry::MemberDeclEnd:
         endMemberDeclarations(ol);
         break;
       case LayoutDocEntry::DetailedDesc:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeDetailedDescription(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::MemberDefStart:
         startMemberDocumentation(ol);
         break;
       case LayoutDocEntry::FileInlineClasses:
         writeInlineClasses(ol);
         break;
       case LayoutDocEntry::MemberDef:
         {
           const LayoutDocEntryMemberDef *lmd = (const LayoutDocEntryMemberDef*)lde.get();
           writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
         }
         break;
       case LayoutDocEntry::MemberDefEnd:
         endMemberDocumentation(ol);
         break;
       case LayoutDocEntry::AuthorSection:
         writeAuthorSection(ol);
         break;
       case LayoutDocEntry::ClassIncludes:
       case LayoutDocEntry::ClassInheritanceGraph:
       case LayoutDocEntry::ClassNestedClasses:
       case LayoutDocEntry::ClassCollaborationGraph:
       case LayoutDocEntry::ClassAllMembersLink:
       case LayoutDocEntry::ClassUsedFiles:
       case LayoutDocEntry::ClassInlineClasses:
       case LayoutDocEntry::NamespaceNestedNamespaces:
       case LayoutDocEntry::NamespaceNestedConstantGroups:
       case LayoutDocEntry::NamespaceClasses:
       case LayoutDocEntry::NamespaceConcepts:
       case LayoutDocEntry::NamespaceInterfaces:
       case LayoutDocEntry::NamespaceStructs:
       case LayoutDocEntry::NamespaceExceptions:
       case LayoutDocEntry::NamespaceInlineClasses:
       case LayoutDocEntry::ConceptDefinition:
       case LayoutDocEntry::GroupClasses:
       case LayoutDocEntry::GroupConcepts:
       case LayoutDocEntry::GroupInlineClasses:
       case LayoutDocEntry::GroupNamespaces:
       case LayoutDocEntry::GroupDirs:
       case LayoutDocEntry::GroupNestedGroups:
       case LayoutDocEntry::GroupFiles:
       case LayoutDocEntry::GroupGraph:
       case LayoutDocEntry::GroupPageDocs:
       case LayoutDocEntry::DirSubDirs:
       case LayoutDocEntry::DirFiles:
       case LayoutDocEntry::DirGraph:
         err("Internal inconsistency: member %d should not be part of "
             "LayoutDocManager::File entry list\n",lde->kind());
         break;
     }
   }
  
   //---------------------------------------- end flexible part -------------------------------
  
   ol.endContents();
  
   endFileWithNavPath(this,ol);
  
   if (Config_getBool(SEPARATE_MEMBER_PAGES))
   {
     MemberList *ml = getMemberList(MemberListType_allMembersList);
     if (ml) ml->sort();
     writeMemberPages(ol);
   }
 }

◆ writeIncludedByGraph()

void FileDefImpl::writeIncludedByGraph ( OutputList & ol )

private

在文件 filedef.cpp 第 617 行定义.

 {
   if (Config_getBool(HAVE_DOT) /*&& Config_getBool(INCLUDED_BY_GRAPH)*/)
   {
     //printf("Graph for file %s\n",qPrint(name()));
     DotInclDepGraph incDepGraph(this,TRUE);
     if (incDepGraph.isTooBig())
     {
        warn_uncond("Included by graph for '%s' not generated, too many nodes (%d), threshold is %d. Consider increasing DOT_GRAPH_MAX_NODES.\n",
            qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
     }
     else if (!incDepGraph.isTrivial())
     {
       ol.startTextBlock();
       ol.disable(OutputGenerator::Man);
       ol.startInclDepGraph();
       ol.parseText(theTranslator->trInclByDepGraph());
       ol.endInclDepGraph(incDepGraph);
       ol.enableAll();
       ol.endTextBlock(TRUE);
     }
     //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
   }
 }

引用了 Config_getBool, Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), OutputGenerator::Man, name(), DotInclDepGraph::numNodes(), OutputList::parseText(), qPrint(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclByDepGraph(), TRUE , 以及 warn_uncond().

被这些函数引用 writeDocumentation().

◆ writeIncludeFiles()

void FileDefImpl::writeIncludeFiles ( OutputList & ol )

private

在文件 filedef.cpp 第 528 行定义.

 {
   if (!m_includeList.empty())
   {
     ol.startTextBlock(TRUE);
     for (const auto &ii : m_includeList)
     {
       const FileDef *fd=ii.fileDef;
       bool isIDLorJava = FALSE;
       if (fd)
       {
         SrcLangExt lang   = fd->getLanguage();
         isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
       }
       ol.startTypewriter();
       if (isIDLorJava) // IDL/Java include
       {
         ol.docify("import ");
       }
       else if (ii.imported) // Objective-C include
       {
         ol.docify("#import ");
       }
       else // C/C++ include
       {
         ol.docify("#include ");
       }
       if (ii.local || isIDLorJava)
         ol.docify("\"");
       else
         ol.docify("<");
       ol.disable(OutputGenerator::Html);
       ol.docify(ii.includeName);
       ol.enableAll();
       ol.disableAllBut(OutputGenerator::Html);
  
       // Here we use the include file name as it appears in the file.
       // we could also we the name as it is used within doxygen,
       // then we should have used fd->docName() instead of ii->includeName
       if (fd && fd->isLinkable())
       {
         ol.writeObjectLink(fd->getReference(),
             fd->generateSourceFile() ? fd->includeName() : fd->getOutputFileBase(),
             QCString(),ii.includeName);
       }
       else
       {
         ol.docify(ii.includeName);
       }
  
       ol.enableAll();
       if (ii.local || isIDLorJava)
         ol.docify("\"");
       else
         ol.docify(">");
       if (isIDLorJava)
         ol.docify(";");
       ol.endTypewriter();
       ol.lineBreak();
     }
     ol.endTextBlock();
   }
 }

引用了 OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enableAll(), OutputList::endTextBlock(), OutputList::endTypewriter(), FALSE, FileDef::generateSourceFile(), Definition::getLanguage(), FileDef::getOutputFileBase(), Definition::getReference(), OutputGenerator::Html, FileDef::includeName(), FileDef::isLinkable(), OutputList::lineBreak(), m_includeList, SrcLangExt_IDL, SrcLangExt_Java, OutputList::startTextBlock(), OutputList::startTypewriter(), TRUE , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writeIncludeGraph()

void FileDefImpl::writeIncludeGraph ( OutputList & ol )

private

在文件 filedef.cpp 第 592 行定义.

 {
   if (Config_getBool(HAVE_DOT) /*&& Config_getBool(INCLUDE_GRAPH)*/)
   {
     //printf("Graph for file %s\n",qPrint(name()));
     DotInclDepGraph incDepGraph(this,FALSE);
     if (incDepGraph.isTooBig())
     {
        warn_uncond("Include graph for '%s' not generated, too many nodes (%d), threshold is %d. Consider increasing DOT_GRAPH_MAX_NODES.\n",
            qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
     }
     else if (!incDepGraph.isTrivial())
     {
       ol.startTextBlock();
       ol.disable(OutputGenerator::Man);
       ol.startInclDepGraph();
       ol.parseText(theTranslator->trInclDepGraph(name()));
       ol.endInclDepGraph(incDepGraph);
       ol.enableAll();
       ol.endTextBlock(TRUE);
     }
     //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
   }
 }

引用了 Config_getBool, Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), FALSE, DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), OutputGenerator::Man, name(), DotInclDepGraph::numNodes(), OutputList::parseText(), qPrint(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclDepGraph(), TRUE , 以及 warn_uncond().

被这些函数引用 writeDocumentation().

◆ writeInlineClasses()

void FileDefImpl::writeInlineClasses ( OutputList & ol )

private

在文件 filedef.cpp 第 677 行定义.

 {
   // temporarily undo the disabling could be done by startMemberDocumentation()
   // as a result of setting SEPARATE_MEMBER_PAGES to YES; see bug730512
   bool isEnabled = ol.isEnabled(OutputGenerator::Html);
   ol.enable(OutputGenerator::Html);
  
   m_classes.writeDocumentation(ol,this);
  
   // restore the initial state if needed
   if (!isEnabled) ol.disable(OutputGenerator::Html);
 }

引用了 OutputList::disable(), OutputList::enable(), OutputGenerator::Html, OutputList::isEnabled(), m_classes , 以及 ClassLinkedRefMap::writeDocumentation().

被这些函数引用 writeDocumentation().

◆ writeMemberDeclarations()

void FileDefImpl::writeMemberDeclarations	(	OutputList &	ol,
		MemberListType	lt,
		const QCString &	title
	)

private

在文件 filedef.cpp 第 1671 行定义.

 {
   static bool optVhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
   MemberList * ml = getMemberList(lt);
   if (ml)
   {
     if (optVhdl) // use specific declarations function
     {
  
       VhdlDocGen::writeVhdlDeclarations(ml,ol,0,0,this,0);
     }
     else
     {
       ml->writeDeclarations(ol,0,0,this,0,title,QCString());
     }
   }
 }

引用了 Config_getBool, getMemberList(), title(), MemberList::writeDeclarations() , 以及 VhdlDocGen::writeVhdlDeclarations().

被这些函数引用 writeDocumentation().

◆ writeMemberDocumentation()

void FileDefImpl::writeMemberDocumentation	(	OutputList &	ol,
		MemberListType	lt,
		const QCString &	title
	)

private

在文件 filedef.cpp 第 1689 行定义.

 {
   MemberList * ml = getMemberList(lt);
   if (ml) ml->writeDocumentation(ol,name(),this,title);
 }

引用了 getMemberList(), name(), title() , 以及 MemberList::writeDocumentation().

被这些函数引用 writeDocumentation().

◆ writeMemberGroups()

void FileDefImpl::writeMemberGroups ( OutputList & ol )

private

在文件 filedef.cpp 第 718 行定义.

 {
   /* write user defined member groups */
   for (const auto &mg : m_memberGroups)
   {
     if ((!mg->allMembersInSameSection() || !m_subGrouping)
         && mg->header()!="[NOHEADER]")
     {
       mg->writeDeclarations(ol,0,0,this,0);
     }
   }
 }

引用了 m_memberGroups , 以及 m_subGrouping.

被这些函数引用 writeDocumentation().

◆ writeMemberPages()

void FileDefImpl::writeMemberPages ( OutputList & ol )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1030 行定义.

 {
   ol.pushGeneratorState();
   ol.disableAllBut(OutputGenerator::Html);
  
   for (const auto &ml : m_memberLists)
   {
     if (ml->listType()&MemberListType_documentationLists)
     {
       ml->writeDocumentationPage(ol,name(),this);
     }
   }
  
   ol.popGeneratorState();
 }

引用了 OutputList::disableAllBut(), OutputGenerator::Html, m_memberLists, MemberListType_documentationLists, name(), OutputList::popGeneratorState() , 以及 OutputList::pushGeneratorState().

被这些函数引用 writeDocumentation().

◆ writeNamespaceDeclarations()

void FileDefImpl::writeNamespaceDeclarations	(	OutputList &	ol,
		const QCString &	title,
		bool	isConstantGroup
	)

private

在文件 filedef.cpp 第 658 行定义.

 {
   // write list of namespaces
   m_namespaces.writeDeclaration(ol,title,isConstantGroup);
 }

引用了 m_namespaces, title() , 以及 NamespaceLinkedRefMap::writeDeclaration().

被这些函数引用 writeDocumentation().

◆ writeQuickMemberLinks()

void FileDefImpl::writeQuickMemberLinks	(	OutputList &	ol,
		const MemberDef *	currentMd
	)		const

virtual

重载 DefinitionMixin< FileDef > .

在文件 filedef.cpp 第 1046 行定义.

 {
   static bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
  
   ol.writeString("      <div class=\"navtab\">\n");
   ol.writeString("        <table>\n");
  
   MemberList *allMemberList = getMemberList(MemberListType_allMembersList);
   if (allMemberList)
   {
     for (const auto &md : *allMemberList)
     {
       if (md->getFileDef()==this && md->getNamespaceDef()==0 && md->isLinkable() && !md->isEnumValue())
       {
         if (md->isLinkableInProject())
         {
           if (md==currentMd) // selected item => highlight
           {
             ol.writeString("          <tr><td class=\"navtabHL\">");
           }
           else
           {
             ol.writeString("          <tr><td class=\"navtab\">");
           }
           ol.writeString("<a class=\"navtab\" ");
           ol.writeString("href=\"");
           if (createSubDirs) ol.writeString("../../");
           ol.writeString(addHtmlExtensionIfMissing(md->getOutputFileBase())+"#"+md->anchor());
           ol.writeString("\">");
           ol.writeString(convertToHtml(md->localName()));
           ol.writeString("</a>");
           ol.writeString("</td></tr>\n");
         }
       }
     }
   }
  
   ol.writeString("        </table>\n");
   ol.writeString("      </div>\n");
 }

引用了 addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), createSubDirs(), getMemberList(), MemberListType_allMembersList , 以及 OutputList::writeString().

◆ writeSourceBody()

void FileDefImpl::writeSourceBody	(	OutputList &	ol,
		ClangTUParser *	clangParser
	)

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1134 行定义.

 {
   bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
   DevNullCodeDocInterface devNullIntf;
 #if USE_LIBCLANG
   if (Doxygen::clangAssistedParsing && clangParser &&
       (getLanguage()==SrcLangExt_Cpp || getLanguage()==SrcLangExt_ObjC))
   {
     ol.startCodeFragment("DoxyCode");
     clangParser->switchToFile(this);
     clangParser->writeSources(ol,this);
     ol.endCodeFragment("DoxyCode");
   }
   else
 #endif
   {
     auto intf = Doxygen::parserManager->getCodeParser(getDefFileExtension());
     intf->resetCodeParserState();
     ol.startCodeFragment("DoxyCode");
     bool needs2PassParsing =
         Doxygen::parseSourcesNeeded &&                // we need to parse (filtered) sources for cross-references
         !filterSourceFiles &&                         // but user wants to show sources as-is
         !getFileFilter(absFilePath(),TRUE).isEmpty(); // and there is a filter used while parsing
  
     if (needs2PassParsing)
     {
       // parse code for cross-references only (see bug707641)
       intf->parseCode(devNullIntf,QCString(),
                        fileToString(absFilePath(),TRUE,TRUE),
                        getLanguage(),
                        FALSE,QCString(),this
                       );
     }
     intf->parseCode(ol,QCString(),
         fileToString(absFilePath(),filterSourceFiles,TRUE),
         getLanguage(),      // lang
         FALSE,              // isExampleBlock
         QCString(),         // exampleName
         this,               // fileDef
         -1,                 // startLine
         -1,                 // endLine
         FALSE,              // inlineFragment
         0,                  // memberDef
         TRUE,               // showLineNumbers
         0,                  // searchCtx
         !needs2PassParsing  // collectXRefs
         );
     ol.endCodeFragment("DoxyCode");
   }
 }

引用了 absFilePath(), Doxygen::clangAssistedParsing, Config_getBool, OutputList::endCodeFragment(), FALSE, fileToString(), ParserManager::getCodeParser(), DefinitionMixin< FileDef >::getDefFileExtension(), getFileFilter(), DefinitionMixin< FileDef >::getLanguage(), QCString::isEmpty(), Doxygen::parserManager, Doxygen::parseSourcesNeeded, SrcLangExt_Cpp, SrcLangExt_ObjC, OutputList::startCodeFragment(), ClangTUParser::switchToFile(), TRUE , 以及 ClangTUParser::writeSources().

◆ writeSourceFooter()

void FileDefImpl::writeSourceFooter ( OutputList & ol )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 1185 行定义.

 {
   ol.endContents();
   endFileWithNavPath(this,ol);
   ol.enableAll();
 }

引用了 OutputList::enableAll(), OutputList::endContents() , 以及 endFileWithNavPath().

◆ writeSourceHeader()

void FileDefImpl::writeSourceHeader ( OutputList & ol )

virtual

Write a source listing of this file to the output

实现了 FileDef.

在文件 filedef.cpp 第 1088 行定义.

 {
   bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
   QCString title = m_docname;
   if (!m_fileVersion.isEmpty())
   {
     title+=(" ("+m_fileVersion+")");
   }
   QCString pageTitle = theTranslator->trSourceFile(title);
   ol.disable(OutputGenerator::Man);
  
   bool isDocFile = isDocumentationFile();
   bool genSourceFile = !isDocFile && generateSourceFile();
   if (getDirDef())
   {
     startFile(ol,getSourceFileBase(),QCString(),pageTitle,HLI_FileVisible,
         !generateTreeView,
         !isDocFile && genSourceFile ? QCString() : getOutputFileBase());
     if (!generateTreeView)
     {
       getDirDef()->writeNavigationPath(ol);
       ol.endQuickIndices();
     }
     startTitle(ol,getSourceFileBase());
     ol.parseText(name());
     endTitle(ol,getSourceFileBase(),title);
   }
   else
   {
     startFile(ol,getSourceFileBase(),QCString(),pageTitle,HLI_FileVisible,FALSE,
         !isDocFile && genSourceFile ? QCString() : getOutputFileBase());
     startTitle(ol,getSourceFileBase());
     ol.parseText(title);
     endTitle(ol,getSourceFileBase(),QCString());
   }
  
   ol.startContents();
  
   if (isLinkable())
   {
     ol.startTextLink(getOutputFileBase(),QCString());
     ol.parseText(theTranslator->trGotoDocumentation());
     ol.endTextLink();
   }
 }

引用了 Config_getBool, OutputList::disable(), OutputList::endQuickIndices(), OutputList::endTextLink(), endTitle(), FALSE, generateSourceFile(), getDirDef(), getOutputFileBase(), getSourceFileBase(), HLI_FileVisible, isDocumentationFile(), QCString::isEmpty(), isLinkable(), m_docname, m_fileVersion, OutputGenerator::Man, name(), OutputList::parseText(), OutputList::startContents(), startFile(), OutputList::startTextLink(), startTitle(), theTranslator, title(), Translator::trGotoDocumentation(), Translator::trSourceFile() , 以及 DefinitionMutable::writeNavigationPath().

◆ writeSourceLink()

void FileDefImpl::writeSourceLink ( OutputList & ol )

private

在文件 filedef.cpp 第 643 行定义.

 {
   //printf("%s: generateSourceFile()=%d\n",qPrint(name()),generateSourceFile());
   if (generateSourceFile())
   {
     ol.disableAllBut(OutputGenerator::Html);
     ol.startParagraph();
     ol.startTextLink(includeName(),QCString());
     ol.parseText(theTranslator->trGotoSourceCode());
     ol.endTextLink();
     ol.endParagraph();
     ol.enableAll();
   }
 }

引用了 OutputList::disableAllBut(), OutputList::enableAll(), OutputList::endParagraph(), OutputList::endTextLink(), generateSourceFile(), OutputGenerator::Html, includeName(), OutputList::parseText(), OutputList::startParagraph(), OutputList::startTextLink(), theTranslator , 以及 Translator::trGotoSourceCode().

被这些函数引用 writeDocumentation().

◆ writeSummaryLinks()

void FileDefImpl::writeSummaryLinks ( OutputList & ol ) const

virtual

重载 DefinitionMixin< FileDef > .

在文件 filedef.cpp 第 743 行定义.

 {
   ol.pushGeneratorState();
   ol.disableAllBut(OutputGenerator::Html);
   bool first=TRUE;
   SrcLangExt lang=getLanguage();
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
   {
     if (lde->kind()==LayoutDocEntry::FileClasses && m_classes.declVisible())
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = "nested-classes";
       ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
       first=FALSE;
     }
     else if (lde->kind()==LayoutDocEntry::FileInterfaces && m_interfaces.declVisible())
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = "interfaces";
       ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
       first=FALSE;
     }
     else if (lde->kind()==LayoutDocEntry::FileStructs && m_structs.declVisible())
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = "structs";
       ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
       first=FALSE;
     }
     else if (lde->kind()==LayoutDocEntry::FileExceptions && m_exceptions.declVisible())
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = "exceptions";
       ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
       first=FALSE;
     }
     else if (lde->kind()==LayoutDocEntry::FileNamespaces && m_namespaces.declVisible(false))
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = "namespaces";
       ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
       first=FALSE;
     }
     else if (lde->kind()==LayoutDocEntry::FileConcepts && m_concepts.declVisible())
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = "concepts";
       ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
       first=FALSE;
     }
     else if (lde->kind()==LayoutDocEntry::MemberDecl)
     {
       const LayoutDocEntryMemberDecl *lmd = (const LayoutDocEntryMemberDecl*)lde.get();
       MemberList * ml = getMemberList(lmd->type);
       if (ml && ml->declVisible())
       {
         ol.writeSummaryLink(QCString(),MemberList::listTypeAsString(ml->listType()),lmd->title(lang),first);
         first=FALSE;
       }
     }
   }
   if (!first)
   {
     ol.writeString("  </div>\n");
   }
   ol.popGeneratorState();
 }

引用了 ClassLinkedRefMap::declVisible(), NamespaceLinkedRefMap::declVisible(), ConceptLinkedRefMap::declVisible(), MemberList::declVisible(), OutputList::disableAllBut(), FALSE, LayoutDocManager::File, LayoutDocEntry::FileClasses, LayoutDocEntry::FileConcepts, LayoutDocEntry::FileExceptions, LayoutDocEntry::FileInterfaces, LayoutDocEntry::FileNamespaces, LayoutDocEntry::FileStructs, DefinitionMixin< FileDef >::getLanguage(), getMemberList(), OutputGenerator::Html, LayoutDocManager::instance(), MemberList::listType(), MemberList::listTypeAsString(), m_classes, m_concepts, m_exceptions, m_interfaces, m_namespaces, m_structs, LayoutDocEntry::MemberDecl, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::title(), TRUE, LayoutDocEntryMemberDecl::type, OutputList::writeString() , 以及 OutputList::writeSummaryLink().

◆ writeTagFile()

void FileDefImpl::writeTagFile ( TextStream & t )

virtual

实现了 FileDef.

在文件 filedef.cpp 第 316 行定义.

 {
   tagFile << "  <compound kind=\"file\">\n";
   tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
   tagFile << "    <path>" << convertToXML(getPath()) << "</path>\n";
   tagFile << "    <filename>" << addHtmlExtensionIfMissing(getOutputFileBase()) << "</filename>\n";
   for (const auto &ii : m_includeList)
   {
     const FileDef *fd=ii.fileDef;
     if (fd && fd->isLinkable() && !fd->isReference())
     {
       bool isIDLorJava = FALSE;
       SrcLangExt lang = fd->getLanguage();
       isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
       const char *locStr = (ii.local    || isIDLorJava) ? "yes" : "no";
       const char *impStr = (ii.imported || isIDLorJava) ? "yes" : "no";
       tagFile << "    <includes id=\""
         << convertToXML(fd->getOutputFileBase()) << "\" "
         << "name=\"" << convertToXML(fd->name()) << "\" "
         << "local=\"" << locStr << "\" "
         << "imported=\"" << impStr << "\">"
         << convertToXML(ii.includeName)
         << "</includes>\n";
     }
   }
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::FileClasses:
         {
           writeClassesToTagFile(tagFile, m_classes);
         }
         break;
       case LayoutDocEntry::FileInterfaces:
         {
           writeClassesToTagFile(tagFile, m_interfaces);
         }
         break;
       case LayoutDocEntry::FileStructs:
         {
           writeClassesToTagFile(tagFile, m_structs);
         }
         break;
       case LayoutDocEntry::FileExceptions:
         {
           writeClassesToTagFile(tagFile, m_exceptions);
         }
         break;
       case LayoutDocEntry::FileConcepts:
         {
           for (const auto *nd : m_concepts)
           {
             if (nd->isLinkableInProject())
             {
               tagFile << "    <concept>" << convertToXML(nd->name()) << "</concept>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::FileNamespaces:
         {
           for (const auto *nd : m_namespaces)
           {
             if (nd->isLinkableInProject())
             {
               tagFile << "    <namespace>" << convertToXML(nd->name()) << "</namespace>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::MemberDecl:
         {
           const LayoutDocEntryMemberDecl *lmd = (const LayoutDocEntryMemberDecl*)lde.get();
           MemberList * ml = getMemberList(lmd->type);
           if (ml)
           {
             ml->writeTagFile(tagFile);
           }
         }
         break;
       case LayoutDocEntry::MemberGroups:
         {
           for (const auto &mg : m_memberGroups)
           {
             mg->writeTagFile(tagFile);
           }
         }
         break;
       default:
         break;
     }
   }
  
   writeDocAnchorsToTagFile(tagFile);
   tagFile << "  </compound>\n";
 }

引用了 addHtmlExtensionIfMissing(), convertToXML(), FALSE, LayoutDocManager::File, LayoutDocEntry::FileClasses, LayoutDocEntry::FileConcepts, LayoutDocEntry::FileExceptions, LayoutDocEntry::FileInterfaces, LayoutDocEntry::FileNamespaces, LayoutDocEntry::FileStructs, Definition::getLanguage(), getMemberList(), getOutputFileBase(), FileDef::getOutputFileBase(), getPath(), LayoutDocManager::instance(), FileDef::isLinkable(), Definition::isReference(), m_classes, m_concepts, m_exceptions, m_includeList, m_interfaces, m_memberGroups, m_namespaces, m_structs, LayoutDocEntry::MemberDecl, LayoutDocEntry::MemberGroups, name(), FileDef::name(), SrcLangExt_IDL, SrcLangExt_Java, LayoutDocEntryMemberDecl::type, writeClassesToTagFile(), DefinitionMixin< FileDef >::writeDocAnchorsToTagFile() , 以及 MemberList::writeTagFile().

类成员变量说明

◆ m_classes

ClassLinkedRefMap FileDefImpl::m_classes

private

在文件 filedef.cpp 第 182 行定义.

被这些函数引用 getClasses(), insertClass(), sortMemberLists(), writeDocumentation(), writeInlineClasses(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_concepts

ConceptLinkedRefMap FileDefImpl::m_concepts

private

在文件 filedef.cpp 第 186 行定义.

被这些函数引用 getConcepts(), insertConcept(), writeConcepts(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_dir

DirDef* FileDefImpl::m_dir

private

在文件 filedef.cpp 第 178 行定义.

被这些函数引用 FileDefImpl(), getDirDef() , 以及 setDirDef().

◆ m_docname

QCString FileDefImpl::m_docname

private

在文件 filedef.cpp 第 172 行定义.

被这些函数引用 docName(), FileDefImpl(), writeDocumentation() , 以及 writeSourceHeader().

◆ m_exceptions

ClassLinkedRefMap FileDefImpl::m_exceptions

private

在文件 filedef.cpp 第 185 行定义.

被这些函数引用 insertClass(), sortMemberLists(), writeDocumentation(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_fileName

QCString FileDefImpl::m_fileName

private

在文件 filedef.cpp 第 171 行定义.

被这些函数引用 FileDefImpl(), fileName() , 以及 name().

◆ m_filePath

QCString FileDefImpl::m_filePath

private

在文件 filedef.cpp 第 167 行定义.

被这些函数引用 absFilePath(), acquireFileVersion(), FileDefImpl() , 以及 getSourceFileBase().

◆ m_fileVersion

QCString FileDefImpl::m_fileVersion

private

在文件 filedef.cpp 第 176 行定义.

被这些函数引用 acquireFileVersion(), fileVersion(), getVersion(), writeDocumentation() , 以及 writeSourceHeader().

◆ m_inclByDepFileName

QCString FileDefImpl::m_inclByDepFileName

private

在文件 filedef.cpp 第 169 行定义.

被这些函数引用 includedByDependencyGraphFileName() , 以及 setDiskName().

◆ m_inclDepFileName

QCString FileDefImpl::m_inclDepFileName

private

在文件 filedef.cpp 第 168 行定义.

被这些函数引用 includeDependencyGraphFileName() , 以及 setDiskName().

◆ m_includedByList

IncludeInfoList FileDefImpl::m_includedByList

private

在文件 filedef.cpp 第 163 行定义.

被这些函数引用 addIncludedByDependency(), includedByFileList() , 以及 sortMemberLists().

◆ m_includedByMap

IncludeInfoMap FileDefImpl::m_includedByMap

private

在文件 filedef.cpp 第 162 行定义.

被这些函数引用 addIncludedByDependency().

◆ m_includeList

IncludeInfoList FileDefImpl::m_includeList

private

在文件 filedef.cpp 第 161 行定义.

被这些函数引用 addIncludeDependency(), addIncludedUsingDirectives(), includeFileList(), writeIncludeFiles() , 以及 writeTagFile().

◆ m_includeMap

IncludeInfoMap FileDefImpl::m_includeMap

private

在文件 filedef.cpp 第 160 行定义.

被这些函数引用 addIncludeDependency() , 以及 isIncluded().

◆ m_interfaces

ClassLinkedRefMap FileDefImpl::m_interfaces

private

在文件 filedef.cpp 第 183 行定义.

被这些函数引用 insertClass(), sortMemberLists(), writeDocumentation(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_isSource

bool FileDefImpl::m_isSource

private

在文件 filedef.cpp 第 175 行定义.

被这些函数引用 FileDefImpl() , 以及 isSource().

◆ m_memberGroups

MemberGroupList FileDefImpl::m_memberGroups

private

在文件 filedef.cpp 第 180 行定义.

被这些函数引用 addListReferences(), addMembersToMemberGroup(), countMembers(), distributeMemberGroupDocumentation(), findSectionsInDocumentation(), getMemberGroups(), sortMemberLists(), writeMemberGroups() , 以及 writeTagFile().

◆ m_memberLists

MemberLists FileDefImpl::m_memberLists

private

在文件 filedef.cpp 第 179 行定义.

被这些函数引用 addListReferences(), addMembersToMemberGroup(), addMemberToList(), countMembers(), findSectionsInDocumentation(), getMemberList(), getMemberLists(), insertMember(), sortMemberLists() , 以及 writeMemberPages().

◆ m_namespaces

NamespaceLinkedRefMap FileDefImpl::m_namespaces

private

在文件 filedef.cpp 第 181 行定义.

被这些函数引用 getNamespaces(), insertNamespace(), sortMemberLists(), writeNamespaceDeclarations(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_outputDiskName

QCString FileDefImpl::m_outputDiskName

private

在文件 filedef.cpp 第 170 行定义.

被这些函数引用 getOutputFileBase(), getSourceFileBase() , 以及 setDiskName().

◆ m_package

PackageDef* FileDefImpl::m_package

private

在文件 filedef.cpp 第 177 行定义.

被这些函数引用 FileDefImpl(), packageDef() , 以及 setPackageDef().

◆ m_path

QCString FileDefImpl::m_path

private

在文件 filedef.cpp 第 166 行定义.

被这些函数引用 FileDefImpl() , 以及 getPath().

◆ m_srcDefMap

DefinitionLineMap FileDefImpl::m_srcDefMap

private

在文件 filedef.cpp 第 173 行定义.

被这些函数引用 addSourceRef() , 以及 getSourceDefinition().

◆ m_srcMemberMap

MemberDefLineMap FileDefImpl::m_srcMemberMap

private

在文件 filedef.cpp 第 174 行定义.

被这些函数引用 addSourceRef() , 以及 getSourceMember().

◆ m_structs

ClassLinkedRefMap FileDefImpl::m_structs

private

在文件 filedef.cpp 第 184 行定义.

被这些函数引用 insertClass(), sortMemberLists(), writeDocumentation(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_subGrouping

bool FileDefImpl::m_subGrouping

private

在文件 filedef.cpp 第 187 行定义.

被这些函数引用 addMembersToMemberGroup(), FileDefImpl(), subGrouping() , 以及 writeMemberGroups().

◆ m_usingDeclList

LinkedRefMap<const ClassDef> FileDefImpl::m_usingDeclList

private

在文件 filedef.cpp 第 165 行定义.

被这些函数引用 addIncludedUsingDirectives(), addUsingDeclaration() , 以及 getUsedClasses().

◆ m_usingDirList

LinkedRefMap<const NamespaceDef> FileDefImpl::m_usingDirList

private

在文件 filedef.cpp 第 164 行定义.

被这些函数引用 addIncludedUsingDirectives(), addUsingDirective(), combineUsingRelations() , 以及 getUsedNamespaces().

该类的文档由以下文件生成:

src/filedef.cpp

Public 成员函数

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ FileDefImpl()

◆ ~FileDefImpl()

成员函数说明

◆ absFilePath()

◆ acquireFileVersion()

◆ addIncludedByDependency()

◆ addIncludeDependency()

◆ addIncludedUsingDirectives()

◆ addListReferences()

◆ addMembersToMemberGroup()

◆ addMemberToList()

◆ addSourceRef()

◆ addUsingDeclaration()

◆ addUsingDirective()

◆ anchor()

◆ codeSymbolType()

◆ combineUsingRelations()

◆ computeAnchors()

◆ countMembers()

◆ definitionType()

◆ displayName()

◆ distributeMemberGroupDocumentation()

◆ docName()

◆ endMemberDeclarations()

◆ endMemberDocumentation()

◆ fileName()

◆ fileVersion()

◆ findSectionsInDocumentation()

◆ generateSourceFile()

◆ getAllIncludeFilesRecursively()

◆ getClasses()

◆ getConcepts()

◆ getDirDef()

◆ getMemberGroups()

◆ getMemberList()

◆ getMemberLists()

◆ getNamespaces()

◆ getOutputFileBase()

◆ getPath()

◆ getSourceDefinition()

◆ getSourceFileBase()

◆ getSourceMember()

◆ getUsedClasses()

◆ getUsedNamespaces()

◆ getVersion()

◆ hasDetailedDescription()

◆ includedByDependencyGraphFileName()

◆ includedByFileList()

◆ includeDependencyGraphFileName()

◆ includeFileList()

◆ includeName()

◆ insertClass()

◆ insertConcept()

◆ insertMember()

◆ insertNamespace()

◆ isDocumentationFile()

◆ isIncluded()

◆ isLinkable()

◆ isLinkableInProject()

◆ isSource()

◆ name()

◆ numDecMembers()

◆ numDocMembers()

◆ packageDef()

◆ parseSource()

◆ setDirDef()

◆ setDiskName()

◆ setPackageDef()

◆ sortMemberLists()

◆ startMemberDeclarations()

◆ startMemberDocumentation()

◆ subGrouping()

◆ title()

◆ writeAuthorSection()