#include <groupdef.h>

Inheritance diagram for GroupDef:

Public Member Functions
	GroupDef (const char fileName, int line, const char name, const char title, const char refFileName=0)

	~GroupDef ()

DefType	definitionType () const

QCString	getOutputFileBase () const

QCString	anchor () const

QCString	displayName (bool=TRUE) const

const char *	groupTitle () const

void	setGroupTitle (const char *newtitle)

bool	hasGroupTitle () const

void	addFile (const FileDef *def)

bool	addClass (const ClassDef *def)

bool	addNamespace (const NamespaceDef *def)

void	addGroup (const GroupDef *def)

void	addParentGroup (const GroupDef *def)

void	addPage (PageDef *def)

void	addExample (const PageDef *def)

void	addDir (const DirDef *dd)

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

void	removeMember (MemberDef *md)

bool	findGroup (const GroupDef *def) const

void	writeDocumentation (OutputList &ol)

void	writeMemberPages (OutputList &ol)

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

void	writeTagFile (FTextStream &)

int	countMembers () const

bool	isLinkableInProject () const

bool	isLinkable () const

bool	isASubGroup () const

void	computeAnchors ()

void	addMembersToMemberGroup ()

void	distributeMemberGroupDocumentation ()

void	findSectionsInDocumentation ()

void	addListReferences ()

void	sortMemberLists ()

bool	subGrouping () const

void	setGroupScope (Definition *d)

Definition *	getGroupScope () const

MemberList *	getMemberList (MemberListType lt) const

const QList< MemberList > &	getMemberLists () const

MemberGroupSDict *	getMemberGroupSDict () const

FileList *	getFiles () const

ClassSDict *	getClasses () const

NamespaceSDict *	getNamespaces () const

GroupList *	getSubGroups () const

PageSDict *	getPages () const

DirList *	getDirs () const

PageSDict *	getExamples () const

bool	hasDetailedDescription () const

void	sortSubGroups ()

Public Member Functions inherited from Definition
	Definition (const char defFileName, int defLine, int defColumn, const char name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual	~Definition ()

const QCString &	name () const

QCString	localName () const

virtual QCString	qualifiedName () const

QCString	symbolName () const

virtual QCString	getSourceFileBase () const

virtual QCString	getSourceAnchor () const

virtual QCString	documentation () const

int	docLine () const

QCString	docFile () const

virtual QCString	briefDescription (bool abbreviate=FALSE) const

QCString	briefDescriptionAsTooltip () const

int	briefLine () const

QCString	inbodyDocumentation () const

QCString	inbodyFile () const

int	inbodyLine () const

QCString	briefFile () const

QCString	getDefFileName () const

QCString	getDefFileExtension () const

int	getDefLine () const

int	getDefColumn () const

virtual bool	hasDocumentation () const

virtual bool	hasUserDocumentation () const

virtual bool	isVisibleInProject () const

virtual bool	isVisible () const

bool	isHidden () const

bool	isArtificial () const

virtual QCString	getReference () const

virtual bool	isReference () const

QCString	externalReference (const QCString &relPath) const

int	getStartBodyLine () const

int	getEndBodyLine () const

FileDef *	getBodyDef () const

SrcLangExt	getLanguage () const

GroupList *	partOfGroups () const

bool	isLinkableViaGroup () const

QList< ListItemInfo > *	xrefListItems () const

virtual Definition *	findInnerCompound (const char *name)

virtual Definition *	getOuterScope () const

MemberSDict *	getReferencesMembers () const

MemberSDict *	getReferencedByMembers () const

bool	hasSections () const

bool	hasSources () const

bool	hasBriefDescription () const

QCString	id () const

virtual void	setName (const char *name)

void	setId (const char *name)

virtual void	setDocumentation (const char d, const char docFile, int docLine, bool stripWhiteSpace=TRUE)

virtual void	setBriefDescription (const char b, const char briefFile, int briefLine)

virtual void	setInbodyDocumentation (const char d, const char docFile, int docLine)

void	setReference (const char *r)

void	addSectionsToDefinition (QList< SectionInfo > *anchorList)

void	setBodySegment (int bls, int ble)

void	setBodyDef (FileDef *fd)

void	addSourceReferencedBy (MemberDef *d)

void	addSourceReferences (MemberDef *d)

void	setRefItems (const QList< ListItemInfo > *sli)

void	mergeRefItems (Definition *d)

virtual void	addInnerCompound (Definition *d)

virtual void	setOuterScope (Definition *d)

virtual void	setHidden (bool b)

void	setArtificial (bool b)

void	setLanguage (SrcLangExt lang)

void	writeSourceDef (OutputList &ol, const char *scopeName)

void	writeInlineCode (OutputList &ol, const char *scopeName)

void	writeSourceRefs (OutputList &ol, const char *scopeName)

void	writeSourceReffedBy (OutputList &ol, const char *scopeName)

void	makePartOfGroup (GroupDef *gd)

void	writeNavigationPath (OutputList &ol) const

QCString	navigationPathAsString () const

QCString	pathFragment () const

void	writeDocAnchorsToTagFile (FTextStream &)

void	setLocalName (const QCString name)

void	addSectionsToIndex ()

void	writeToc (OutputList &ol)

void	setCookie (Cookie *cookie)

Cookie *	cookie () const

Public Member Functions inherited from DefinitionIntf
	DefinitionIntf ()

virtual	~DefinitionIntf ()

Public Attributes
bool	visited

Protected Member Functions
void	addMemberListToGroup (MemberList , bool(MemberDef::)() const)

Protected Member Functions inherited from Definition
	Definition (const Definition &d)

Private Member Functions
MemberList *	createMemberList (MemberListType lt)

void	addMemberToList (MemberListType lt, MemberDef *md)

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

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

void	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	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)

void	updateLanguage (const Definition *)

Private Attributes
QCString	title

bool	titleSet

QCString	fileName

FileList *	fileList

ClassSDict *	classSDict

NamespaceSDict *	namespaceSDict

GroupList *	groupList

PageSDict *	pageDict

PageSDict *	exampleDict

DirList *	dirList

MemberList *	allMemberList

MemberNameInfoSDict *	allMemberNameInfoSDict

Definition *	groupScope

QList< MemberList >	m_memberLists

MemberGroupSDict *	memberGroupSDict

bool	m_subGrouping

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

Detailed Description

A model of a group of symbols.

Definition at line 45 of file groupdef.h.

Constructor & Destructor Documentation

