MemberGroup类 参考

A class representing a group of members. 更多...

#include <membergroup.h>

MemberGroup 的协作图:

Public 成员函数
	MemberGroup (const Definition *container, int id, const QCString &header, const QCString &docs, const QCString &docFile, int docLine, MemberListContainer con)
	~MemberGroup ()
QCString	header () const
int	groupId () const
void	insertMember (const MemberDef *md)
void	setAnchors ()
void	writePlainDeclarations (OutputList &ol, bool inGroup, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const
void	writeDeclarations (OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool showInline=FALSE) const
void	writeDocumentation (OutputList &ol, const QCString &scopeName, const Definition *container, bool showEnumValues, bool showInline) const
void	writeDocumentationPage (OutputList &ol, const QCString &scopeName, const DefinitionMutable *container) const
void	writeTagFile (TextStream &)
void	addGroupedInheritedMembers (OutputList &ol, const ClassDef *cd, MemberListType lt, const ClassDef *inheritedFrom, const QCString &inheritId) const
void	setAnonymousEnumType ()
const QCString &	documentation () const
bool	allMembersInSameSection () const
void	addToDeclarationSection ()
void	countDecMembers ()
void	countDocMembers ()
int	countGroupedInheritedMembers (MemberListType lt)
void	distributeMemberGroupDocumentation ()
void	findSectionsInDocumentation (const Definition *d)
int	numDecMembers () const
int	numDecEnumValues () const
int	numDocMembers () const
int	numDocEnumValues () const
const Definition *	container () const
int	countInheritableMembers (const ClassDef *inheritedFrom) const
void	addListReferences (Definition *d)
void	setRefItems (const RefItemVector &sli)
const MemberList &	members () const
QCString	anchor () const
QCString	docFile () const
int	docLine () const

Private 属性
const Definition *	m_container
std::unique_ptr< MemberList >	memberList
MemberList *	inDeclSection = 0
int	grpId = 0
QCString	grpHeader
QCString	fileName
QCString	doc
bool	inSameSection = true
QCString	m_docFile
int	m_docLine
RefItemVector	m_xrefListItems

详细描述

A class representing a group of members.

在文件 membergroup.h 第 41 行定义.

构造及析构函数说明

MemberGroup()

MemberGroup::MemberGroup	(	const Definition *	container,
		int	id,
		const QCString &	header,
		const QCString &	docs,
		const QCString &	docFile,
		int	docLine,
		MemberListContainer	con
	)

在文件 membergroup.cpp 第 32 行定义.

  : m_container(container),
    memberList(std::make_unique<MemberList>(MemberListType_memberGroup,con)),
    grpId(id), grpHeader(hdr), doc(d), m_docFile(docFile), m_docLine(docLine)
{
  //printf("New member group id=%d header=%s desc=%s\n",id,hdr,d);
  memberList->setNeedsSorting(Config_getBool(SORT_BRIEF_DOCS)); // detailed sections are already sorted elsewhere.
  //printf("Member group docs='%s'\n",qPrint(doc));
}

引用了 Config_getBool , 以及 memberList.

~MemberGroup()

MemberGroup::~MemberGroup

(

)

在文件 membergroup.cpp 第 44 行定义.

{
}

成员函数说明

addGroupedInheritedMembers()

void MemberGroup::addGroupedInheritedMembers	(	OutputList &	ol,
		const ClassDef *	cd,
		MemberListType	lt,
		const ClassDef *	inheritedFrom,
		const QCString &	inheritId
	)		const

在文件 membergroup.cpp 第 129 行定义.

{
  //printf("** addGroupedInheritedMembers()\n");
  for (const auto &md : *memberList)
  {
    //printf("matching %d == %d\n",lt,md->getSectionList()->listType());
    const MemberList *ml = md->getSectionList(m_container);
    if (ml && lt==ml->listType())
    {
      MemberList mml(lt,MemberListContainer::Class);
      mml.push_back(md);
      mml.countDecMembers();
      mml.writePlainDeclarations(ol,false,cd,0,0,0,0,inheritedFrom,inheritId);
    }
  }
}

引用了 Class, MemberList::countDecMembers(), MemberList::listType(), m_container, memberList, MemberVector::push_back() , 以及 MemberList::writePlainDeclarations().

addListReferences()

void MemberGroup::addListReferences

(

Definition *

d

)

在文件 membergroup.cpp 第 269 行定义.

{
  memberList->addListReferences(def);
  if (def)
  {
    QCString name = def->getOutputFileBase()+"#"+anchor();
    addRefItem(m_xrefListItems,
        name,
        theTranslator->trGroup(TRUE,TRUE),
        name,
        grpHeader,QCString(),def);
  }
}

引用了 addRefItem(), anchor(), Definition::getOutputFileBase(), grpHeader, m_xrefListItems, memberList, theTranslator, Translator::trGroup() , 以及 TRUE.

addToDeclarationSection()

void MemberGroup::addToDeclarationSection

(

)

Add this group as a subsection of the declaration section, instead of rendering it in its own section

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

{
  if (inDeclSection)
  {
    //printf("Adding group %p to list %p (type=%d) memberList=%p\n",this,
    //                             inDeclSection,inDeclSection->listType(),memberList);
    inDeclSection->addMemberGroup(this);
  }
}

引用了 MemberList::addMemberGroup() , 以及 inDeclSection.

allMembersInSameSection()

bool MemberGroup::allMembersInSameSection ( ) const

inline

在文件 membergroup.h 第 69 行定义.

{ return inSameSection; }

引用了 inSameSection.

anchor()

QCString MemberGroup::anchor

(

)

const

在文件 membergroup.cpp 第 258 行定义.

{
  uchar md5_sig[16];
  char sigStr[33];
  QCString locHeader = grpHeader;
  if (locHeader.isEmpty()) locHeader="[NOHEADER]";
  MD5Buffer((const unsigned char *)locHeader.data(),locHeader.length(),md5_sig);
  MD5SigToString(md5_sig,sigStr);
  return QCString("amgrp")+sigStr;
}

引用了 QCString::data(), grpHeader, QCString::isEmpty() , 以及 QCString::length().

被这些函数引用 addListReferences(), MemberGroupInfoContext::Private::groupAnchor() , 以及 writeDeclarations().

container()

const Definition * MemberGroup::container

(

)

const

在文件 membergroup.cpp 第 188 行定义.

{
  return m_container;
}

引用了 m_container.

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

countDecMembers()

void MemberGroup::countDecMembers

(

)

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

{
  memberList->countDecMembers();
}

引用了 memberList.

countDocMembers()

void MemberGroup::countDocMembers

(

)

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

{
  memberList->countDocMembers();
}

引用了 memberList.

countGroupedInheritedMembers()

int MemberGroup::countGroupedInheritedMembers

(

MemberListType

lt

)

在文件 membergroup.cpp 第 148 行定义.

{
  //printf("** countGroupedInheritedMembers()\n");
  int count=0;
  for (const auto &md : *memberList)
  {
    //printf("matching %d == %d\n",lt,md->getSectionList()->listType());
    const MemberList *ml = md->getSectionList(m_container);
    if (ml && lt==ml->listType())
    {
      count++;
    }
  }
  return count;
}

引用了 MemberList::listType(), m_container , 以及 memberList.

countInheritableMembers()

int MemberGroup::countInheritableMembers

(

const ClassDef *

inheritedFrom

)

const

在文件 membergroup.cpp 第 193 行定义.

{
  return memberList->countInheritableMembers(inheritedFrom);
}

引用了 memberList.

distributeMemberGroupDocumentation()

void MemberGroup::distributeMemberGroupDocumentation

(

)

在文件 membergroup.cpp 第 199 行定义.

{
  //printf("MemberGroup::distributeMemberGroupDocumentation() %s\n",qPrint(grpHeader));
  const MemberDef *md = 0;
  for (const auto &smd : *memberList)
  {
    //printf("checking md=%s\n",qPrint(md->name()));
    // find the first member of the group with documentation
    if (!smd->documentation().isEmpty()       ||
        !smd->briefDescription().isEmpty()    ||
        !smd->inbodyDocumentation().isEmpty()
       )
    {
      //printf("found it!\n");
      md = smd;
      break;
    }
  }
  if (md) // distribute docs of md to other members of the list
  {
    //printf("Member %s has documentation!\n",qPrint(md->name()));
    for (const auto &iomd : *memberList)
    {
      MemberDefMutable *omd = toMemberDefMutable(iomd);
      if (omd && md!=omd && omd->documentation().isEmpty() &&
                            omd->briefDescription().isEmpty() &&
                            omd->inbodyDocumentation().isEmpty()
         )
      {
        //printf("Copying documentation to member %s\n",qPrint(omd->name()));
        omd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
        omd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
        omd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
      }
    }
  }
}

引用了 MemberDef::briefDescription(), Definition::briefFile(), Definition::briefLine(), Definition::docFile(), Definition::docLine(), MemberDef::documentation(), Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), QCString::isEmpty(), memberList, MemberDefMutable::setBriefDescription(), MemberDefMutable::setDocumentation(), MemberDefMutable::setInbodyDocumentation() , 以及 toMemberDefMutable().

