A model of a group of symbols. 更多...

#include <groupdef.h>

类 GroupDef 继承关系图:

GroupDef 的协作图:

Public 成员函数
	~GroupDef ()

virtual DefType	definitionType () const =0

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual QCString	displayName (bool=TRUE) const =0

virtual QCString	groupTitle () const =0

virtual void	setGroupTitle (const QCString &newtitle)=0

virtual bool	hasGroupTitle () const =0

virtual void	addFile (const FileDef *def)=0

virtual bool	addClass (const ClassDef *def)=0

virtual bool	addConcept (const ConceptDef *def)=0

virtual bool	addNamespace (const NamespaceDef *def)=0

virtual void	addGroup (const GroupDef *def)=0

virtual void	addPage (const PageDef *def)=0

virtual void	addExample (const PageDef *def)=0

virtual void	addDir (DirDef *dd)=0

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

virtual void	removeMember (MemberDef *md)=0

virtual bool	findGroup (const GroupDef *def) const =0

virtual void	writeDocumentation (OutputList &ol)=0

virtual void	writeMemberPages (OutputList &ol)=0

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

virtual void	writeTagFile (TextStream &)=0

virtual size_t	numDocMembers () const =0

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual bool	isASubGroup () const =0

virtual void	computeAnchors ()=0

virtual void	countMembers ()=0

virtual void	addMembersToMemberGroup ()=0

virtual void	distributeMemberGroupDocumentation ()=0

virtual void	findSectionsInDocumentation ()=0

virtual void	addListReferences ()=0

virtual void	sortMemberLists ()=0

virtual bool	subGrouping () const =0

virtual void	setGroupScope (Definition *d)=0

virtual Definition *	getGroupScope () const =0

virtual MemberList *	getMemberList (MemberListType lt) const =0

virtual const MemberLists &	getMemberLists () const =0

virtual const MemberGroupList &	getMemberGroups () const =0

virtual const FileList &	getFiles () const =0

virtual const ClassLinkedRefMap &	getClasses () const =0

virtual const ConceptLinkedRefMap &	getConcepts () const =0

virtual const NamespaceLinkedRefMap &	getNamespaces () const =0

virtual const GroupList &	getSubGroups () const =0

virtual const PageLinkedRefMap &	getPages () const =0

virtual const DirList &	getDirs () const =0

virtual const PageLinkedRefMap &	getExamples () const =0

virtual bool	hasDetailedDescription () const =0

virtual void	sortSubGroups ()=0

Public 成员函数继承自 DefinitionMutable
virtual void	setName (const QCString &name)=0

virtual void	setId (const QCString &name)=0

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

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

virtual void	setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0

virtual void	setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0

virtual void	setReference (const QCString &r)=0

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

virtual void	setBodyDef (const FileDef *fd)=0

virtual void	setRefItems (const RefItemVector &sli)=0

virtual void	setOuterScope (Definition *d)=0

virtual void	setHidden (bool b)=0

virtual void	setArtificial (bool b)=0

virtual void	setLanguage (SrcLangExt lang)=0

virtual void	setLocalName (const QCString &name)=0

virtual void	makePartOfGroup (const GroupDef *gd)=0

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

virtual void	addSourceReferencedBy (const MemberDef *d)=0

virtual void	addSourceReferences (const MemberDef *d)=0

virtual void	mergeRefItems (Definition *d)=0

virtual void	addInnerCompound (const Definition *d)=0

virtual void	addSectionsToIndex ()=0

virtual void	mergeReferences (const Definition *other)=0

virtual void	mergeReferencedBy (const Definition *other)=0

virtual void	computeTooltip ()=0

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

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

virtual bool	hasSourceRefs () const =0

virtual bool	hasSourceReffedBy () const =0

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

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

virtual void	writeNavigationPath (OutputList &ol) const =0

virtual void	writeSummaryLinks (OutputList &) const =0

virtual void	writeDocAnchorsToTagFile (TextStream &) const =0

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

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 Definition
virtual CodeSymbolType	codeSymbolType () const =0

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	briefDescription (bool abbreviate=FALSE) const =0

virtual QCString	briefDescriptionAsTooltip () const =0

virtual int	briefLine () const =0

virtual QCString	inbodyDocumentation () const =0

virtual QCString	inbodyFile () const =0

virtual int	inbodyLine () const =0

virtual QCString	briefFile () const =0

virtual QCString	getDefFileName () const =0

virtual QCString	getDefFileExtension () const =0

virtual int	getDefLine () const =0

virtual int	getDefColumn () const =0

virtual bool	hasDocumentation () const =0

virtual bool	hasUserDocumentation () const =0

virtual bool	isVisibleInProject () const =0

virtual bool	isVisible () const =0

virtual bool	isHidden () const =0

virtual bool	isArtificial () const =0

virtual QCString	getReference () const =0

virtual bool	isReference () const =0

virtual QCString	externalReference (const QCString &relPath) const =0

virtual int	getStartDefLine () const =0

virtual int	getStartBodyLine () const =0

virtual int	getEndBodyLine () const =0

virtual const FileDef *	getBodyDef () const =0

virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in. 更多...

virtual const GroupList &	partOfGroups () const =0

virtual bool	isLinkableViaGroup () const =0

virtual const RefItemVector &	xrefListItems () const =0

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

virtual Definition *	getOuterScope () const =0

virtual const MemberVector &	getReferencesMembers () const =0

virtual const MemberVector &	getReferencedByMembers () const =0

virtual bool	hasSections () const =0

virtual bool	hasSources () const =0

virtual bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description 更多...

virtual QCString	id () const =0

virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef 更多...

virtual QCString	navigationPathAsString () const =0

virtual QCString	pathFragment () const =0

virtual void	_setSymbolName (const QCString &name)=0

virtual QCString	_symbolName () const =0

virtual	~Definition ()=default

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

详细描述

A model of a group of symbols.

在文件 groupdef.h 第 49 行定义.

构造及析构函数说明

◆ ~GroupDef()

GroupDef::~GroupDef ( )

inline

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

52 {}

成员函数说明

◆ addClass()

virtual bool GroupDef::addClass ( const ClassDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addClassToGroups() , 以及 ClassDefImpl::setGroupDefForAllMembers().

◆ addConcept()

virtual bool GroupDef::addConcept ( const ConceptDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addConceptToGroups().

◆ addDir()

virtual void GroupDef::addDir ( DirDef * dd )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addDirToGroups().

◆ addExample()

virtual void GroupDef::addExample ( const PageDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addExampleToGroups().

◆ addFile()

virtual void GroupDef::addFile ( const FileDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 buildFileList().

◆ addGroup()

virtual void GroupDef::addGroup ( const GroupDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addGroupToGroups().

◆ addListReferences()

virtual void GroupDef::addListReferences ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addListReferences().

◆ addMembersToMemberGroup()

virtual void GroupDef::addMembersToMemberGroup ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addMembersToMemberGroup().

◆ addNamespace()

virtual bool GroupDef::addNamespace ( const NamespaceDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addNamespaceToGroups() , 以及 findUsingDirectives().

◆ addPage()

virtual void GroupDef::addPage ( const PageDef * def )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addRelatedPage().

◆ anchor()

virtual QCString GroupDef::anchor ( ) const

pure virtual

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

实现了 Definition.

在 GroupDefImpl 内被实现.

被这些函数引用 addToIndices().

◆ computeAnchors()

virtual void GroupDef::computeAnchors ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 computeMemberReferences().

◆ countMembers()

virtual void GroupDef::countMembers ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 countMembers().

◆ definitionType()

virtual DefType GroupDef::definitionType ( ) const

pure virtual

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

实现了 Definition.

在 GroupDefImpl 内被实现.

◆ displayName()

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

pure virtual

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

实现了 Definition.

在 GroupDefImpl 内被实现.

◆ distributeMemberGroupDocumentation()

virtual void GroupDef::distributeMemberGroupDocumentation ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 distributeMemberGroupDocumentation().

◆ findGroup()

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

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addGroupToGroups().

◆ findSectionsInDocumentation()

virtual void GroupDef::findSectionsInDocumentation ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 findSectionsInDocumentation().

◆ getClasses()

virtual const ClassLinkedRefMap& GroupDef::getClasses ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addClasses(), DotGroupCollaboration::buildGraph(), ModuleContext::Private::createClasses(), ModuleContext::Private::createInlineClasses(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup() , 以及 writeGroupTreeNode().

◆ getConcepts()

virtual const ConceptLinkedRefMap& GroupDef::getConcepts ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addConcepts(), NestingNodeContext::Private::addNamespaces() , 以及 writeGroupTreeNode().

◆ getDirs()

virtual const DirList& GroupDef::getDirs ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addDirFiles(), DotGroupCollaboration::buildGraph(), ModuleContext::Private::createDirs() , 以及 writeGroupTreeNode().

◆ getExamples()

virtual const PageLinkedRefMap& GroupDef::getExamples ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 ModuleContext::Private::createExamples().

◆ getFiles()

virtual const FileList& GroupDef::getFiles ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 DotGroupCollaboration::buildGraph(), ModuleContext::Private::createFiles(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup() , 以及 writeGroupTreeNode().

◆ getGroupScope()

virtual Definition* GroupDef::getGroupScope ( ) const

pure virtual

在 GroupDefImpl 内被实现.

◆ getMemberGroups()

virtual const MemberGroupList& GroupDef::getMemberGroups ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 ModuleContext::Private::createMemberGroups(), PerlModGenerator::generatePerlModForGroup() , 以及 generateXMLForGroup().

◆ getMemberList()

virtual MemberList* GroupDef::getMemberList ( MemberListType lt ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addMembers(), DotGroupCollaboration::buildGraph(), ModuleContext::Private::createMemberList(), PerlModGenerator::generatePerlModForGroup() , 以及 writeGroupTreeNode().

◆ getMemberLists()

virtual const MemberLists& GroupDef::getMemberLists ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 generateXMLForGroup() , 以及 writeGroupTreeNode().

◆ getNamespaces()

virtual const NamespaceLinkedRefMap& GroupDef::getNamespaces ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 DotGroupCollaboration::buildGraph(), ModuleContext::Private::createConstantgroups(), ModuleContext::Private::createNamespaces(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup() , 以及 writeGroupTreeNode().

◆ getOutputFileBase()

virtual QCString GroupDef::getOutputFileBase ( ) const

pure virtual

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

实现了 Definition.

在 GroupDefImpl 内被实现.

◆ getPages()

virtual const PageLinkedRefMap& GroupDef::getPages ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addPages(), DotGroupCollaboration::buildGraph(), ModuleContext::Private::createPages(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup() , 以及 writeGroupTreeNode().

◆ getSubGroups()

virtual const GroupList& GroupDef::getSubGroups ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 NestingNodeContext::Private::addModules(), DotGroupCollaboration::buildGraph(), ModuleContext::Private::createModules(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup() , 以及 writeGroupTreeNode().

◆ groupTitle()

virtual QCString GroupDef::groupTitle ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addToIndices(), buildGroupListFiltered(), DotGroupCollaboration::DotGroupCollaboration(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), DocParser::handleLinkedWord(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment(), SearchIndex::setCurrentDoc(), ModuleContext::Private::title() , 以及 writeGroupTreeNode().

◆ hasDetailedDescription()

virtual bool GroupDef::hasDetailedDescription ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 ModuleContext::Private::hasDetails().

◆ hasGroupTitle()

virtual bool GroupDef::hasGroupTitle ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 buildGroupListFiltered().

◆ insertMember()

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

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addMemberToGroups(), MemberGroup::insertMember() , 以及 ClassDefImpl::setGroupDefForAllMembers().

◆ isASubGroup()

virtual bool GroupDef::isASubGroup ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 writeGroupTreeNode().

◆ isLinkable()

virtual bool GroupDef::isLinkable ( ) const

pure virtual

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

实现了 Definition.

在 GroupDefImpl 内被实现.

被这些函数引用 addMemberToSearchIndex(), findMembersWithSpecificName() , 以及 getDefs().

◆ isLinkableInProject()

virtual bool GroupDef::isLinkableInProject ( ) const

pure virtual

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

实现了 Definition.

在 GroupDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_computeLinkableInProject(), addToIndices() , 以及 writeTagFile().

◆ numDocMembers()

virtual size_t GroupDef::numDocMembers ( ) const

pure virtual

在 GroupDefImpl 内被实现.

◆ removeMember()

virtual void GroupDef::removeMember ( MemberDef * md )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 addMemberToGroups().

◆ setGroupScope()

virtual void GroupDef::setGroupScope ( Definition * d )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 findGroupScope().

◆ setGroupTitle()

virtual void GroupDef::setGroupTitle ( const QCString & newtitle )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 buildGroupListFiltered().

◆ sortMemberLists()

virtual void GroupDef::sortMemberLists ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 sortMemberLists().

◆ sortSubGroups()

virtual void GroupDef::sortSubGroups ( )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 parseInput().

◆ subGrouping()

virtual bool GroupDef::subGrouping ( ) const

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 ModuleContext::Private::createMemberGroups().

◆ writeDocumentation()

virtual void GroupDef::writeDocumentation ( OutputList & ol )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 generateGroupDocs().

◆ writeMemberPages()

virtual void GroupDef::writeMemberPages ( OutputList & ol )

pure virtual

在 GroupDefImpl 内被实现.

◆ writeQuickMemberLinks()

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

pure virtual

实现了 DefinitionMutable.

在 DefinitionMixin< GroupDef > , 以及 GroupDefImpl 内被实现.

◆ writeTagFile()

virtual void GroupDef::writeTagFile ( TextStream & )

pure virtual

在 GroupDefImpl 内被实现.

被这些函数引用 writeTagFile().

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

src/groupdef.h

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~GroupDef()

成员函数说明

◆ addClass()

◆ addConcept()

◆ addDir()

◆ addExample()

◆ addFile()

◆ addGroup()

◆ addListReferences()

◆ addMembersToMemberGroup()

◆ addNamespace()

◆ addPage()

◆ anchor()

◆ computeAnchors()

◆ countMembers()

◆ definitionType()

◆ displayName()

◆ distributeMemberGroupDocumentation()

◆ findGroup()

◆ findSectionsInDocumentation()

◆ getClasses()

◆ getConcepts()

◆ getDirs()

◆ getExamples()

◆ getFiles()

◆ getGroupScope()

◆ getMemberGroups()

◆ getMemberList()

◆ getMemberLists()

◆ getNamespaces()

◆ getOutputFileBase()

◆ getPages()

◆ getSubGroups()

◆ groupTitle()

◆ hasDetailedDescription()

◆ hasGroupTitle()

◆ insertMember()

◆ isASubGroup()

◆ isLinkable()

◆ isLinkableInProject()

◆ numDocMembers()

◆ removeMember()

◆ setGroupScope()

◆ setGroupTitle()

◆ sortMemberLists()

◆ sortSubGroups()

◆ subGrouping()

◆ writeDocumentation()

◆ writeMemberPages()

◆ writeQuickMemberLinks()

◆ writeTagFile()