GroupDef::GroupDef	(	const char *	fileName,
		int	line,
		const char *	name,
		const char *	title,
		const char *	refFileName = `0`
	)

Definition at line 46 of file groupdef.cpp.

References allMemberList, allMemberNameInfoSDict, classSDict, Config_getBool, convertNameToFile(), dirList, exampleDict, fileList, fileName, groupList, groupScope, m_subGrouping, memberGroupSDict, MemberListType_allMembersList, namespaceSDict, pageDict, SDict< T >::setAutoDelete(), SIntDict< T >::setAutoDelete(), setGroupTitle(), stripExtension(), and visited.

                                            : Definition(df,dl,1,na)
{
  fileList = new FileList;
  classSDict = new ClassSDict(17);
  groupList = new GroupList;
  namespaceSDict = new NamespaceSDict(17);
  pageDict = new PageSDict(17);
  exampleDict = new PageSDict(17);
  dirList = new DirList;
  allMemberNameInfoSDict = new MemberNameInfoSDict(17);
  allMemberNameInfoSDict->setAutoDelete(TRUE);
  if (refFileName)
  {
    fileName=stripExtension(refFileName);
  }
  else
  {
    fileName = convertNameToFile(QCString("group_")+na);
  }
  setGroupTitle( t );
  memberGroupSDict = new MemberGroupSDict;
  memberGroupSDict->setAutoDelete(TRUE);
  allMemberList = new MemberList(MemberListType_allMembersList);
  visited = 0;
  groupScope = 0;
  m_subGrouping=Config_getBool(SUBGROUPING);
}

GroupDef::~GroupDef ( )

Definition at line 77 of file groupdef.cpp.

References allMemberList, allMemberNameInfoSDict, classSDict, dirList, exampleDict, fileList, groupList, memberGroupSDict, namespaceSDict, and pageDict.

{
  delete fileList;
  delete classSDict;
  delete groupList;
  delete namespaceSDict;
  delete pageDict;
  delete exampleDict;
  delete allMemberList;
  delete allMemberNameInfoSDict;
  delete memberGroupSDict;
  delete dirList;
}

Member Function Documentation

bool GroupDef::addClass ( const ClassDef * def )

Definition at line 149 of file groupdef.cpp.

References SDict< T >::append(), SDict< T >::at(), classSDict, Config_getBool, SDict< T >::count(), SDict< T >::find(), SDict< T >::findAt(), SDict< T >::insertAt(), SDict< T >::inSort(), Definition::isHidden(), Definition::name(), Definition::qualifiedName(), and updateLanguage().

Referenced by addClassToGroups(), createTagLessInstance(), distributeClassGroupRelations(), and ClassDef::setGroupDefForAllMembers().

{
  static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  if (cd->isHidden()) return FALSE;
  updateLanguage(cd);
  QCString qn = cd->name();
  if (classSDict->find(qn)==0)
  {
    //printf("--- addClass %s sort=%d\n",qn.data(),sortBriefDocs);
    if (sortBriefDocs)
    {
      classSDict->inSort(qn,cd);
    }
    else
    {
      int i=qn.findRev("::");
      if (i==-1) i=qn.find('.');
      bool found=FALSE;
      //printf("i=%d\n",i);
      if (i!=-1)
      {
        // add nested classes (e.g. A::B, A::C) after their parent (A) in 
        // order of insertion
        QCString scope = qn.left(i);
        int j=classSDict->findAt(scope);
        if (j!=-1)
        {
          while (j<(int)classSDict->count() && 
              classSDict->at(j)->qualifiedName().left(i)==scope)
          {
            //printf("skipping over %s\n",classSDict->at(j)->qualifiedName().data());
            j++;
          }
          //printf("Found scope at index %d\n",j);
          classSDict->insertAt(j,qn,cd);
          found=TRUE;
        }
      }
      if (!found) // no insertion point found -> just append
      {
        classSDict->append(qn,cd);
      }
    }
    return TRUE;
  }
  return FALSE;
}

void GroupDef::addDir ( const DirDef * dd )

Definition at line 213 of file groupdef.cpp.

References Config_getBool, dirList, and Definition::isHidden().

Referenced by addDirToGroups().

{
  if (def->isHidden()) return;
  if (Config_getBool(SORT_BRIEF_DOCS))
    dirList->inSort(def);  
  else
    dirList->append(def);
}

void GroupDef::addExample ( const PageDef * def )

Definition at line 230 of file groupdef.cpp.

References SDict< T >::append(), exampleDict, Definition::isHidden(), and Definition::name().

Referenced by addExampleToGroups().

{
  if (def->isHidden()) return;
  exampleDict->append(def->name(),def);
}

void GroupDef::addFile ( const FileDef * def )

Definition at line 138 of file groupdef.cpp.

References Config_getBool, fileList, Definition::isHidden(), and updateLanguage().

Referenced by buildFileList().

{
  static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  if (def->isHidden()) return;
  updateLanguage(def);
  if (sortBriefDocs)
    fileList->inSort(def);
  else
    fileList->append(def);
}

void GroupDef::addGroup ( const GroupDef * def )

Definition at line 532 of file groupdef.cpp.

References groupList.

Referenced by addDirsAsGroups(), and addGroupToGroups().

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

void GroupDef::addListReferences ( )

Definition at line 1517 of file groupdef.cpp.

References MemberList::addListReferences(), MemberGroup::addListReferences(), addRefItem(), getOutputFileBase(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), m_memberLists, memberGroupSDict, MemberListType_documentationLists, Definition::name(), theTranslator, Translator::trGroup(), and Definition::xrefListItems().

Referenced by addListReferences().

{
  {
    QList<ListItemInfo> *xrefItems = xrefListItems();
    addRefItem(xrefItems,
             getOutputFileBase(),
             theTranslator->trGroup(TRUE,TRUE),
             getOutputFileBase(),name(),
             0,
             0
            );
  }
  MemberGroupSDict::Iterator mgli(*memberGroupSDict);
  MemberGroup *mg;
  for (;(mg=mgli.current());++mgli)
  {
    mg->addListReferences(this);
  }
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_documentationLists)
    {
      ml->addListReferences(this);
    }
  }
}

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

protected

void GroupDef::addMembersToMemberGroup ( )

Definition at line 237 of file groupdef.cpp.

References SIntDict< MemberGroup >::Iterator, MemberList::listType(), m_memberLists, memberGroupSDict, MemberListType_declarationLists, and MemberGroup::setInGroup().

Referenced by addMembersToMemberGroup().