docFile()

QCString MemberGroup::docFile ( ) const

inline

在文件 membergroup.h 第 88 行定义.

{ return m_docFile; }

引用了 m_docFile.

docLine()

int MemberGroup::docLine ( ) const

inline

在文件 membergroup.h 第 89 行定义.

{ return m_docLine; }

引用了 m_docLine.

documentation()

const QCString& MemberGroup::documentation ( ) const

inline

在文件 membergroup.h 第 68 行定义.

{ return doc; }

引用了 doc.

被这些函数引用 MemberGroupInfoContext::Private::createDocs().

findSectionsInDocumentation()

void MemberGroup::findSectionsInDocumentation

(

const Definition *

d

)

在文件 membergroup.cpp 第 283 行定义.

{
  docFindSections(doc,d,m_docFile);
  memberList->findSectionsInDocumentation(d);
}

引用了 doc, docFindSections(), m_docFile , 以及 memberList.

groupId()

int MemberGroup::groupId ( ) const

inline

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

{ return grpId; }

引用了 grpId.

header()

QCString MemberGroup::header ( ) const

inline

在文件 membergroup.h 第 48 行定义.

{ return grpHeader; }

引用了 grpHeader.

被这些函数引用 MemberGroupInfoContext::Private::groupTitle() , 以及 MemberDefImpl::visibleMemberGroup().

