类 GroupDefImpl 继承关系图:

GroupDefImpl 的协作图:

Public 成员函数
	GroupDefImpl (const QCString &fileName, int line, const QCString &name, const QCString &title, const QCString &refFileName=QCString())

virtual	~GroupDefImpl ()

virtual DefType	definitionType () const

virtual CodeSymbolType	codeSymbolType () const

virtual QCString	getOutputFileBase () const

virtual QCString	anchor () const

virtual QCString	displayName (bool=TRUE) const

virtual QCString	groupTitle () const

virtual void	setGroupTitle (const QCString &newtitle)

virtual bool	hasGroupTitle () const

virtual void	addFile (const FileDef *def)

virtual bool	addClass (const ClassDef *def)

virtual bool	addConcept (const ConceptDef *def)

virtual bool	addNamespace (const NamespaceDef *def)

virtual void	addGroup (const GroupDef *def)

virtual void	addPage (const PageDef *def)

virtual void	addExample (const PageDef *def)

virtual void	addDir (DirDef *dd)

virtual bool	insertMember (const MemberDef *def, bool docOnly=FALSE)

virtual void	removeMember (MemberDef *md)

virtual bool	findGroup (const GroupDef *def) const

virtual void	writeDocumentation (OutputList &ol)

virtual void	writeMemberPages (OutputList &ol)

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

virtual void	writeTagFile (TextStream &)

virtual size_t	numDocMembers () const

virtual bool	isLinkableInProject () const

virtual bool	isLinkable () const

virtual bool	isASubGroup () const

virtual void	computeAnchors ()

virtual void	countMembers ()

virtual void	addMembersToMemberGroup ()

virtual void	distributeMemberGroupDocumentation ()

virtual void	findSectionsInDocumentation ()

virtual void	addListReferences ()

virtual void	sortMemberLists ()

virtual bool	subGrouping () const

virtual void	setGroupScope (Definition *d)

virtual Definition *	getGroupScope () const

virtual MemberList *	getMemberList (MemberListType lt) const

virtual const MemberLists &	getMemberLists () const

virtual const MemberGroupList &	getMemberGroups () const

virtual const FileList &	getFiles () const

virtual const ClassLinkedRefMap &	getClasses () const

virtual const ConceptLinkedRefMap &	getConcepts () const

virtual const NamespaceLinkedRefMap &	getNamespaces () const

virtual const GroupList &	getSubGroups () const

virtual const PageLinkedRefMap &	getPages () const

virtual const DirList &	getDirs () const

virtual const PageLinkedRefMap &	getExamples () const

virtual bool	hasDetailedDescription () const

virtual void	sortSubGroups ()

Public 成员函数继承自 DefinitionMixin< GroupDef >
	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 成员函数继承自 GroupDef
	~GroupDef ()

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

virtual bool	hasSourceReffedBy () const =0

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 Definition
virtual bool	isAlias () const =0

virtual QCString	name () const =0

virtual bool	isAnonymous () const =0

virtual QCString	localName () const =0

virtual QCString	qualifiedName () const =0

virtual QCString	symbolName () const =0

virtual QCString	getSourceFileBase () 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	addMemberListToGroup (MemberList , bool(MemberDef::)() const)

void	addMemberToList (MemberListType lt, const MemberDef *md)

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

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

void	removeMemberFromList (MemberListType lt, MemberDef *md)

void	writeGroupGraph (OutputList &ol)

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

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

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

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

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

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

void	writeInlineClasses (OutputList &ol)

void	writePageDocumentation (OutputList &ol)

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

void	writeBriefDescription (OutputList &ol)

void	writeMemberGroups (OutputList &ol)

void	startMemberDeclarations (OutputList &ol)

void	endMemberDeclarations (OutputList &ol)

void	startMemberDocumentation (OutputList &ol)

void	endMemberDocumentation (OutputList &ol)

void	writeAuthorSection (OutputList &ol)

void	writeSummaryLinks (OutputList &ol) const

void	updateLanguage (const Definition *)

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

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

详细描述

在文件 groupdef.cpp 第 52 行定义.

构造及析构函数说明

◆ GroupDefImpl()

GroupDefImpl::GroupDefImpl	(	const QCString &	fileName,
		int	line,
		const QCString &	name,
		const QCString &	title,
		const QCString &	refFileName = `QCString()`
	)

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

                                                 : DefinitionMixin(df,dl,1,na),
                     m_allMemberList(MemberListType_allMembersList,MemberListContainer::Group)
 {
   if (!refFileName.isEmpty())
   {
     m_fileName=stripExtension(refFileName);
   }
   else
   {
     m_fileName = convertNameToFile(QCString("group_")+na);
   }
   setGroupTitle( t );
  
   //visited = 0;
   m_groupScope = 0;
   m_subGrouping=Config_getBool(SUBGROUPING);
 }

◆ ~GroupDefImpl()

GroupDefImpl::~GroupDefImpl ( )

virtual

在文件 groupdef.cpp 第 190 行定义.

191 {

192 }

成员函数说明

◆ addClass()