{
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_declarationLists)
    {
      ::addMembersToMemberGroup(ml,&memberGroupSDict,this);
    }
  }
  //printf("GroupDef::addMembersToMemberGroup() memberGroupList=%d\n",memberGroupList->count());
  MemberGroupSDict::Iterator mgli(*memberGroupSDict);
  MemberGroup *mg;
  for (;(mg=mgli.current());++mgli)
  {
    mg->setInGroup(TRUE);
  }
}

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

private

Definition at line 1565 of file groupdef.cpp.

References MemberList::append(), Config_getBool, createMemberList(), MemberList::listType(), MemberListType_declarationLists, MemberListType_documentationLists, and MemberList::setNeedsSorting().

Referenced by insertMember().

{
  static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  static bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
  MemberList *ml = createMemberList(lt);
  ml->setNeedsSorting(
      ((ml->listType()&MemberListType_declarationLists) && sortBriefDocs) ||
      ((ml->listType()&MemberListType_documentationLists) && sortMemberDocs));
  ml->append(md);
}

bool GroupDef::addNamespace ( const NamespaceDef * def )

Definition at line 197 of file groupdef.cpp.

References SDict< T >::append(), Config_getBool, SDict< T >::find(), SDict< T >::inSort(), Definition::isHidden(), Definition::name(), namespaceSDict, and updateLanguage().

Referenced by addNamespaceToGroups(), and findUsingDirectives().

{
  static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  if (def->isHidden()) return FALSE;
  updateLanguage(def);
  if (namespaceSDict->find(def->name())==0)
  {
    if (sortBriefDocs)
      namespaceSDict->inSort(def->name(),def);  
    else
      namespaceSDict->append(def->name(),def);
    return TRUE;
  }
  return FALSE;
}

void GroupDef::addPage ( PageDef * def )

Definition at line 222 of file groupdef.cpp.

References SDict< T >::append(), Definition::isHidden(), Definition::makePartOfGroup(), Definition::name(), and pageDict.

Referenced by addRelatedPage().

{
  if (def->isHidden()) return;
  //printf("Making page %s part of a group\n",def->name.data());
  pageDict->append(def->name(),def);
  def->makePartOfGroup(this);
}

void GroupDef::addParentGroup ( const GroupDef * def )

QCString GroupDef::anchor ( ) const

inlinevirtual

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

Implements Definition.

Definition at line 52 of file groupdef.h.

Referenced by writeDocumentation().

{ return QCString(); }

void GroupDef::computeAnchors ( )

Compute the HTML anchor names for all members in the group

Definition at line 559 of file groupdef.cpp.

References allMemberList, and setAnchors().

Referenced by computeMemberReferences().

{
  //printf("GroupDef::computeAnchors()\n");
  setAnchors(allMemberList);
}

int GroupDef::countMembers ( ) const

Definition at line 547 of file groupdef.cpp.

References allMemberList, classSDict, MemberList::count(), SDict< T >::count(), exampleDict, fileList, groupList, namespaceSDict, and pageDict.

Referenced by writeDetailedDescription().

{
  return fileList->count()+
         classSDict->count()+
         namespaceSDict->count()+
         groupList->count()+
         allMemberList->count()+
         pageDict->count()+
         exampleDict->count();
}

MemberList * GroupDef::createMemberList ( MemberListType lt )

private

Definition at line 1546 of file groupdef.cpp.

References MemberList::listType(), m_memberLists, and MemberList::setInGroup().

Referenced by addMemberToList().

{
  m_memberLists.setAutoDelete(TRUE);
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()==lt)
    {
      return ml;
    }
  }
  // not found, create a new member list
  ml = new MemberList(lt);
  m_memberLists.append(ml);
  ml->setInGroup(TRUE);
  return ml;
}

DefType GroupDef::definitionType ( ) const

inlinevirtual

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

Implements DefinitionIntf.

Definition at line 50 of file groupdef.h.

References DefinitionIntf::TypeGroup.

{ return TypeGroup; }

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

inlinevirtual

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

Implements Definition.

Definition at line 53 of file groupdef.h.

References hasGroupTitle(), and Definition::name().

{ return hasGroupTitle() ? title : Definition::name(); }

void GroupDef::distributeMemberGroupDocumentation ( )

Definition at line 107 of file groupdef.cpp.

References MemberGroup::distributeMemberGroupDocumentation(), SIntDict< MemberGroup >::Iterator, and memberGroupSDict.

Referenced by distributeMemberGroupDocumentation().

{
  MemberGroupSDict::Iterator mgli(*memberGroupSDict);
  MemberGroup *mg;
  for (;(mg=mgli.current());++mgli)
  {
    mg->distributeMemberGroupDocumentation();
  }
}

void GroupDef::endMemberDeclarations ( OutputList & ol )

private

Definition at line 990 of file groupdef.cpp.

References OutputList::endMemberSections().

Referenced by writeDocumentation().

{
  ol.endMemberSections();
}

void GroupDef::endMemberDocumentation ( OutputList & ol )

private

Definition at line 1006 of file groupdef.cpp.

References Config_getBool, OutputList::popGeneratorState(), and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

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

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

Definition at line 511 of file groupdef.cpp.

References findGroup(), and groupList.

Referenced by addGroupToGroups(), and findGroup().

{
  if (this==def)
  {
    return TRUE;
  }
  else if (groupList)
  {
    GroupListIterator it(*groupList);
    GroupDef *gd;
    for (;(gd=it.current());++it)
    {
      if (gd->findGroup(def))
      {
        return TRUE;
      }
    }
  }
  return FALSE;
}

void GroupDef::findSectionsInDocumentation ( )

Definition at line 117 of file groupdef.cpp.

References Definition::docFile(), docFindSections(), Definition::documentation(), MemberGroup::findSectionsInDocumentation(), MemberList::findSectionsInDocumentation(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), m_memberLists, memberGroupSDict, and MemberListType_declarationLists.

Referenced by findSectionsInDocumentation().

{
  docFindSections(documentation(),this,0,docFile());
  MemberGroupSDict::Iterator mgli(*memberGroupSDict);
  MemberGroup *mg;
  for (;(mg=mgli.current());++mgli)
  {
    mg->findSectionsInDocumentation();
  }
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_declarationLists)
    {
      ml->findSectionsInDocumentation();
    }
  }
}

ClassSDict* GroupDef::getClasses ( ) const

inline

Definition at line 101 of file groupdef.h.

References classSDict.