insertMember()

void MemberGroup::insertMember

(

const MemberDef *

md

)

在文件 membergroup.cpp 第 48 行定义.

{
  //printf("MemberGroup::insertMember memberList=%p count=%d"
  //       " member section list: %p: md=%p:%s\n",
  //       memberList->first() ? memberList->first()->getSectionList() : 0,
  //       memberList->count(),
  //       md->getSectionList(),
  //       md,qPrint(md->name()));
 
  const MemberDef *firstMd = memberList->empty() ? 0 : memberList->front();
  if (inSameSection && firstMd &&
      firstMd->getSectionList(m_container)!=md->getSectionList(m_container))
  {
    inSameSection=FALSE;
  }
  else if (inDeclSection==0)
  {
    inDeclSection = const_cast<MemberList*>(md->getSectionList(m_container));
    //printf("inDeclSection=%p type=%d\n",inDeclSection,inDeclSection->listType());
  }
  memberList->push_back(md);
 
  // copy the group of the first member in the memberGroup
  GroupDef *gd;
  if (firstMd && !firstMd->isAlias() && (gd=const_cast<GroupDef*>(firstMd->getGroupDef())))
  {
    MemberDefMutable *mdm = toMemberDefMutable(md);
    if (mdm)
    {
      mdm->setGroupDef(gd, firstMd->getGroupPri(),
                       firstMd->getGroupFileName(),
                       firstMd->getGroupStartLine(),
                       firstMd->getGroupHasDocs());
    }
    gd->insertMember(md);
  }
}

引用了 FALSE, MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), MemberDef::getGroupStartLine(), MemberDef::getSectionList(), inDeclSection, inSameSection, GroupDef::insertMember(), Definition::isAlias(), m_container, memberList, MemberDefMutable::setGroupDef() , 以及 toMemberDefMutable().

被这些函数引用 addMembersToMemberGroup().

members()

const MemberList& MemberGroup::members ( ) const

inline

在文件 membergroup.h 第 85 行定义.

{ return *memberList.get(); }

引用了 memberList.

被这些函数引用 MemberGroupInfoContext::Private::createMembers().

numDecEnumValues()

int MemberGroup::numDecEnumValues

(

)

const

在文件 membergroup.cpp 第 243 行定义.

{
  return memberList->numDecEnumValues();
}

引用了 memberList.

numDecMembers()

int MemberGroup::numDecMembers

(

)

const

在文件 membergroup.cpp 第 238 行定义.

{
  return memberList->numDecMembers();
}

引用了 memberList.

numDocEnumValues()

int MemberGroup::numDocEnumValues

(

)

const

在文件 membergroup.cpp 第 253 行定义.

{
  return memberList->numDocEnumValues();
}

引用了 memberList.

numDocMembers()

int MemberGroup::numDocMembers

(

)

const

在文件 membergroup.cpp 第 248 行定义.

{
  return memberList->numDocMembers();
}

引用了 memberList.

setAnchors()

void MemberGroup::setAnchors

(

)

在文件 membergroup.cpp 第 87 行定义.

{
  memberList->setAnchors();
}

引用了 memberList.

setAnonymousEnumType()

void MemberGroup::setAnonymousEnumType

(

)

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

{
  memberList->setAnonymousEnumType();
}

引用了 memberList.

setRefItems()

void MemberGroup::setRefItems

(

const RefItemVector &

sli

)

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

{
  m_xrefListItems.insert(m_xrefListItems.end(), sli.cbegin(), sli.cend());
}

引用了 m_xrefListItems.

writeDeclarations()