bool GroupDefImpl::addClass ( const ClassDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 251 行定义.

 {
   if (cd->isHidden()) return FALSE;
   updateLanguage(cd);
   QCString qn = cd->name();
   if (m_classes.find(qn)==0)
   {
     m_classes.add(qn,cd);
     return TRUE;
   }
   return FALSE;
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), FALSE, LinkedRefMap< T, Hash, KeyEqual, Map >::find(), Definition::isHidden(), m_classes, Definition::name(), TRUE , 以及 updateLanguage().

◆ addConcept()

bool GroupDefImpl::addConcept ( const ConceptDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 264 行定义.

 {
   if (cd->isHidden()) return FALSE;
   QCString qn = cd->name();
   if (m_concepts.find(qn)==0)
   {
     m_concepts.add(qn,cd);
     return TRUE;
   }
   return FALSE;
 }

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

◆ addDir()

void GroupDefImpl::addDir ( DirDef * dd )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 289 行定义.

 {
   if (def->isHidden()) return;
   m_dirList.push_back(def);
 }

引用了 Definition::isHidden() , 以及 m_dirList.

◆ addExample()

void GroupDefImpl::addExample ( const PageDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 303 行定义.

 {
   if (def->isHidden()) return;
   m_examples.add(def->name(),def);
 }

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

◆ addFile()

void GroupDefImpl::addFile ( const FileDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 237 行定义.

 {
   static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
   if (def->isHidden()) return;
   updateLanguage(def);
   if (sortBriefDocs)
     m_fileList.insert( std::upper_bound( m_fileList.begin(), m_fileList.end(), def,
                                          [](const auto &fd1, const auto &fd2)
                                          { return qstricmp(fd1->name(),fd2->name())<0; }),
                        def);
   else
     m_fileList.push_back(def);
 }

引用了 Config_getBool, Definition::isHidden(), m_fileList , 以及 updateLanguage().

◆ addGroup()

void GroupDefImpl::addGroup ( const GroupDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 565 行定义.

 {
   //printf("adding group '%s' to group '%s'\n",qPrint(def->name()),qPrint(name()));
   //if (Config_getBool(SORT_MEMBER_DOCS))
   //  groupList->inSort(def);
   //else
   m_groups.push_back(def);
 }

引用了 m_groups.

◆ addListReferences()

void GroupDefImpl::addListReferences ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1559 行定义.

 {
   {
     const RefItemVector &xrefItems = xrefListItems();
     addRefItem(xrefItems,
              getOutputFileBase(),
              theTranslator->trGroup(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, DefinitionMixin< GroupDef >::name(), theTranslator, Translator::trGroup(), TRUE , 以及 DefinitionMixin< GroupDef >::xrefListItems().

◆ addMemberListToGroup()

void GroupDefImpl::addMemberListToGroup	(	MemberList *	,
		bool(MemberDef::*)() const
	)

private

◆ addMembersToMemberGroup()

void GroupDefImpl::addMembersToMemberGroup ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 310 行定义.

 {
   for (auto &ml : m_memberLists)
   {
     if (ml->listType()&MemberListType_declarationLists)
     {
       ::addMembersToMemberGroup(ml.get(),&m_memberGroups,this);
     }
   }
 }

引用了 m_memberGroups, m_memberLists , 以及 MemberListType_declarationLists.

◆ addMemberToList()

void GroupDefImpl::addMemberToList	(	MemberListType	lt,
		const MemberDef *	md
	)

private

在文件 groupdef.cpp 第 1584 行定义.

 {
   static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
   static bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
   const auto &ml = m_memberLists.get(lt,MemberListContainer::Group);
   ml->setNeedsSorting(
       ((ml->listType()&MemberListType_declarationLists) && sortBriefDocs) ||
       ((ml->listType()&MemberListType_documentationLists) && sortMemberDocs));
   ml->push_back(md);
 }

引用了 Config_getBool, MemberLists::get(), Group, m_memberLists, MemberListType_declarationLists , 以及 MemberListType_documentationLists.

被这些函数引用 insertMember().

◆ addNamespace()

bool GroupDefImpl::addNamespace ( const NamespaceDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 276 行定义.

 {
   //printf("adding namespace hidden=%d\n",def->isHidden());
   if (def->isHidden()) return false;
   if (m_namespaces.find(def->name())==0)
   {
     updateLanguage(def);
     m_namespaces.add(def->name(),def);
     return true;
   }
   return false;
 }

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

◆ addPage()

void GroupDefImpl::addPage ( const PageDef * def )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 295 行定义.

 {
   if (def->isHidden()) return;
   //printf("Making page %s part of a group\n",qPrint(def->name));
   m_pages.add(def->name(),def);
   const_cast<PageDef*>(def)->makePartOfGroup(this);
 }

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

◆ anchor()

virtual QCString GroupDefImpl::anchor ( ) const

inlinevirtual

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

实现了 GroupDef.

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

94 { return m_subGrouping; }

◆ codeSymbolType()

virtual CodeSymbolType GroupDefImpl::codeSymbolType ( ) const

inlinevirtual

Used for syntax highlighting symbol class

实现了 Definition.

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

94 { return m_subGrouping; }

◆ computeAnchors()

void GroupDefImpl::computeAnchors ( )

virtual

Compute the HTML anchor names for all members in the group

实现了 GroupDef.

在文件 groupdef.cpp 第 605 行定义.

 {
   //printf("GroupDefImpl::computeAnchors()\n");
   m_allMemberList.setAnchors();
 }

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

◆ countMembers()

void GroupDefImpl::countMembers ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 579 行定义.

 {
   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 GroupDefImpl::definitionType ( ) const

inlinevirtual

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

实现了 GroupDef.

在文件 groupdef.cpp 第 73 行定义.

94 { return m_subGrouping; }

◆ displayName()

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

inlinevirtual

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

实现了 GroupDef.

在文件 groupdef.cpp 第 77 行定义.

94 { return m_subGrouping; }

◆ distributeMemberGroupDocumentation()

void GroupDefImpl::distributeMemberGroupDocumentation ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 210 行定义.

 {
   for (const auto &mg : m_memberGroups)
   {
     mg->distributeMemberGroupDocumentation();
   }
 }

引用了 m_memberGroups.

◆ endMemberDeclarations()

void GroupDefImpl::endMemberDeclarations ( OutputList & ol )

private

在文件 groupdef.cpp 第 1010 行定义.

 {
   ol.endMemberSections();
 }

引用了 OutputList::endMemberSections().

被这些函数引用 writeDocumentation().

◆ endMemberDocumentation()

void GroupDefImpl::endMemberDocumentation ( OutputList & ol )

private

在文件 groupdef.cpp 第 1026 行定义.

 {
   //printf("** GroupDefImpl::endMemberDocumentation()\n");
   if (Config_getBool(SEPARATE_MEMBER_PAGES))
   {
     ol.popGeneratorState();
     Doxygen::suppressDocWarnings = FALSE;
   }
 }

引用了 Config_getBool, FALSE, OutputList::popGeneratorState() , 以及 Doxygen::suppressDocWarnings.

被这些函数引用 writeDocumentation().

◆ findGroup()

bool GroupDefImpl::findGroup ( const GroupDef * def ) const

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 549 行定义.

 {
   if (this==def)
   {
     return TRUE;
   }
   for (const auto &gd : m_groups)
   {
     if (gd->findGroup(def))
     {
       return TRUE;
     }
   }
   return FALSE;
 }

引用了 FALSE, m_groups , 以及 TRUE.

◆ findSectionsInDocumentation()

void GroupDefImpl::findSectionsInDocumentation ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 218 行定义.

 {
   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< GroupDef >::briefDescription(), DefinitionMixin< GroupDef >::docFile(), docFindSections(), DefinitionMixin< GroupDef >::documentation(), m_memberGroups, m_memberLists , 以及 MemberListType_declarationLists.

◆ getClasses()

virtual const ClassLinkedRefMap& GroupDefImpl::getClasses ( ) const

inlinevirtual

实现了 GroupDef.

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

164 {

◆ getConcepts()

virtual const ConceptLinkedRefMap& GroupDefImpl::getConcepts ( ) const

inlinevirtual

实现了 GroupDef.

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

164 {

◆ getDirs()

virtual const DirList& GroupDefImpl::getDirs ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 126 行定义.

164 {

◆ getExamples()

virtual const PageLinkedRefMap& GroupDefImpl::getExamples ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 127 行定义.

164 {

◆ getFiles()

virtual const FileList& GroupDefImpl::getFiles ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 120 行定义.

164 {

◆ getGroupScope()

virtual Definition* GroupDefImpl::getGroupScope ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 112 行定义.

112 { return m_examples; }

引用了 m_examples.

◆ getMemberGroups()

virtual const MemberGroupList& GroupDefImpl::getMemberGroups ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 118 行定义.

164 {

◆ getMemberList()

MemberList * GroupDefImpl::getMemberList ( MemberListType lt ) const

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1687 行定义.

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

引用了 m_memberLists.

被这些函数引用 removeMemberFromList(), writeMemberDeclarations(), writeMemberDocumentation(), writeSummaryLinks() , 以及 writeTagFile().

◆ getMemberLists()

virtual const MemberLists& GroupDefImpl::getMemberLists ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 115 行定义.

116 :

117 void addMemberListToGroup(MemberList *,bool (MemberDef::*)() const);

◆ getNamespaces()

virtual const NamespaceLinkedRefMap& GroupDefImpl::getNamespaces ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 123 行定义.

164 {

◆ getOutputFileBase()

QCString GroupDefImpl::getOutputFileBase ( ) const

virtual

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

实现了 GroupDef.

在文件 groupdef.cpp 第 1554 行定义.

 {
   return m_fileName;
 }

引用了 m_fileName.

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

◆ getPages()

virtual const PageLinkedRefMap& GroupDefImpl::getPages ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 125 行定义.

164 {

◆ getSubGroups()

virtual const GroupList& GroupDefImpl::getSubGroups ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 124 行定义.

164 {

◆ groupTitle()

virtual QCString GroupDefImpl::groupTitle ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 78 行定义.

94 { return m_subGrouping; }

◆ hasDetailedDescription()

bool GroupDefImpl::hasDetailedDescription ( ) const

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1755 行定义.

 {
   static bool repeatBrief = Config_getBool(REPEAT_BRIEF);
   return ((!briefDescription().isEmpty() && repeatBrief) ||
          !documentation().isEmpty() ||
          !inbodyDocumentation().isEmpty()) &&
          (m_pages.size()!=numDocMembers());
 }

引用了 DefinitionMixin< GroupDef >::briefDescription(), Config_getBool, DefinitionMixin< GroupDef >::documentation(), DefinitionMixin< GroupDef >::inbodyDocumentation(), m_pages, numDocMembers() , 以及 LinkedRefMap< T, Hash, KeyEqual, Map >::size().

被这些函数引用 writeBriefDescription().

◆ hasGroupTitle()

virtual bool GroupDefImpl::hasGroupTitle ( ) const

inlinevirtual

实现了 GroupDef.

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

94 { return m_subGrouping; }

◆ insertMember()

bool GroupDefImpl::insertMember	(	const MemberDef *	def,
		bool	docOnly = `FALSE`
	)

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 322 行定义.

 {
   if (md->isHidden()) return FALSE;
   updateLanguage(md);
   //printf("GroupDef(%s)::insertMember(%s)\n", qPrint(title), qPrint(md->name()));
   MemberNameInfo *mni = m_allMemberNameInfoLinkedMap.add(md->name());
   for (auto &srcMi : *mni)
   {
     const MemberDef *srcMd = srcMi->memberDef();
     if (srcMd==md) return FALSE; // already added before!
  
     bool sameScope = srcMd->getOuterScope()==md->getOuterScope() || // same class or namespace
         // both inside a file => definition and declaration do not have to be in the same file
          (srcMd->getOuterScope()->definitionType()==Definition::TypeFile &&
              md->getOuterScope()->definitionType()==Definition::TypeFile);
  
     const ArgumentList &srcMdAl  = srcMd->argumentList();
     const ArgumentList &mdAl     = md->argumentList();
     const ArgumentList &tSrcMdAl = srcMd->templateArguments();
     const ArgumentList &tMdAl    = md->templateArguments();
  
     if (srcMd->isFunction() && md->isFunction() && // both are a function
         (tSrcMdAl.size()==tMdAl.size()) &&       // same number of template arguments
         matchArguments2(srcMd->getOuterScope(),srcMd->getFileDef(),&srcMdAl,
                         md->getOuterScope(),md->getFileDef(),&mdAl,
                         TRUE
                        ) && // matching parameters
         sameScope // both are found in the same scope
        )
     {
       MemberDefMutable *mdm = toMemberDefMutable(md);
       if (mdm && srcMd->getGroupAlias()==0)
       {
         mdm->setGroupAlias(srcMd);
       }
       else if (mdm && md!=srcMd->getGroupAlias())
       {
         mdm->setGroupAlias(srcMd->getGroupAlias());
       }
       return FALSE; // member is the same as one that is already added
     }
   }
   mni->push_back(std::make_unique<MemberInfo>(md,md->protection(),md->virtualness(),FALSE));
   //printf("Added member!\n");
   m_allMemberList.push_back(md);
   switch(md->memberType())
   {
     case MemberType_Variable:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decVarMembers,md);
       }
       addMemberToList(MemberListType_docVarMembers,md);
       break;
     case MemberType_Function:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decFuncMembers,md);
       }
       addMemberToList(MemberListType_docFuncMembers,md);
       break;
     case MemberType_Typedef:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decTypedefMembers,md);
       }
       addMemberToList(MemberListType_docTypedefMembers,md);
       break;
     case MemberType_Enumeration:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decEnumMembers,md);
       }
       addMemberToList(MemberListType_docEnumMembers,md);
       break;
     case MemberType_EnumValue:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decEnumValMembers,md);
       }
       addMemberToList(MemberListType_docEnumValMembers,md);
       break;
     case MemberType_Define:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decDefineMembers,md);
       }
       addMemberToList(MemberListType_docDefineMembers,md);
       break;
     case MemberType_Signal:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decSignalMembers,md);
       }
       addMemberToList(MemberListType_docSignalMembers,md);
       break;
     case MemberType_Slot:
       if (md->protection()==Public)
       {
         if (!docOnly)
         {
           addMemberToList(MemberListType_decPubSlotMembers,md);
         }
         addMemberToList(MemberListType_docPubSlotMembers,md);
       }
       else if (md->protection()==Protected)
       {
         if (!docOnly)
         {
           addMemberToList(MemberListType_decProSlotMembers,md);
         }
         addMemberToList(MemberListType_docProSlotMembers,md);
       }
       else
       {
         if (!docOnly)
         {
           addMemberToList(MemberListType_decPriSlotMembers,md);
         }
         addMemberToList(MemberListType_docPriSlotMembers,md);
       }
       break;
     case MemberType_Event:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decEventMembers,md);
       }
       addMemberToList(MemberListType_docEventMembers,md);
       break;
     case MemberType_Property:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decPropMembers,md);
       }
       addMemberToList(MemberListType_docPropMembers,md);
       break;
     case MemberType_Friend:
       if (!docOnly)
       {
         addMemberToList(MemberListType_decFriendMembers,md);
       }
       addMemberToList(MemberListType_docFriendMembers,md);
       break;
     default:
       err("GroupDefImpl::insertMembers(): "
            "member '%s' (typeid=%d) with scope '%s' inserted in group scope '%s'!\n",
            qPrint(md->name()),md->memberType(),
            md->getClassDef() ? qPrint(md->getClassDef()->name()) : "",
            qPrint(name()));
   }
   return TRUE;
 }

◆ isASubGroup()

bool GroupDefImpl::isASubGroup ( ) const

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 574 行定义.

 {
   return !partOfGroups().empty();
 }

引用了 DefinitionMixin< GroupDef >::partOfGroups().

◆ isLinkable()

bool GroupDefImpl::isLinkable ( ) const

virtual

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

实现了 GroupDef.

在文件 groupdef.cpp 第 1740 行定义.

 {
   return hasUserDocumentation();
 }

引用了 DefinitionMixin< GroupDef >::hasUserDocumentation().

被这些函数引用 isLinkableInProject().

◆ isLinkableInProject()

bool GroupDefImpl::isLinkableInProject ( ) const

virtual

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

实现了 GroupDef.

在文件 groupdef.cpp 第 1735 行定义.

 {
   return !isReference() && isLinkable();
 }

引用了 isLinkable() , 以及 DefinitionMixin< GroupDef >::isReference().

◆ numDocMembers()

size_t GroupDefImpl::numDocMembers ( ) const

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 593 行定义.

 {
   return m_fileList.size()+
          m_classes.size()+
          m_namespaces.size()+
          m_groups.size()+
          m_allMemberList.size()+
          m_pages.size()+
          m_examples.size();
 }

引用了 m_allMemberList, m_classes, m_examples, m_fileList, m_groups, m_namespaces, m_pages, MemberVector::size() , 以及 LinkedRefMap< T, Hash, KeyEqual, Map >::size().

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

◆ removeMember()

void GroupDefImpl::removeMember ( MemberDef * md )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 475 行定义.

 {
   // fprintf(stderr, "GroupDef(%s)::removeMember( %s )\n", qPrint(title), qPrint(md->name()));
   MemberNameInfo *mni = m_allMemberNameInfoLinkedMap.find(md->name());
   if (mni)
   {
     m_allMemberNameInfoLinkedMap.del(md->name());
  
     removeMemberFromList(MemberListType_allMembersList,md);
     switch(md->memberType())
     {
       case MemberType_Variable:
         removeMemberFromList(MemberListType_decVarMembers,md);
         removeMemberFromList(MemberListType_docVarMembers,md);
         break;
       case MemberType_Function:
         removeMemberFromList(MemberListType_decFuncMembers,md);
         removeMemberFromList(MemberListType_docFuncMembers,md);
         break;
       case MemberType_Typedef:
         removeMemberFromList(MemberListType_decTypedefMembers,md);
         removeMemberFromList(MemberListType_docTypedefMembers,md);
         break;
       case MemberType_Enumeration:
         removeMemberFromList(MemberListType_decEnumMembers,md);
         removeMemberFromList(MemberListType_docEnumMembers,md);
         break;
       case MemberType_EnumValue:
         removeMemberFromList(MemberListType_decEnumValMembers,md);
         removeMemberFromList(MemberListType_docEnumValMembers,md);
         break;
       case MemberType_Define:
         removeMemberFromList(MemberListType_decDefineMembers,md);
         removeMemberFromList(MemberListType_docDefineMembers,md);
         break;
       case MemberType_Signal:
         removeMemberFromList(MemberListType_decSignalMembers,md);
         removeMemberFromList(MemberListType_docSignalMembers,md);
         break;
       case MemberType_Slot:
         if (md->protection()==Public)
         {
           removeMemberFromList(MemberListType_decPubSlotMembers,md);
           removeMemberFromList(MemberListType_docPubSlotMembers,md);
         }
         else if (md->protection()==Protected)
         {
           removeMemberFromList(MemberListType_decProSlotMembers,md);
           removeMemberFromList(MemberListType_docProSlotMembers,md);
         }
         else
         {
           removeMemberFromList(MemberListType_decPriSlotMembers,md);
           removeMemberFromList(MemberListType_docPriSlotMembers,md);
         }
         break;
       case MemberType_Event:
         removeMemberFromList(MemberListType_decEventMembers,md);
         removeMemberFromList(MemberListType_docEventMembers,md);
         break;
       case MemberType_Property:
         removeMemberFromList(MemberListType_decPropMembers,md);
         removeMemberFromList(MemberListType_docPropMembers,md);
         break;
       case MemberType_Friend:
         removeMemberFromList(MemberListType_decFriendMembers,md);
         removeMemberFromList(MemberListType_docFriendMembers,md);
         break;
       default:
         err("GroupDefImpl::removeMember(): unexpected member remove in file!\n");
     }
   }
 }

◆ removeMemberFromList()

void GroupDefImpl::removeMemberFromList	(	MemberListType	lt,
		MemberDef *	md
	)

private

在文件 groupdef.cpp 第 1721 行定义.

 {
   MemberList *ml = getMemberList(lt);
   if (ml) ml->remove(md);
 }

引用了 getMemberList() , 以及 MemberVector::remove().

被这些函数引用 removeMember().

◆ setGroupScope()

virtual void GroupDefImpl::setGroupScope ( Definition * d )

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 111 行定义.

111 { return m_dirList; }

引用了 m_dirList.

◆ setGroupTitle()

void GroupDefImpl::setGroupTitle ( const QCString & newtitle )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 194 行定义.

 {
   if ( !t.isEmpty())
   {
     m_title = t;
     m_titleSet = TRUE;
   }
   else
   {
     m_title = name();
     m_title[0]=(char)toupper(m_title[0]);
     m_titleSet = FALSE;
   }
 }

引用了 FALSE, QCString::isEmpty(), m_title, m_titleSet, DefinitionMixin< GroupDef >::name() , 以及 TRUE.

◆ sortMemberLists()

void GroupDefImpl::sortMemberLists ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1655 行定义.

 {
   for (auto &ml : m_memberLists)
   {
     if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
   }
   if (Config_getBool(SORT_BRIEF_DOCS))
   {
     std::sort(m_dirList.begin(), m_dirList.end(), compareDirDefs);
  
     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);
  
     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);
   }
   else
   {
     groupClassesWithSameScope(m_classes);
     groupClassesWithSameScope(m_namespaces);
   }
 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::begin(), ClassDef::className(), compareDirDefs(), Config_getBool, LinkedRefMap< T, Hash, KeyEqual, Map >::end(), FALSE, groupClassesWithSameScope(), m_classes, m_dirList, m_memberLists, m_namespaces, Definition::name() , 以及 qstricmp().

◆ sortSubGroups()

void GroupDefImpl::sortSubGroups ( )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1727 行定义.

 {
   std::sort(m_groups.begin(),
             m_groups.end(),
             [](const auto &g1,const auto &g2)
             { return g1->groupTitle() < g2->groupTitle(); });
 }

引用了 m_groups.

◆ startMemberDeclarations()

void GroupDefImpl::startMemberDeclarations ( OutputList & ol )

private

在文件 groupdef.cpp 第 1005 行定义.

 {
   ol.startMemberSections();
 }

引用了 OutputList::startMemberSections().

被这些函数引用 writeDocumentation().

◆ startMemberDocumentation()

void GroupDefImpl::startMemberDocumentation ( OutputList & ol )

private

在文件 groupdef.cpp 第 1015 行定义.

 {
   //printf("** GroupDefImpl::startMemberDocumentation()\n");
   if (Config_getBool(SEPARATE_MEMBER_PAGES))
   {
     ol.pushGeneratorState();
     ol.disable(OutputGenerator::Html);
     Doxygen::suppressDocWarnings = TRUE;
   }
 }

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

被这些函数引用 writeDocumentation().

◆ subGrouping()

virtual bool GroupDefImpl::subGrouping ( ) const

inlinevirtual

实现了 GroupDef.

在文件 groupdef.cpp 第 109 行定义.

109 { return m_groups; }

引用了 m_groups.

◆ updateLanguage()

void GroupDefImpl::updateLanguage ( const Definition * d )

private

在文件 groupdef.cpp 第 1747 行定义.

 {
   if (getLanguage()==SrcLangExt_Unknown && d->getLanguage()!=SrcLangExt_Unknown)
   {
     setLanguage(d->getLanguage());
   }
 }

引用了 DefinitionMixin< GroupDef >::getLanguage(), Definition::getLanguage(), DefinitionMixin< GroupDef >::setLanguage() , 以及 SrcLangExt_Unknown.

被这些函数引用 addClass(), addFile(), addNamespace() , 以及 insertMember().

◆ writeAuthorSection()

void GroupDefImpl::writeAuthorSection ( OutputList & ol )

private

在文件 groupdef.cpp 第 1036 行定义.

 {
   // 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 GroupDefImpl::writeBriefDescription ( OutputList & ol )

private

在文件 groupdef.cpp 第 792 行定义.

 {
   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 (hasDetailedDescription())
       {
         ol.disableAllBut(OutputGenerator::Html);
         ol.startTextLink(QCString(),"details");
         ol.parseText(theTranslator->trMore());
         ol.endTextLink();
       }
       ol.popGeneratorState();
       ol.endParagraph();
     }
   }
   ol.writeSynopsis();
 }

引用了 DefinitionMixin< GroupDef >::briefDescription(), DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), FALSE, DefinitionMixin< GroupDef >::hasBriefDescription(), hasDetailedDescription(), 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().