Referenced by DotGroupCollaboration::buildGraph(), ModuleContext::Private::classes(), generateDocbookForGroup(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), ModuleContext::Private::inlineClasses(), and writeGroupTreeNode().

{ return classSDict; }

DirList* GroupDef::getDirs ( ) const

inline

Definition at line 105 of file groupdef.h.

References dirList.

Referenced by DotGroupCollaboration::buildGraph(), ModuleContext::Private::dirs(), and writeGroupTreeNode().

{ return dirList; }

PageSDict* GroupDef::getExamples ( ) const

inline

Definition at line 106 of file groupdef.h.

References exampleDict.

Referenced by ModuleContext::Private::examples(), and ModuleContext::Private::pages().

{ return exampleDict; }

FileList* GroupDef::getFiles ( ) const

inline

Definition at line 100 of file groupdef.h.

References fileList.

Referenced by DotGroupCollaboration::buildGraph(), ModuleContext::Private::files(), generateDocbookForGroup(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), and writeGroupTreeNode().

{ return fileList; }

Definition* GroupDef::getGroupScope ( ) const

inline

Definition at line 92 of file groupdef.h.

References groupScope.

{ return groupScope; }

MemberGroupSDict* GroupDef::getMemberGroupSDict ( ) const

inline

Definition at line 98 of file groupdef.h.

References memberGroupSDict.

Referenced by generateDocbookForGroup(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), and ModuleContext::Private::memberGroups().

{ return memberGroupSDict; }

MemberList * GroupDef::getMemberList ( MemberListType lt ) const

Definition at line 1586 of file groupdef.cpp.

References MemberList::listType(), and m_memberLists.

Referenced by DotGroupCollaboration::buildGraph(), PerlModGenerator::generatePerlModForGroup(), ModuleContext::Private::getMemberList(), removeMemberFromList(), writeGroupTreeNode(), writeMemberDeclarations(), writeMemberDocumentation(), writeSummaryLinks(), and writeTagFile().

{
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (;(ml=mli.current());++mli)
  {
    if (ml->listType()==lt)
    {
      return ml;
    }
  }
  return 0;
}

const QList<MemberList>& GroupDef::getMemberLists ( ) const

inline

Definition at line 95 of file groupdef.h.

References m_memberLists.

Referenced by generateDocbookForGroup(), generateXMLForGroup(), and writeGroupTreeNode().

{ return m_memberLists; }

NamespaceSDict* GroupDef::getNamespaces ( ) const

inline

Definition at line 102 of file groupdef.h.

References namespaceSDict.

Referenced by DotGroupCollaboration::buildGraph(), ModuleContext::Private::constantgroups(), generateDocbookForGroup(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), ModuleContext::Private::namespaces(), and writeGroupTreeNode().

{ return namespaceSDict; }

QCString GroupDef::getOutputFileBase ( ) const

virtual

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

Implements Definition.

Definition at line 1512 of file groupdef.cpp.

References fileName.

Referenced by addListReferences(), addListReferences(), addRelatedPage(), DotGroupCollaboration::buildGraph(), DotGroupCollaboration::DotGroupCollaboration(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), generateDocbookForGroup(), generateDocbookForMember(), generateXMLForGroup(), generateXMLForMember(), PageDef::getOutputFileBase(), MemberDef::getOutputFileBase(), ModuleContext::Private::groupGraph(), recursivelyAddGroupListToTitle(), resolveUserReferences(), writeDocumentation(), writeGroupTreeNode(), writeInnerGroupFiles(), writeInnerGroups(), MemberDef::writeLink(), writeNestedGroups(), and writeTagFile().

{
  return fileName;
}

PageSDict* GroupDef::getPages ( ) const

inline

Definition at line 104 of file groupdef.h.

References pageDict.

Referenced by DotGroupCollaboration::buildGraph(), generateDocbookForGroup(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), ModuleContext::Private::pages(), and writeGroupTreeNode().

{ return pageDict; }

GroupList* GroupDef::getSubGroups ( ) const

inline

Definition at line 103 of file groupdef.h.

References groupList.

Referenced by NestingNodeContext::Private::addModules(), DotGroupCollaboration::buildGraph(), generateDocbookForGroup(), PerlModGenerator::generatePerlModForGroup(), generateXMLForGroup(), ModuleContext::Private::modules(), and writeGroupTreeNode().

{ return groupList; }

const char* GroupDef::groupTitle ( ) const

inline

bool GroupDef::hasDetailedDescription ( ) const

Definition at line 1653 of file groupdef.cpp.

References Definition::briefDescription(), Config_getBool, and Definition::documentation().

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

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

bool GroupDef::hasGroupTitle ( ) const

inline

Definition at line 56 of file groupdef.h.

References titleSet.

Referenced by buildGroupListFiltered(), and displayName().

{ return titleSet; }

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

Definition at line 259 of file groupdef.cpp.

Referenced by addMemberToGroups(), MemberGroup::insertMember(), and ClassDef::setGroupDefForAllMembers().

{
  if (md->isHidden()) return FALSE;
  updateLanguage(md);
  //printf("GroupDef(%s)::insertMember(%s)\n", title.data(), md->name().data());
  MemberNameInfo *mni=0;
  if ((mni=(*allMemberNameInfoSDict)[md->name()]))
  { // member with this name already found
    MemberNameInfoIterator srcMnii(*mni); 
    MemberInfo *srcMi;
    for ( ; (srcMi=srcMnii.current()) ; ++srcMnii )
    {
      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); 
      ArgumentList *srcMdAl  = srcMd->argumentList();
      ArgumentList *mdAl     = md->argumentList();
      ArgumentList *tSrcMdAl = srcMd->templateArguments();
      ArgumentList *tMdAl    = md->templateArguments();
      
      if (srcMd->isFunction() && md->isFunction() && // both are a function
          ((tSrcMdAl==0 && tMdAl==0) || 
           (tSrcMdAl!=0 && tMdAl!=0 && tSrcMdAl->count()==tMdAl->count())
          ) &&       // 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
         )
      {
        if (srcMd->getGroupAlias()==0) 
        {
          md->setGroupAlias(srcMd); 
        }
        else if (md!=srcMd->getGroupAlias())
        {
          md->setGroupAlias(srcMd->getGroupAlias()); 
        }
        return FALSE; // member is the same as one that is already added
      }
    }
    mni->append(new MemberInfo(md,md->protection(),md->virtualness(),FALSE));
  }
  else
  {
    mni = new MemberNameInfo(md->name());
    mni->append(new MemberInfo(md,md->protection(),md->virtualness(),FALSE));
    allMemberNameInfoSDict->append(mni->memberName(),mni);
  }
  //printf("Added member!\n");
  allMemberList->append(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("GroupDef::insertMembers(): "
           "member `%s' (typeid=%d) with scope `%s' inserted in group scope `%s'!\n",
           md->name().data(),md->memberType(),
           md->getClassDef() ? md->getClassDef()->name().data() : "",
           name().data());
  }
  return TRUE;
}