void MemberGroup::writeDeclarations	(	OutputList &	ol,
		const ClassDef *	cd,
		const NamespaceDef *	nd,
		const FileDef *	fd,
		const GroupDef *	gd,
		bool	showInline = FALSE
	)		const

在文件 membergroup.cpp 第 92 行定义.

{
  //printf("MemberGroup::writeDeclarations() %s\n",qPrint(grpHeader));
  QCString ldoc = doc;
  if (!ldoc.isEmpty()) ldoc.prepend("<a name=\""+anchor()+"\" id=\""+anchor()+"\"></a>");
  memberList->writeDeclarations(ol,cd,nd,fd,gd,grpHeader,ldoc,FALSE,showInline);
}

引用了 anchor(), doc, FALSE, grpHeader, QCString::isEmpty(), memberList , 以及 QCString::prepend().

writeDocumentation()

void MemberGroup::writeDocumentation	(	OutputList &	ol,
		const QCString &	scopeName,
		const Definition *	container,
		bool	showEnumValues,
		bool	showInline
	)		const

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

{
  //printf("MemberGroup::writeDocumentation() %s\n",qPrint(grpHeader));
  memberList->writeDocumentation(ol,scopeName,container,QCString(),showEnumValues,showInline);
}

引用了 container() , 以及 memberList.

writeDocumentationPage()

void MemberGroup::writeDocumentationPage	(	OutputList &	ol,
		const QCString &	scopeName,
		const DefinitionMutable *	container
	)		const

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

{
  memberList->writeDocumentationPage(ol,scopeName,container);
}

引用了 container() , 以及 memberList.

writePlainDeclarations()

void MemberGroup::writePlainDeclarations	(	OutputList &	ol,
		bool	inGroup,
		const ClassDef *	cd,
		const NamespaceDef *	nd,
		const FileDef *	fd,
		const GroupDef *	gd,
		int	indentLevel,
		const ClassDef *	inheritedFrom,
		const QCString &	inheritId
	)		const

在文件 membergroup.cpp 第 102 行定义.

{
  //printf("MemberGroup::writePlainDeclarations() memberList->count()=%d\n",memberList->count());
  memberList->writePlainDeclarations(ol,inGroup,cd,nd,fd,gd,indentLevel,inheritedFrom,inheritId);
}

引用了 memberList.

writeTagFile()

void MemberGroup::writeTagFile

(

TextStream &

tagFile

)

在文件 membergroup.cpp 第 294 行定义.

{
  memberList->writeTagFile(tagFile);
}

引用了 memberList.

类成员变量说明

doc

QCString MemberGroup::doc

private

在文件 membergroup.h 第 98 行定义.

被这些函数引用 documentation(), findSectionsInDocumentation() , 以及 writeDeclarations().

fileName

QCString MemberGroup::fileName

private

在文件 membergroup.h 第 97 行定义.

grpHeader

QCString MemberGroup::grpHeader

private

在文件 membergroup.h 第 96 行定义.

被这些函数引用 addListReferences(), anchor(), header() , 以及 writeDeclarations().

grpId

int MemberGroup::grpId = 0

private

在文件 membergroup.h 第 95 行定义.

被这些函数引用 groupId().

inDeclSection

MemberList* MemberGroup::inDeclSection = 0

private

在文件 membergroup.h 第 94 行定义.

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

inSameSection

bool MemberGroup::inSameSection = true

private

在文件 membergroup.h 第 99 行定义.

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

m_container

const Definition* MemberGroup::m_container

private

在文件 membergroup.h 第 92 行定义.

被这些函数引用 addGroupedInheritedMembers(), container(), countGroupedInheritedMembers() , 以及 insertMember().

m_docFile

QCString MemberGroup::m_docFile

private

在文件 membergroup.h 第 100 行定义.

被这些函数引用 docFile() , 以及 findSectionsInDocumentation().

m_docLine

int MemberGroup::m_docLine

private

在文件 membergroup.h 第 101 行定义.

被这些函数引用 docLine().

m_xrefListItems

RefItemVector MemberGroup::m_xrefListItems

private

在文件 membergroup.h 第 102 行定义.

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

memberList

std::unique_ptr<MemberList> MemberGroup::memberList

private

在文件 membergroup.h 第 93 行定义.

被这些函数引用 addGroupedInheritedMembers(), addListReferences(), countDecMembers(), countDocMembers(), countGroupedInheritedMembers(), countInheritableMembers(), distributeMemberGroupDocumentation(), findSectionsInDocumentation(), insertMember(), MemberGroup(), members(), numDecEnumValues(), numDecMembers(), numDocEnumValues(), numDocMembers(), setAnchors(), setAnonymousEnumType(), writeDeclarations(), writeDocumentation(), writeDocumentationPage(), writePlainDeclarations() , 以及 writeTagFile().

---

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

• src/membergroup.h
• src/membergroup.cpp