◆ writeClasses()

void GroupDefImpl::writeClasses	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 groupdef.cpp 第 957 行定义.

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

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

被这些函数引用 writeDocumentation().

◆ writeConcepts()

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

private

在文件 groupdef.cpp 第 963 行定义.

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

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

被这些函数引用 writeDocumentation().

◆ writeDetailedDescription()

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

private

在文件 groupdef.cpp 第 728 行定义.

 {
   if ((!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
       || !documentation().isEmpty() || !inbodyDocumentation().isEmpty()
      )
   {
     ol.pushGeneratorState();
     if (m_pages.size()!=numDocMembers()) // not only pages -> classical layout
     {
       ol.pushGeneratorState();
         ol.disable(OutputGenerator::Html);
         ol.writeRuler();
       ol.popGeneratorState();
       ol.pushGeneratorState();
         ol.disableAllBut(OutputGenerator::Html);
         ol.writeAnchor(QCString(),"details");
       ol.popGeneratorState();
     }
     else
     {
       ol.disableAllBut(OutputGenerator::Man); // always print title for man page
     }
     ol.startGroupHeader();
     ol.parseText(title);
     ol.endGroupHeader();
     ol.popGeneratorState();
  
     // repeat brief description
     if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
     {
       ol.generateDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
     // write separator between brief and details
     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();
     }
  
     // write detailed documentation
     if (!documentation().isEmpty())
     {
       ol.generateDoc(docFile(),docLine(),this,0,documentation()+"\n",TRUE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
  
     // write inbody documentation
     if (!inbodyDocumentation().isEmpty())
     {
       ol.generateDoc(inbodyFile(),inbodyLine(),this,0,inbodyDocumentation()+"\n",TRUE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
   }
 }

被这些函数引用 writeDocumentation().

◆ writeDirs()

void GroupDefImpl::writeDirs	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 groupdef.cpp 第 925 行定义.

 {
   // write list of directories
   if (!m_dirList.empty())
   {
     ol.startMemberHeader("dirs");
     ol.parseText(title);
     ol.endMemberHeader();
     ol.startMemberList();
     for(const auto dd : m_dirList)
     {
       if (!dd->hasDocumentation()) continue;
       ol.startMemberDeclaration();
       ol.startMemberItem(dd->getOutputFileBase(),0);
       ol.parseText(theTranslator->trDir(FALSE,TRUE));
       ol.insertMemberAlign();
       ol.writeObjectLink(dd->getReference(),dd->getOutputFileBase(),QCString(),dd->shortName());
       ol.endMemberItem();
       if (!dd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
       {
         ol.startMemberDescription(dd->getOutputFileBase());
         ol.generateDoc(briefFile(),briefLine(),dd,0,dd->briefDescription(),FALSE,FALSE,
                        QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
         ol.endMemberDescription();
       }
       ol.endMemberDeclaration(QCString(),QCString());
     }
  
     ol.endMemberList();
   }
 }

引用了 DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), m_dirList, OutputList::parseText(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trDir(), TRUE , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writeDocumentation()

void GroupDefImpl::writeDocumentation ( OutputList & ol )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1092 行定义.

 {
   //static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
   ol.pushGeneratorState();
   startFile(ol,getOutputFileBase(),name(),m_title,HLI_Modules);
  
   ol.startHeaderSection();
   writeSummaryLinks(ol);
   ol.startTitleHead(getOutputFileBase());
   ol.pushGeneratorState();
   ol.disable(OutputGenerator::Man);
   ol.parseText(m_title);
   ol.popGeneratorState();
   addGroupListToTitle(ol,this);
   ol.pushGeneratorState();
   ol.disable(OutputGenerator::Man);
   ol.endTitleHead(getOutputFileBase(),m_title);
   ol.popGeneratorState();
   ol.pushGeneratorState();
   ol.disableAllBut(OutputGenerator::Man);
   ol.endTitleHead(getOutputFileBase(),name());
   if (!m_title.isEmpty())
   {
     ol.writeString(" - ");
     ol.parseText(m_title);
   }
   ol.popGeneratorState();
   ol.endHeaderSection();
   ol.startContents();
  
   //---------------------------------------- start flexible part -------------------------------
  
   SrcLangExt lang=getLanguage();
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Group))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::BriefDesc:
         writeBriefDescription(ol);
         break;
       case LayoutDocEntry::MemberDeclStart:
         startMemberDeclarations(ol);
         break;
       case LayoutDocEntry::GroupClasses:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeClasses(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::GroupConcepts:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeConcepts(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::GroupInlineClasses:
         {
           writeInlineClasses(ol);
         }
         break;
       case LayoutDocEntry::GroupNamespaces:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeNamespaces(ol,ls->title(lang));
         }
         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::MemberDef:
         {
           const LayoutDocEntryMemberDef *lmd = (const LayoutDocEntryMemberDef*)lde.get();
           writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
         }
         break;
       case LayoutDocEntry::MemberDefEnd:
         endMemberDocumentation(ol);
         break;
       case LayoutDocEntry::GroupNestedGroups:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeNestedGroups(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::GroupPageDocs:
         writePageDocumentation(ol);
         break;
       case LayoutDocEntry::GroupDirs:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeDirs(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::GroupFiles:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeFiles(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::GroupGraph:
         writeGroupGraph(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::FileClasses:
       case LayoutDocEntry::FileConcepts:
       case LayoutDocEntry::FileInterfaces:
       case LayoutDocEntry::FileStructs:
       case LayoutDocEntry::FileExceptions:
       case LayoutDocEntry::FileNamespaces:
       case LayoutDocEntry::FileConstantGroups:
       case LayoutDocEntry::FileIncludes:
       case LayoutDocEntry::FileIncludeGraph:
       case LayoutDocEntry::FileIncludedByGraph:
       case LayoutDocEntry::FileSourceLink:
       case LayoutDocEntry::FileInlineClasses:
       case LayoutDocEntry::DirSubDirs:
       case LayoutDocEntry::DirFiles:
       case LayoutDocEntry::DirGraph:
         err("Internal inconsistency: member %d should not be part of "
             "LayoutDocManager::Group entry list\n",lde->kind());
         break;
     }
   }
  
   //---------------------------------------- end flexible part -------------------------------
  
   endFile(ol);
  
   ol.popGeneratorState();
  
   if (Config_getBool(SEPARATE_MEMBER_PAGES))
   {
     m_allMemberList.sort();
     writeMemberPages(ol);
   }
  
 }

◆ writeFiles()

void GroupDefImpl::writeFiles	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 groupdef.cpp 第 848 行定义.

 {
   // write list of files
   if (!m_fileList.empty())
   {
     ol.startMemberHeader("files");
     ol.parseText(title);
     ol.endMemberHeader();
     ol.startMemberList();
     for (const auto &fd : m_fileList)
     {
       if (!fd->hasDocumentation()) continue;
       ol.startMemberDeclaration();
       ol.startMemberItem(fd->getOutputFileBase(),0);
       ol.docify(theTranslator->trFile(FALSE,TRUE)+" ");
       ol.insertMemberAlign();
       ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),QCString(),fd->name());
       ol.endMemberItem();
       if (!fd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
       {
         ol.startMemberDescription(fd->getOutputFileBase());
         ol.generateDoc(briefFile(),briefLine(),fd,0,fd->briefDescription(),FALSE,FALSE,
                        QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
         ol.endMemberDescription();
       }
       ol.endMemberDeclaration(QCString(),QCString());
     }
     ol.endMemberList();
   }
 }

引用了 DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::docify(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), m_fileList, OutputList::parseText(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trFile(), TRUE , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writeGroupGraph()

void GroupDefImpl::writeGroupGraph ( OutputList & ol )

private

在文件 groupdef.cpp 第 828 行定义.

 {
   if (Config_getBool(HAVE_DOT) /*&& Config_getBool(GROUP_GRAPHS)*/ )
   {
     DotGroupCollaboration graph(this);
     if (!graph.isTrivial())
     {
       msg("Generating dependency graph for group %s\n",qPrint(qualifiedName()));
       ol.pushGeneratorState();
       ol.disable(OutputGenerator::Man);
       //ol.startParagraph();
       ol.startGroupCollaboration();
       ol.parseText(theTranslator->trCollaborationDiagram(m_title));
       ol.endGroupCollaboration(graph);
       //ol.endParagraph();
       ol.popGeneratorState();
     }
   }
 }

引用了 Config_getBool, OutputList::disable(), OutputList::endGroupCollaboration(), DotGroupCollaboration::isTrivial(), m_title, OutputGenerator::Man, msg(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), qPrint(), DefinitionMixin< GroupDef >::qualifiedName(), OutputList::startGroupCollaboration(), theTranslator , 以及 Translator::trCollaborationDiagram().

被这些函数引用 writeDocumentation().

◆ writeInlineClasses()

void GroupDefImpl::writeInlineClasses ( OutputList & ol )

private

在文件 groupdef.cpp 第 969 行定义.

 {
   m_classes.writeDocumentation(ol);
 }

引用了 m_classes , 以及 ClassLinkedRefMap::writeDocumentation().

被这些函数引用 writeDocumentation().

◆ writeMemberDeclarations()

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

private

在文件 groupdef.cpp 第 1699 行定义.

 {
   static bool optimizeVhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  
   MemberList * ml = getMemberList(lt);
   if (optimizeVhdl && ml)
   {
     VhdlDocGen::writeVhdlDeclarations(ml,ol,this,0,0,0);
     return;
   }
   if (ml)
   {
     ml->writeDeclarations(ol,0,0,0,this,title,QCString());
   }
 }

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

被这些函数引用 writeDocumentation().

◆ writeMemberDocumentation()

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

private

在文件 groupdef.cpp 第 1715 行定义.

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

引用了 getMemberList(), DefinitionMixin< GroupDef >::name() , 以及 MemberList::writeDocumentation().

被这些函数引用 writeDocumentation().

◆ writeMemberGroups()

void GroupDefImpl::writeMemberGroups ( OutputList & ol )

private

在文件 groupdef.cpp 第 996 行定义.

 {
   /* write user defined member groups */
   for (const auto &mg : m_memberGroups)
   {
     mg->writeDeclarations(ol,0,0,0,this);
   }
 }

引用了 m_memberGroups.

被这些函数引用 writeDocumentation().

◆ writeMemberPages()

void GroupDefImpl::writeMemberPages ( OutputList & ol )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 1266 行定义.

 {
   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, DefinitionMixin< GroupDef >::name(), OutputList::popGeneratorState() , 以及 OutputList::pushGeneratorState().

被这些函数引用 writeDocumentation().

◆ writeNamespaces()

void GroupDefImpl::writeNamespaces	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 groupdef.cpp 第 879 行定义.

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

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

被这些函数引用 writeDocumentation().

◆ writeNestedGroups()

void GroupDefImpl::writeNestedGroups	(	OutputList &	ol,
		const QCString &	title
	)

private

在文件 groupdef.cpp 第 885 行定义.

 {
   // write list of groups
   int count=0;
   for (const auto &gd : m_groups)
   {
     if (gd->isVisible()) count++;
   }
   if (count>0)
   {
     ol.startMemberHeader("groups");
     ol.parseText(title);
     ol.endMemberHeader();
     ol.startMemberList();
     for (const auto &gd : m_groups)
     {
       if (gd->isVisible())
       {
         if (!gd->hasDocumentation()) continue;
         ol.startMemberDeclaration();
         ol.startMemberItem(gd->getOutputFileBase(),0);
         //ol.docify(theTranslator->trGroup(FALSE,TRUE));
         //ol.docify(" ");
         ol.insertMemberAlign();
         ol.writeObjectLink(gd->getReference(),gd->getOutputFileBase(),QCString(),gd->groupTitle());
         ol.endMemberItem();
         if (!gd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
         {
           ol.startMemberDescription(gd->getOutputFileBase());
           ol.generateDoc(briefFile(),briefLine(),gd,0,gd->briefDescription(),FALSE,FALSE,
                          QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
           ol.endMemberDescription();
         }
         ol.endMemberDeclaration(QCString(),QCString());
       }
     }
     ol.endMemberList();
   }
 }

引用了 DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), m_groups, OutputList::parseText(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), TRUE , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writePageDocumentation()

void GroupDefImpl::writePageDocumentation ( OutputList & ol )

private

在文件 groupdef.cpp 第 974 行定义.

 {
   for (const auto *pd : m_pages)
   {
     if (!pd->isReference())
     {
       const SectionInfo *si=0;
       if (pd->hasTitle() && !pd->name().isEmpty() &&
           (si=SectionManager::instance().find(pd->name()))!=0)
       {
         ol.startSection(si->label(),si->title(),SectionType::Subsection);
         ol.docify(si->title());
         ol.endSection(si->label(),SectionType::Subsection);
       }
       ol.startTextBlock();
       ol.generateDoc(pd->docFile(),pd->docLine(),pd,0,(pd->documentation()+pd->inbodyDocumentation()),TRUE,FALSE,
                      QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
       ol.endTextBlock();
     }
   }
 }

引用了 Config_getBool, OutputList::docify(), OutputList::endSection(), OutputList::endTextBlock(), FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), OutputList::generateDoc(), SectionManager::instance(), SectionInfo::label(), m_pages, OutputList::startSection(), OutputList::startTextBlock(), Subsection, SectionInfo::title() , 以及 TRUE.

被这些函数引用 writeDocumentation().

◆ writeQuickMemberLinks()

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

virtual

重载 DefinitionMixin< GroupDef > .

在文件 groupdef.cpp 第 1282 行定义.

 {
   static bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
  
   ol.writeString("      <div class=\"navtab\">\n");
   ol.writeString("        <table>\n");
  
   for (const auto *md : m_allMemberList)
   {
     if (md->getGroupDef()==this && 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(), m_allMemberList , 以及 OutputList::writeString().

◆ writeSummaryLinks()

void GroupDefImpl::writeSummaryLinks ( OutputList & ol ) const

privatevirtual

重载 DefinitionMixin< GroupDef > .

在文件 groupdef.cpp 第 1048 行定义.

 {
   ol.pushGeneratorState();
   ol.disableAllBut(OutputGenerator::Html);
   bool first=TRUE;
   SrcLangExt lang = getLanguage();
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Group))
   {
     if ((lde->kind()==LayoutDocEntry::GroupClasses      &&  m_classes.declVisible()) ||
         (lde->kind()==LayoutDocEntry::GroupConcepts     &&  m_concepts.declVisible()) ||
         (lde->kind()==LayoutDocEntry::GroupNamespaces   &&  m_namespaces.declVisible(false)) ||
         (lde->kind()==LayoutDocEntry::GroupFiles        && !m_fileList.empty()) ||
         (lde->kind()==LayoutDocEntry::GroupNestedGroups && !m_groups.empty()) ||
         (lde->kind()==LayoutDocEntry::GroupDirs         && !m_dirList.empty())
        )
     {
       const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
       QCString label = lde->kind()==LayoutDocEntry::GroupClasses      ? "nested-classes" :
                        lde->kind()==LayoutDocEntry::GroupConcepts     ? "concepts"       :
                        lde->kind()==LayoutDocEntry::GroupNamespaces   ? "namespaces"     :
                        lde->kind()==LayoutDocEntry::GroupFiles        ? "files"          :
                        lde->kind()==LayoutDocEntry::GroupNestedGroups ? "groups"         :
                        "dirs";
       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, DefinitionMixin< GroupDef >::getLanguage(), getMemberList(), LayoutDocManager::Group, LayoutDocEntry::GroupClasses, LayoutDocEntry::GroupConcepts, LayoutDocEntry::GroupDirs, LayoutDocEntry::GroupFiles, LayoutDocEntry::GroupNamespaces, LayoutDocEntry::GroupNestedGroups, OutputGenerator::Html, LayoutDocManager::instance(), MemberList::listType(), MemberList::listTypeAsString(), m_classes, m_concepts, m_dirList, m_fileList, m_groups, m_namespaces, LayoutDocEntry::MemberDecl, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::title(), TRUE, LayoutDocEntryMemberDecl::type, OutputList::writeString() , 以及 OutputList::writeSummaryLink().

被这些函数引用 writeDocumentation().

◆ writeTagFile()

void GroupDefImpl::writeTagFile ( TextStream & tagFile )

virtual

实现了 GroupDef.

在文件 groupdef.cpp 第 611 行定义.

 {
   tagFile << "  <compound kind=\"group\">\n";
   tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
   tagFile << "    <title>" << convertToXML(m_title) << "</title>\n";
   tagFile << "    <filename>" << addHtmlExtensionIfMissing(getOutputFileBase()) << "</filename>\n";
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Group))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::GroupClasses:
         {
           for (const auto &cd : m_classes)
           {
             if (cd->isLinkableInProject())
             {
               tagFile << "    <class kind=\"" << cd->compoundTypeString()
                       << "\">" << convertToXML(cd->name()) << "</class>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::GroupConcepts:
         {
           for (const auto &cd : m_concepts)
           {
             if (cd->isLinkableInProject())
             {
               tagFile << "    <concept>" << convertToXML(cd->name())
                       << "</concept>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::GroupNamespaces:
         {
           for (const auto &nd : m_namespaces)
           {
             if (nd->isLinkableInProject())
             {
               tagFile << "    <namespace>" << convertToXML(nd->name())
                       << "</namespace>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::GroupFiles:
         {
           for (const auto &fd : m_fileList)
           {
             if (fd->isLinkableInProject())
             {
               tagFile << "    <file>" << convertToXML(fd->name()) << "</file>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::GroupPageDocs:
         {
           for (const auto &pd : m_pages)
           {
             QCString pageName = pd->getOutputFileBase();
             if (pd->isLinkableInProject())
             {
               tagFile << "    <page>" << convertToXML(pageName) << "</page>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::GroupDirs:
         {
           for (const auto &dd : m_dirList)
           {
             if (dd->isLinkableInProject())
             {
               tagFile << "    <dir>" << convertToXML(dd->displayName()) << "</dir>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::GroupNestedGroups:
         {
           for (const auto &gd : m_groups)
           {
             if (gd->isVisible())
             {
               tagFile << "    <subgroup>" << convertToXML(gd->name()) << "</subgroup>\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(), getMemberList(), getOutputFileBase(), LayoutDocManager::Group, LayoutDocEntry::GroupClasses, LayoutDocEntry::GroupConcepts, LayoutDocEntry::GroupDirs, LayoutDocEntry::GroupFiles, LayoutDocEntry::GroupNamespaces, LayoutDocEntry::GroupNestedGroups, LayoutDocEntry::GroupPageDocs, LayoutDocManager::instance(), m_classes, m_concepts, m_dirList, m_fileList, m_groups, m_memberGroups, m_namespaces, m_pages, m_title, LayoutDocEntry::MemberDecl, LayoutDocEntry::MemberGroups, DefinitionMixin< GroupDef >::name(), LayoutDocEntryMemberDecl::type, DefinitionMixin< GroupDef >::writeDocAnchorsToTagFile() , 以及 MemberList::writeTagFile().

类成员变量说明

◆ m_allMemberList

MemberList GroupDefImpl::m_allMemberList

private

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

被这些函数引用 computeAnchors(), insertMember(), numDocMembers(), writeDocumentation() , 以及 writeQuickMemberLinks().

◆ m_allMemberNameInfoLinkedMap

MemberNameInfoLinkedMap GroupDefImpl::m_allMemberNameInfoLinkedMap

private

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

被这些函数引用 insertMember() , 以及 removeMember().

◆ m_classes

ClassLinkedRefMap GroupDefImpl::m_classes

private

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

被这些函数引用 addClass(), numDocMembers(), sortMemberLists(), writeClasses(), writeInlineClasses(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_concepts

ConceptLinkedRefMap GroupDefImpl::m_concepts

private

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

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

◆ m_dirList

DirList GroupDefImpl::m_dirList

private

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

被这些函数引用 addDir(), setGroupScope(), sortMemberLists(), writeDirs(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_examples

PageLinkedRefMap GroupDefImpl::m_examples

private

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

被这些函数引用 addExample(), getGroupScope() , 以及 numDocMembers().

◆ m_fileList

FileList GroupDefImpl::m_fileList

private

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

被这些函数引用 addFile(), numDocMembers(), writeFiles(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_fileName

QCString GroupDefImpl::m_fileName

private

在文件 groupdef.cpp 第 159 行定义.

被这些函数引用 getOutputFileBase().

◆ m_groups

GroupList GroupDefImpl::m_groups

private

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

被这些函数引用 addGroup(), findGroup(), numDocMembers(), sortSubGroups(), subGrouping(), writeNestedGroups(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_groupScope

Definition* GroupDefImpl::m_groupScope

private

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

◆ m_memberGroups

MemberGroupList GroupDefImpl::m_memberGroups

private

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

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

◆ m_memberLists

MemberLists GroupDefImpl::m_memberLists

private

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

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

◆ m_namespaces

NamespaceLinkedRefMap GroupDefImpl::m_namespaces

private

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

被这些函数引用 addNamespace(), numDocMembers(), sortMemberLists(), writeNamespaces(), writeSummaryLinks() , 以及 writeTagFile().

◆ m_pages

PageLinkedRefMap GroupDefImpl::m_pages

private

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

被这些函数引用 addPage(), hasDetailedDescription(), numDocMembers(), writeDetailedDescription(), writePageDocumentation() , 以及 writeTagFile().

◆ m_subGrouping

bool GroupDefImpl::m_subGrouping

private

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

◆ m_title

QCString GroupDefImpl::m_title

private

在文件 groupdef.cpp 第 157 行定义.

被这些函数引用 setGroupTitle(), writeDocumentation(), writeGroupGraph() , 以及 writeTagFile().

◆ m_titleSet

bool GroupDefImpl::m_titleSet

private

在文件 groupdef.cpp 第 158 行定义.

被这些函数引用 setGroupTitle().

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

src/groupdef.cpp

Private 属性
QCString	m_title

bool	m_titleSet

QCString	m_fileName

FileList	m_fileList

ClassLinkedRefMap	m_classes

ConceptLinkedRefMap	m_concepts

NamespaceLinkedRefMap	m_namespaces

GroupList	m_groups

PageLinkedRefMap	m_pages

PageLinkedRefMap	m_examples

DirList	m_dirList

MemberList	m_allMemberList

MemberNameInfoLinkedMap	m_allMemberNameInfoLinkedMap

Definition *	m_groupScope

MemberLists	m_memberLists

MemberGroupList	m_memberGroups

bool	m_subGrouping

Public 成员函数

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ GroupDefImpl()

◆ ~GroupDefImpl()

成员函数说明

◆ addClass()

◆ addConcept()

◆ addDir()

◆ addExample()

◆ addFile()

◆ addGroup()

◆ addListReferences()

◆ addMemberListToGroup()

◆ addMembersToMemberGroup()

◆ addMemberToList()

◆ addNamespace()

◆ addPage()

◆ anchor()

◆ codeSymbolType()

◆ computeAnchors()

◆ countMembers()

◆ definitionType()

◆ displayName()

◆ distributeMemberGroupDocumentation()

◆ endMemberDeclarations()

◆ endMemberDocumentation()

◆ findGroup()

◆ findSectionsInDocumentation()

◆ getClasses()

◆ getConcepts()

◆ getDirs()

◆ getExamples()

◆ getFiles()

◆ getGroupScope()

◆ getMemberGroups()

◆ getMemberList()

◆ getMemberLists()

◆ getNamespaces()

◆ getOutputFileBase()

◆ getPages()

◆ getSubGroups()

◆ groupTitle()

◆ hasDetailedDescription()

◆ hasGroupTitle()

◆ insertMember()

◆ isASubGroup()

◆ isLinkable()

◆ isLinkableInProject()

◆ numDocMembers()

◆ removeMember()

◆ removeMemberFromList()

◆ setGroupScope()

◆ setGroupTitle()

◆ sortMemberLists()

◆ sortSubGroups()

◆ startMemberDeclarations()

◆ startMemberDocumentation()

◆ subGrouping()

◆ updateLanguage()

◆ writeAuthorSection()

◆ writeBriefDescription()

◆ writeClasses()

◆ writeConcepts()

◆ writeDetailedDescription()

◆ writeDirs()

◆ writeDocumentation()

◆ writeFiles()

◆ writeGroupGraph()

◆ writeInlineClasses()

◆ writeMemberDeclarations()

◆ writeMemberDocumentation()

◆ writeMemberGroups()

◆ writeMemberPages()

◆ writeNamespaces()

◆ writeNestedGroups()

◆ writePageDocumentation()