bool GroupDef::isASubGroup ( ) const

Definition at line 541 of file groupdef.cpp.

References Definition::partOfGroups().

Referenced by NestingContext::Private::addModules(), generateDocbookForGroup(), and writeGroupTreeNode().

{
  GroupList *groups = partOfGroups();
  return groups!=0 && groups->count()!=0;
}

bool GroupDef::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.

Implements Definition.

Definition at line 1638 of file groupdef.cpp.

References Definition::hasUserDocumentation().

Referenced by addMemberToSearchIndex(), createJavascriptSearchIndex(), findMembersWithSpecificName(), getDefs(), isLinkableInProject(), and Definition::isLinkableViaGroup().

{
  return hasUserDocumentation();
}

bool GroupDef::isLinkableInProject ( ) const

virtual

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

Implements Definition.

Definition at line 1633 of file groupdef.cpp.

References isLinkable(), and Definition::isReference().

Referenced by MemberDef::_computeLinkableInProject(), and writeTagFile().

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

void GroupDef::removeMember ( MemberDef * md )

Definition at line 424 of file groupdef.cpp.

Referenced by addMemberToGroups().

{
  // fprintf(stderr, "GroupDef(%s)::removeMember( %s )\n", title.data(), md->name().data());
  MemberNameInfo *mni = allMemberNameInfoSDict->find(md->name());
  if (mni)
  {
    MemberNameInfoIterator mnii(*mni);
    while( mnii.current() )
    {
      if( mnii.current()->memberDef == md )
      {
    mni->remove(mnii.current());
        break;
      }
      ++mnii;
    }
    if( mni->isEmpty() )
    {
      allMemberNameInfoSDict->remove(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("GroupDef::removeMember(): unexpected member remove in file!\n");
    }
  }
}

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

private

Definition at line 1622 of file groupdef.cpp.

References getMemberList(), and MemberList::remove().

Referenced by removeMember().

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

void GroupDef::setGroupScope ( Definition * d )

inline

Definition at line 91 of file groupdef.h.

References groupScope.

Referenced by findGroupScope().

{ groupScope = d; }

void GroupDef::setGroupTitle ( const char * newtitle )

Definition at line 91 of file groupdef.cpp.

References Definition::name(), title, and titleSet.

Referenced by buildGroupListFiltered(), and GroupDef().

{
  if ( t && qstrlen(t) )
  {
    title = t;
    titleSet = TRUE;
  }
  else
  {
    title = name();
    title.at(0)=toupper(title.at(0));
    titleSet = FALSE;
  }
}

void GroupDef::sortMemberLists ( )

Definition at line 1576 of file groupdef.cpp.

References m_memberLists, MemberList::needsSorting(), MemberList::setNeedsSorting(), and MemberList::sort().

Referenced by sortMemberLists().

{
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (;(ml=mli.current());++mli)
  {
    if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
  }
}

void GroupDef::sortSubGroups ( )

Definition at line 1628 of file groupdef.cpp.

References groupList.

Referenced by generateOutput().

{ 
    groupList->sort(); 
}

void GroupDef::startMemberDeclarations ( OutputList & ol )

private

Definition at line 985 of file groupdef.cpp.

References OutputList::startMemberSections().

Referenced by writeDocumentation().

{
  ol.startMemberSections();
}

void GroupDef::startMemberDocumentation ( OutputList & ol )

private

Definition at line 995 of file groupdef.cpp.

References Config_getBool, OutputList::disable(), OutputGenerator::Html, OutputList::pushGeneratorState(), and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

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

bool GroupDef::subGrouping ( ) const

inline

Definition at line 84 of file groupdef.h.

References m_subGrouping.

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

{ return m_subGrouping; }

void GroupDef::updateLanguage ( const Definition * d )

private

Definition at line 1645 of file groupdef.cpp.

References Definition::getLanguage(), Definition::setLanguage(), and SrcLangExt_Unknown.

Referenced by addClass(), addFile(), addNamespace(), and insertMember().

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

void GroupDef::writeAuthorSection ( OutputList & ol )

private

Definition at line 1016 of file groupdef.cpp.

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), and Translator::trGeneratedAutomatically().

Referenced by writeDocumentation().

{
  // 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();
}

void GroupDef::writeBriefDescription ( OutputList & ol )

private

Definition at line 763 of file groupdef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Definition::documentation(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), OutputGenerator::Html, DocRoot::isEmpty(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, Translator::trMore(), validatingParseDoc(), OutputList::writeDoc(), and OutputList::writeString().

Referenced by writeDocumentation().

{
  if (!briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
  {
    DocRoot *rootNode = validatingParseDoc(briefFile(),briefLine(),this,0,
                                briefDescription(),TRUE,FALSE,0,TRUE,FALSE);
    if (rootNode && !rootNode->isEmpty())
    {
      ol.startParagraph();
      ol.writeDoc(rootNode,this,0);
      ol.pushGeneratorState();
      ol.disable(OutputGenerator::RTF);
      ol.writeString(" \n");
      ol.enable(OutputGenerator::RTF);
      if (Config_getBool(REPEAT_BRIEF) ||
          !documentation().isEmpty()
         )
      {
        ol.disableAllBut(OutputGenerator::Html);
        ol.startTextLink(0,"details");
        ol.parseText(theTranslator->trMore());
        ol.endTextLink();
      }
      ol.popGeneratorState();
      ol.endParagraph();
    }
    delete rootNode;
  }
}

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

private

Definition at line 935 of file groupdef.cpp.

References classSDict, and ClassSDict::writeDeclaration().

Referenced by writeDocumentation().

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

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

private

Definition at line 708 of file groupdef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, SDict< T >::count(), countMembers(), OutputList::disable(), OutputList::disableAllBut(), Definition::docFile(), Definition::docLine(), Definition::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::generateDoc(), OutputGenerator::Html, Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), OutputGenerator::Latex, OutputGenerator::Man, pageDict, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startGroupHeader(), OutputList::writeAnchor(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

{
  if ((!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF)) 
      || !documentation().isEmpty() || !inbodyDocumentation().isEmpty()
     )
  {
    if (pageDict->count()!=countMembers()) // not only pages -> classical layout
    {
      ol.pushGeneratorState();
        ol.disable(OutputGenerator::Html);
        ol.writeRuler();
      ol.popGeneratorState();
      ol.pushGeneratorState();
        ol.disableAllBut(OutputGenerator::Html);
        ol.writeAnchor(0,"details");
      ol.popGeneratorState();
      ol.startGroupHeader();
      ol.parseText(title);
      ol.endGroupHeader();
    }
    // repeat brief description
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
    {
      ol.generateDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE);
    }
    // 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);
    }
    // write inbody documentation
    if (!inbodyDocumentation().isEmpty())
    {
      ol.generateDoc(inbodyFile(),inbodyLine(),this,0,inbodyDocumentation()+"\n",TRUE,FALSE);
    }
  }
}

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

private

Definition at line 902 of file groupdef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, dirList, OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::generateDoc(), DirDef::getOutputFileBase(), Definition::getReference(), Definition::hasDocumentation(), OutputList::insertMemberAlign(), OutputList::parseText(), DirDef::shortName(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trDir(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

{
  // write list of directories
  if (dirList->count()>0)
  {
    ol.startMemberHeader("dirs");
    ol.parseText(title);
    ol.endMemberHeader();
    ol.startMemberList();
    QListIterator<DirDef> it(*dirList);
    DirDef *dd;
    for (;(dd=it.current());++it)
    {
      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(),0,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,0,TRUE,FALSE);
        ol.endMemberDescription();
      }
      ol.endMemberDeclaration(0,0);
    }
    ol.endMemberList();
  }
}

void GroupDef::writeDocumentation ( OutputList & ol )

Definition at line 1073 of file groupdef.cpp.

Referenced by generateGroupDocs().

{
  //static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
  startFile(ol,getOutputFileBase(),name(),title,HLI_Modules);
  ol.startHeaderSection();
  writeSummaryLinks(ol);
  ol.startTitleHead(getOutputFileBase());
  ol.pushGeneratorState();
  ol.disable(OutputGenerator::Man);
  ol.parseText(title);
  ol.popGeneratorState();
  addGroupListToTitle(ol,this);
  ol.pushGeneratorState();
  ol.disable(OutputGenerator::Man);
  ol.endTitleHead(getOutputFileBase(),title);
  ol.popGeneratorState();
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Man);
  ol.endTitleHead(getOutputFileBase(),name());
  ol.parseText(title);
  ol.popGeneratorState();
  ol.endHeaderSection();
  ol.startContents();
  if (Doxygen::searchIndex)
  {
    Doxygen::searchIndex->setCurrentDoc(this,anchor(),FALSE);
    static QRegExp we("[a-zA-Z_][-a-zA-Z_0-9]*");
    int i=0,p=0,l=0;
    while ((i=we.match(title,p,&l))!=-1) // foreach word in the title
    {
      Doxygen::searchIndex->addWord(title.mid(i,l),TRUE);
      p=i+l;
    }
  }
  Doxygen::indexList->addIndexItem(this,0,0,title);
  //---------------------------------------- start flexible part -------------------------------
  SrcLangExt lang=getLanguage();
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::Group));
  LayoutDocEntry *lde;
  for (eli.toFirst();(lde=eli.current());++eli)
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc: 
        writeBriefDescription(ol);
        break; 
      case LayoutDocEntry::MemberDeclStart: 
        startMemberDeclarations(ol);
        break; 
      case LayoutDocEntry::GroupClasses: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeClasses(ol,ls->title(lang));
        }
        break; 
      case LayoutDocEntry::GroupInlineClasses: 
        {
          writeInlineClasses(ol);
        }
        break;
      case LayoutDocEntry::GroupNamespaces: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeNamespaces(ol,ls->title(lang));
        }
        break; 
      case LayoutDocEntry::MemberGroups: 
        writeMemberGroups(ol);
        break; 
      case LayoutDocEntry::MemberDecl: 
        {
          LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
          writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
        }
        break; 
      case LayoutDocEntry::MemberDeclEnd: 
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeDetailedDescription(ol,ls->title(lang));
        }
        break;
      case LayoutDocEntry::MemberDefStart: 
        startMemberDocumentation(ol);
        break; 
      case LayoutDocEntry::MemberDef: 
        {
          LayoutDocEntryMemberDef *lmd = (LayoutDocEntryMemberDef*)lde;
          writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
        }
        break;
      case LayoutDocEntry::MemberDefEnd: 
        endMemberDocumentation(ol);
        break;
      case LayoutDocEntry::GroupNestedGroups: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeNestedGroups(ol,ls->title(lang));
        }
        break;
      case LayoutDocEntry::GroupPageDocs: 
        writePageDocumentation(ol);
        break;
      case LayoutDocEntry::GroupDirs: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeDirs(ol,ls->title(lang));
        }
        break;
      case LayoutDocEntry::GroupFiles: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          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::NamespaceInlineClasses:
      case LayoutDocEntry::FileClasses:
      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))
  {
    allMemberList->sort();
    writeMemberPages(ol);
  }
}

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

private

Definition at line 814 of file groupdef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::docify(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), fileList, OutputList::generateDoc(), FileDef::getOutputFileBase(), Definition::getReference(), Definition::hasDocumentation(), OutputList::insertMemberAlign(), FileDef::name(), OutputList::parseText(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trFile(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

{
  // write list of files
  if (fileList->count()>0)
  {
    ol.startMemberHeader("files");
    ol.parseText(title);
    ol.endMemberHeader();
    ol.startMemberList();
    QListIterator<FileDef> it(*fileList);
    FileDef *fd;
    for (;(fd=it.current());++it)
    {
      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(),0,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,0,TRUE,FALSE);
        ol.endMemberDescription();
      }
      ol.endMemberDeclaration(0,0);
    }
    ol.endMemberList();
  }
}

void GroupDef::writeGroupGraph ( OutputList & ol )

private

Definition at line 794 of file groupdef.cpp.

References Config_getBool, OutputList::disable(), OutputList::endGroupCollaboration(), DotGroupCollaboration::isTrivial(), OutputGenerator::Man, msg(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), Definition::qualifiedName(), OutputList::startGroupCollaboration(), theTranslator, title, and Translator::trCollaborationDiagram().

Referenced by writeDocumentation().

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

void GroupDef::writeInlineClasses ( OutputList & ol )

private

Definition at line 941 of file groupdef.cpp.

References classSDict, and ClassSDict::writeDocumentation().

Referenced by writeDocumentation().

{
  classSDict->writeDocumentation(ol);
}

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

private

Definition at line 1600 of file groupdef.cpp.

References Config_getBool, getMemberList(), MemberList::writeDeclarations(), and VhdlDocGen::writeVhdlDeclarations().

Referenced by writeDocumentation().

{
  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,0);
  }
}

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

private

Definition at line 1616 of file groupdef.cpp.

References getMemberList(), Definition::name(), and MemberList::writeDocumentation().

Referenced by writeDocumentation().

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

void GroupDef::writeMemberGroups ( OutputList & ol )

private

Definition at line 969 of file groupdef.cpp.

References SIntDict< MemberGroup >::Iterator, memberGroupSDict, SIntDict< T >::sort(), and MemberGroup::writeDeclarations().

Referenced by writeDocumentation().

{
  /* write user defined member groups */
  if (memberGroupSDict)
  {
    memberGroupSDict->sort();
    /* write user defined member groups */
    MemberGroupSDict::Iterator mgli(*memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->writeDeclarations(ol,0,0,0,this);
    }
  }
}

void GroupDef::writeMemberPages ( OutputList & ol )

Definition at line 1245 of file groupdef.cpp.

References OutputList::disableAllBut(), OutputGenerator::Html, MemberList::listType(), m_memberLists, MemberListType_documentationLists, Definition::name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and MemberList::writeDocumentationPage().

Referenced by writeDocumentation().

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_documentationLists)
    {
       ml->writeDocumentationPage(ol,name(),this);
    }
  }
  ol.popGeneratorState();
}

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

private

Definition at line 846 of file groupdef.cpp.

References namespaceSDict, and NamespaceSDict::writeDeclaration().

Referenced by writeDocumentation().

{
  // write list of namespaces
  namespaceSDict->writeDeclaration(ol,title);
}

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

private

Definition at line 852 of file groupdef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::generateDoc(), getOutputFileBase(), Definition::getReference(), groupList, groupTitle(), Definition::hasDocumentation(), OutputList::insertMemberAlign(), Definition::isVisible(), OutputList::parseText(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

{
  // write list of groups
  int count=0;
  if (groupList->count()>0)
  {
    QListIterator<GroupDef> it(*groupList);
    GroupDef *gd;
    for (;(gd=it.current());++it)
    {
      if (gd->isVisible()) count++;
    }
  }
  if (count>0)
  {
    ol.startMemberHeader("groups");
    ol.parseText(title);
    ol.endMemberHeader();
    ol.startMemberList();
    if (Config_getBool(SORT_GROUP_NAMES))
    {
      groupList->sort();
    }
    QListIterator<GroupDef> it(*groupList);
    GroupDef *gd;
    for (;(gd=it.current());++it)
    {
      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(),0,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,0,TRUE,FALSE);
          ol.endMemberDescription();
        }
        ol.endMemberDeclaration(0,0);
      }
    }
    ol.endMemberList();
  }
}

void GroupDef::writePageDocumentation ( OutputList & ol )

private

Definition at line 946 of file groupdef.cpp.

References Definition::docFile(), OutputList::docify(), Definition::docLine(), Definition::documentation(), OutputList::endSection(), OutputList::endTextBlock(), SDict< T >::find(), OutputList::generateDoc(), Definition::inbodyDocumentation(), Definition::isReference(), SDict< PageDef >::Iterator, SectionInfo::label, Definition::name(), pageDict, Doxygen::sectionDict, OutputList::startSection(), OutputList::startTextBlock(), SectionInfo::Subsection, PageDef::title(), and SectionInfo::title.

Referenced by writeDocumentation().

{
  PageDef *pd=0;
  PageSDict::Iterator pdi(*pageDict);
  for (pdi.toFirst();(pd=pdi.current());++pdi)
  {
    if (!pd->isReference())
    {
      SectionInfo *si=0;
      if (!pd->title().isEmpty() && !pd->name().isEmpty() &&
          (si=Doxygen::sectionDict->find(pd->name()))!=0)
      {
        ol.startSection(si->label,si->title,SectionInfo::Subsection);
        ol.docify(si->title);
        ol.endSection(si->label,SectionInfo::Subsection);
      }
      ol.startTextBlock();
      ol.generateDoc(pd->docFile(),pd->docLine(),pd,0,pd->documentation()+pd->inbodyDocumentation(),TRUE,FALSE,0,TRUE,FALSE);
      ol.endTextBlock();
    }
  }
}

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

virtual

Reimplemented from Definition.

Definition at line 1263 of file groupdef.cpp.

References allMemberList, MemberDef::anchor(), Config_getBool, convertToHtml(), createSubDirs(), MemberDef::getGroupDef(), MemberDef::getOutputFileBase(), Doxygen::htmlFileExtension, MemberDef::isEnumValue(), MemberDef::isLinkable(), MemberDef::isLinkableInProject(), Definition::localName(), and OutputList::writeString().

{
  static bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
  ol.writeString("      <div class=\"navtab\">\n");
  ol.writeString("        <table>\n");
  MemberListIterator mli(*allMemberList);
  MemberDef *md;
  for (mli.toFirst();(md=mli.current());++mli)
  {
    if (md->getGroupDef()==this && md->isLinkable() && !md->isEnumValue())
    {
      ol.writeString("          <tr><td class=\"navtab\">");
      if (md->isLinkableInProject())
      {
        if (md==currentMd) // selected item => highlight
        {
          ol.writeString("<a class=\"qindexHL\" ");
        }
        else
        {
          ol.writeString("<a class=\"qindex\" ");
        }
        ol.writeString("href=\"");
        if (createSubDirs) ol.writeString("../../");
        ol.writeString(md->getOutputFileBase()+Doxygen::htmlFileExtension+"#"+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");
}

void GroupDef::writeSummaryLinks ( OutputList & ol )

privatevirtual

Reimplemented from Definition.

Definition at line 1028 of file groupdef.cpp.

References classSDict, ClassSDict::declVisible(), MemberList::declVisible(), NamespaceSDict::declVisible(), dirList, OutputList::disableAllBut(), fileList, Definition::getLanguage(), getMemberList(), LayoutDocManager::Group, LayoutDocEntry::GroupClasses, LayoutDocEntry::GroupDirs, LayoutDocEntry::GroupFiles, groupList, LayoutDocEntry::GroupNamespaces, LayoutDocEntry::GroupNestedGroups, OutputGenerator::Html, LayoutDocManager::instance(), LayoutDocEntry::kind(), MemberList::listType(), MemberList::listTypeAsString(), LayoutDocEntry::MemberDecl, namespaceSDict, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDecl::type, OutputList::writeString(), and OutputList::writeSummaryLink().

Referenced by writeDocumentation().

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::Group));
  LayoutDocEntry *lde;
  bool first=TRUE;
  SrcLangExt lang = getLanguage();
  for (eli.toFirst();(lde=eli.current());++eli)
  {
    if ((lde->kind()==LayoutDocEntry::GroupClasses && classSDict->declVisible()) || 
        (lde->kind()==LayoutDocEntry::GroupNamespaces && namespaceSDict->declVisible()) ||
        (lde->kind()==LayoutDocEntry::GroupFiles && fileList->count()>0) ||
        (lde->kind()==LayoutDocEntry::GroupNestedGroups && groupList->count()>0) ||
        (lde->kind()==LayoutDocEntry::GroupDirs && dirList->count()>0)
       )
    {
      LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
      QCString label = lde->kind()==LayoutDocEntry::GroupClasses      ? "nested-classes" : 
                       lde->kind()==LayoutDocEntry::GroupNamespaces   ? "namespaces"     :
                       lde->kind()==LayoutDocEntry::GroupFiles        ? "files"          :
                       lde->kind()==LayoutDocEntry::GroupNestedGroups ? "groups"         :
                       "dirs";
      ol.writeSummaryLink(0,label,ls->title(lang),first);
      first=FALSE;
    }
    else if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
      MemberList * ml = getMemberList(lmd->type);
      if (ml && ml->declVisible())
      {
        ol.writeSummaryLink(0,MemberList::listTypeAsString(ml->listType()),lmd->title(lang),first);
        first=FALSE;
      }
    }
  }
  if (!first)
  {
    ol.writeString("  </div>\n");
  }
  ol.popGeneratorState();
}

void GroupDef::writeTagFile ( FTextStream & tagFile )

Definition at line 565 of file groupdef.cpp.

References classSDict, ClassDef::compoundTypeString(), convertToXML(), dirList, DirDef::displayName(), endl(), fileList, getMemberList(), getOutputFileBase(), PageDef::getOutputFileBase(), LayoutDocManager::Group, LayoutDocEntry::GroupClasses, LayoutDocEntry::GroupDirs, LayoutDocEntry::GroupFiles, groupList, LayoutDocEntry::GroupNamespaces, LayoutDocEntry::GroupNestedGroups, LayoutDocEntry::GroupPageDocs, Doxygen::htmlFileExtension, LayoutDocManager::instance(), PageDef::isLinkableInProject(), DirDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), FileDef::isLinkableInProject(), ClassDef::isLinkableInProject(), Definition::isVisible(), SDict< PageDef >::Iterator, SIntDict< MemberGroup >::Iterator, LayoutDocEntry::kind(), LayoutDocEntry::MemberDecl, LayoutDocEntry::MemberGroups, memberGroupSDict, FileDef::name(), Definition::name(), namespaceSDict, pageDict, title, LayoutDocEntryMemberDecl::type, Definition::writeDocAnchorsToTagFile(), MemberGroup::writeTagFile(), and MemberList::writeTagFile().

Referenced by writeTagFile().

{
  tagFile << "  <compound kind=\"group\">" << endl;
  tagFile << "    <name>" << convertToXML(name()) << "</name>" << endl;
  tagFile << "    <title>" << convertToXML(title) << "</title>" << endl;
  tagFile << "    <filename>" << convertToXML(getOutputFileBase()) << Doxygen::htmlFileExtension << "</filename>" << endl;
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::Group));
  LayoutDocEntry *lde;
  for (eli.toFirst();(lde=eli.current());++eli)
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::GroupClasses:
        {
          if (classSDict)
          {
            SDict<ClassDef>::Iterator ci(*classSDict);
            ClassDef *cd;
            for (ci.toFirst();(cd=ci.current());++ci)
            {
              if (cd->isLinkableInProject())
              {
                tagFile << "    <class kind=\"" << cd->compoundTypeString()
                        << "\">" << convertToXML(cd->name()) << "</class>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::GroupNamespaces:
        {
          if (namespaceSDict)
          {
            SDict<NamespaceDef>::Iterator ni(*namespaceSDict);
            NamespaceDef *nd;
            for (ni.toFirst();(nd=ni.current());++ni)
            {
              if (nd->isLinkableInProject())
              {
                tagFile << "    <namespace>" << convertToXML(nd->name())
                        << "</namespace>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::GroupFiles:
        {
          if (fileList)
          {
            QListIterator<FileDef> it(*fileList);
            FileDef *fd;
            for (;(fd=it.current());++it)
            {
              if (fd->isLinkableInProject())
              {
                tagFile << "    <file>" << convertToXML(fd->name()) << "</file>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::GroupPageDocs:
        {
          if (pageDict)
          {
            PageSDict::Iterator pdi(*pageDict);
            PageDef *pd=0;
            for (pdi.toFirst();(pd=pdi.current());++pdi)
            {
              QCString pageName = pd->getOutputFileBase();
              if (pd->isLinkableInProject())
              {
                tagFile << "    <page>" << convertToXML(pageName) << "</page>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::GroupDirs:
        {
          if (dirList)
          {
            QListIterator<DirDef> it(*dirList);
            DirDef *dd;
            for (;(dd=it.current());++it)
            {
              if (dd->isLinkableInProject())
              {
                tagFile << "    <dir>" << convertToXML(dd->displayName()) << "</dir>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::GroupNestedGroups:
        {
          if (groupList)
          {
            QListIterator<GroupDef> it(*groupList);
            GroupDef *gd;
            for (;(gd=it.current());++it)
            {
              if (gd->isVisible())
              {
                tagFile << "    <subgroup>" << convertToXML(gd->name()) << "</subgroup>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::MemberDecl:
        {
          LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
          MemberList * ml = getMemberList(lmd->type);
          if (ml)
          {
            ml->writeTagFile(tagFile);
          }
        }
        break;
      case LayoutDocEntry::MemberGroups:
        {
          if (memberGroupSDict)
          {
            MemberGroupSDict::Iterator mgli(*memberGroupSDict);
            MemberGroup *mg;
            for (;(mg=mgli.current());++mgli)
            {
              mg->writeTagFile(tagFile);
            }
          }
        }
        break;
      default:
        break;
    }
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>" << endl;
}