GroupDefImpl Class Reference

Inheritance diagram for GroupDefImpl:

Collaboration diagram for GroupDefImpl:

Public Member Functions
	GroupDefImpl (const QCString &fileName, int line, const QCString &name, const QCString &title, const QCString &refFileName=QCString())
	~GroupDefImpl () override
DefType	definitionType () const override
CodeSymbolType	codeSymbolType () const override
QCString	getOutputFileBase () const override
QCString	anchor () const override
QCString	displayName (bool=TRUE) const override
QCString	groupTitle () const override
void	setGroupTitle (const QCString &newtitle) override
bool	hasGroupTitle () const override
void	addFile (FileDef *def) override
bool	containsFile (const FileDef *def) const override
bool	addClass (ClassDef *def) override
bool	addConcept (ConceptDef *def) override
bool	addModule (ModuleDef *def) override
bool	addNamespace (NamespaceDef *def) override
void	addGroup (GroupDef *def) override
void	addPage (PageDef *def) override
void	addExample (PageDef *def) override
void	addDir (DirDef *dd) override
bool	insertMember (MemberDef *def, bool docOnly=FALSE) override
void	removeMember (MemberDef *md) override
bool	findGroup (const GroupDef *def) const override
void	writeDocumentation (OutputList &ol) override
void	writeMemberPages (OutputList &ol, int hierarchyLevel) override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const override
void	writeTagFile (TextStream &) override
size_t	numDocMembers () const override
bool	isLinkableInProject () const override
bool	isLinkable () const override
bool	isVisibleInHierarchy () const override
bool	isASubGroup () const override
void	computeAnchors () override
void	countMembers () override
void	addMembersToMemberGroup () override
void	distributeMemberGroupDocumentation () override
void	findSectionsInDocumentation () override
void	addListReferences () override
void	sortMemberLists () override
bool	subGrouping () const override
void	setGroupScope (Definition *d) override
Definition *	getGroupScope () const override
MemberList *	getMemberList (MemberListType lt) const override
const MemberLists &	getMemberLists () const override
const MemberGroupList &	getMemberGroups () const override
const FileList &	getFiles () const override
const ClassLinkedRefMap &	getClasses () const override
const ConceptLinkedRefMap &	getConcepts () const override
const ModuleLinkedRefMap &	getModules () const override
const NamespaceLinkedRefMap &	getNamespaces () const override
const GroupList &	getSubGroups () const override
const PageLinkedRefMap &	getPages () const override
const DirList &	getDirs () const override
const PageLinkedRefMap &	getExamples () const override
bool	hasDetailedDescription () const override
void	sortSubGroups () override
void	writeSummaryLinks (OutputList &ol) const override
void	writePageNavigation (OutputList &ol) const override
bool	hasGroupGraph () const override
void	overrideGroupGraph (bool e) override
Public Member Functions inherited from DefinitionMixin< GroupDef >
	DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
DefinitionMixin &	operator= (const DefinitionMixin &other)
	~DefinitionMixin () override=default
bool	isAlias () const override
const QCString &	name () const override
bool	isAnonymous () const override
const QCString &	localName () const override
QCString	qualifiedName () const override
QCString	symbolName () const override
QCString	getSourceFileBase () const override
QCString	getSourceAnchor () const override
QCString	documentation () const override
int	docLine () const override
QCString	docFile () const override
QCString	briefDescription (bool abbreviate=FALSE) const override
QCString	briefDescriptionAsTooltip () const override
int	briefLine () const override
QCString	inbodyDocumentation () const override
QCString	inbodyFile () const override
int	inbodyLine () const override
QCString	briefFile () const override
QCString	getDefFileName () const override
QCString	getDefFileExtension () const override
int	getDefLine () const override
int	getDefColumn () const override
bool	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
QCString	getReference () const override
bool	isReference () const override
QCString	externalReference (const QCString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const Definition *	findInnerCompound (const QCString &name) const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
QCString	id () const override
const SectionRefs &	getSectionRefs () const override
void	setName (const QCString &name) override
void	setId (const QCString &name) override
void	setDefFile (const QCString &df, int defLine, int defColumn) override
void	setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
void	setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override
void	setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override
void	setReference (const QCString &r) override
void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
void	setBodySegment (int defLine, int bls, int ble) override
void	setBodyDef (const FileDef *fd) override
void	addSourceReferencedBy (MemberDef *md, const QCString &sourceRefName) override
void	addSourceReferences (MemberDef *md, const QCString &sourceRefName) override
void	setRefItems (const RefItemVector &sli) override
void	mergeRefItems (Definition *def) override
void	mergeReferences (const Definition *other) override
void	mergeReferencedBy (const Definition *other) override
void	addInnerCompound (Definition *def) override
void	setOuterScope (Definition *def) override
void	setHidden (bool b) override
void	setArtificial (bool b) override
void	setExported (bool b) override
void	setLanguage (SrcLangExt lang) override
void	writeSourceDef (OutputList &ol) const override
void	writeInlineCode (OutputList &ol, const QCString &scopeName) const override
bool	hasSourceRefs () const override
bool	hasSourceReffedBy () const override
void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const override
void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override
void	makePartOfGroup (GroupDef *gd) override
void	writeNavigationPath (OutputList &ol) const override
QCString	navigationPathAsString () const override
QCString	pathFragment () const override
void	writeDocAnchorsToTagFile (TextStream &fs) const override
void	setLocalName (const QCString &name) override
void	writeToc (OutputList &ol, const LocalToc &lt) const override
void	computeTooltip () override
void	_setSymbolName (const QCString &name) override
QCString	_symbolName () const override

Private Member Functions
void	addMemberListToGroup (MemberList *, bool(MemberDef::*)() const)
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	writeConcepts (OutputList &ol, const QCString &title)
void	writeModules (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	updateLanguage (const Definition *)
void	setGroupTitleLocal (const QCString &title)

Private Attributes
QCString	m_title
bool	m_titleSet
QCString	m_fileName
FileList	m_fileList
ClassLinkedRefMap	m_classes
ConceptLinkedRefMap	m_concepts
ModuleLinkedRefMap	m_modules
NamespaceLinkedRefMap	m_namespaces
GroupList	m_groups
PageLinkedRefMap	m_pages
PageLinkedRefMap	m_examples
DirList	m_dirList
MemberList	m_allMemberList
MemberNameInfoLinkedMap	m_allMemberNameInfoLinkedMap
Definition *	m_groupScope
MemberLists	m_memberLists
MemberGroupList	m_memberGroups
bool	m_subGrouping
bool	m_hasGroupGraph = false

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

Detailed Description

Definition at line 53 of file groupdef.cpp.

Constructor & Destructor Documentation

GroupDefImpl()

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

Definition at line 184 of file groupdef.cpp.

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

References Config_getBool, DefinitionMixin< GroupDef >::DefinitionMixin(), QCString::isEmpty(), m_allMemberList, m_groupScope, m_hasGroupGraph, m_subGrouping, and setGroupTitleLocal().

~GroupDefImpl()

GroupDefImpl::~GroupDefImpl ( )

override

Definition at line 204 of file groupdef.cpp.

{
}

Member Function Documentation

addClass()

bool GroupDefImpl::addClass ( ClassDef * def )

overridevirtual

Implements GroupDef.

Definition at line 276 of file groupdef.cpp.

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

References FALSE, Definition::isHidden(), m_classes, Definition::name(), TRUE, and updateLanguage().

addConcept()

bool GroupDefImpl::addConcept ( ConceptDef * def )

overridevirtual

Implements GroupDef.

Definition at line 289 of file groupdef.cpp.

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

References FALSE, Definition::isHidden(), m_concepts, Definition::name(), and TRUE.

addDir()

void GroupDefImpl::addDir ( DirDef * dd )

overridevirtual

Implements GroupDef.

Definition at line 326 of file groupdef.cpp.

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

References Definition::isHidden(), and m_dirList.

addExample()

void GroupDefImpl::addExample ( PageDef * def )

overridevirtual

Implements GroupDef.

Definition at line 340 of file groupdef.cpp.

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

References Definition::isHidden(), m_examples, and Definition::name().

addFile()

void GroupDefImpl::addFile ( FileDef * def )

overridevirtual

Implements GroupDef.

Definition at line 257 of file groupdef.cpp.

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

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

addGroup()

void GroupDefImpl::addGroup ( GroupDef * def )

overridevirtual

Implements GroupDef.

Definition at line 602 of file groupdef.cpp.

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

References m_groups.

addListReferences()

void GroupDefImpl::addListReferences ( )

overridevirtual

Implements GroupDef.

Definition at line 1806 of file groupdef.cpp.

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

References addRefItem(), getOutputFileBase(), m_memberGroups, m_memberLists, DefinitionMixin< GroupDef >::name(), theTranslator, TRUE, and DefinitionMixin< GroupDef >::xrefListItems().

addMemberListToGroup()

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

private

addMembersToMemberGroup()

void GroupDefImpl::addMembersToMemberGroup ( )

overridevirtual

Implements GroupDef.

Definition at line 347 of file groupdef.cpp.

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

References addMembersToMemberGroup(), m_memberGroups, and m_memberLists.

Referenced by addMembersToMemberGroup().

addMemberToList()

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

private

Definition at line 1831 of file groupdef.cpp.

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

References Config_getBool, Group, and m_memberLists.

Referenced by insertMember().

addModule()

bool GroupDefImpl::addModule ( ModuleDef * def )

overridevirtual

Implements GroupDef.

Definition at line 301 of file groupdef.cpp.

{
  if (mod->isHidden()) return false;
  QCString qn = mod->name();
  if (m_modules.find(qn)==nullptr)
  {
    m_modules.add(qn,mod);
    return true;
  }
  return false;
}

References Definition::isHidden(), m_modules, and Definition::name().

addNamespace()

bool GroupDefImpl::addNamespace ( NamespaceDef * def )

overridevirtual

Implements GroupDef.

Definition at line 313 of file groupdef.cpp.

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

References Definition::isHidden(), m_namespaces, Definition::name(), and updateLanguage().

addPage()

void GroupDefImpl::addPage ( PageDef * def )

overridevirtual

Implements GroupDef.

Definition at line 332 of file groupdef.cpp.

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

References Definition::isHidden(), m_pages, DefinitionMutable::makePartOfGroup(), and Definition::name().

anchor()

QCString GroupDefImpl::anchor ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 63 of file groupdef.cpp.

{ return QCString(); }

codeSymbolType()

CodeSymbolType GroupDefImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 61 of file groupdef.cpp.

{ return CodeSymbolType::Default; }

References Default.

computeAnchors()

void GroupDefImpl::computeAnchors ( )

overridevirtual

Compute the HTML anchor names for all members in the group

Implements GroupDef.

Definition at line 642 of file groupdef.cpp.

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

References m_allMemberList.

containsFile()

bool GroupDefImpl::containsFile ( const FileDef * def ) const

overridevirtual

Implements GroupDef.

Definition at line 271 of file groupdef.cpp.

{
  return std::find(m_fileList.cbegin(),m_fileList.cend(), def) != m_fileList.cend();
}

References m_fileList.

countMembers()

void GroupDefImpl::countMembers ( )

overridevirtual

Implements GroupDef.

Definition at line 616 of file groupdef.cpp.

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

References m_memberGroups, and m_memberLists.

definitionType()

DefType GroupDefImpl::definitionType ( ) const

inlineoverridevirtual

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

Implements Definition.

Definition at line 60 of file groupdef.cpp.

{ return TypeGroup; }

References definitionType(), and Definition::TypeGroup.

Referenced by definitionType(), and insertMember().

displayName()

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

inlineoverridevirtual

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

Implements Definition.

Definition at line 64 of file groupdef.cpp.

{ return hasGroupTitle() ? m_title : DefinitionMixin::name(); }

References hasGroupTitle(), m_title, DefinitionMixin< Base >::name(), and TRUE.

distributeMemberGroupDocumentation()

void GroupDefImpl::distributeMemberGroupDocumentation ( )

overridevirtual

Implements GroupDef.

Definition at line 229 of file groupdef.cpp.

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

References m_memberGroups.

endMemberDeclarations()

void GroupDefImpl::endMemberDeclarations ( OutputList & ol )

private

Definition at line 1128 of file groupdef.cpp.

{
  ol.endMemberSections();
}

References OutputList::endMemberSections().

Referenced by writeDocumentation().

endMemberDocumentation()

void GroupDefImpl::endMemberDocumentation ( OutputList & ol )

private

Definition at line 1144 of file groupdef.cpp.

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

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

Referenced by writeDocumentation().

findGroup()

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

overridevirtual

Implements GroupDef.

Definition at line 586 of file groupdef.cpp.

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

References FALSE, m_groups, and TRUE.

findSectionsInDocumentation()

void GroupDefImpl::findSectionsInDocumentation ( )

overridevirtual

Implements GroupDef.

Definition at line 237 of file groupdef.cpp.

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

References DefinitionMixin< GroupDef >::briefDescription(), DefinitionMixin< GroupDef >::docFile(), docFindSections(), DefinitionMixin< GroupDef >::documentation(), DefinitionMixin< GroupDef >::inbodyDocumentation(), m_memberGroups, and m_memberLists.

getClasses()

const ClassLinkedRefMap & GroupDefImpl::getClasses ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 111 of file groupdef.cpp.

{ return m_classes; }

References m_classes.

getConcepts()

const ConceptLinkedRefMap & GroupDefImpl::getConcepts ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 112 of file groupdef.cpp.

{ return m_concepts; }

References m_concepts.

getDirs()

const DirList & GroupDefImpl::getDirs ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 117 of file groupdef.cpp.

{ return m_dirList; }

References m_dirList.

getExamples()

const PageLinkedRefMap & GroupDefImpl::getExamples ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 118 of file groupdef.cpp.

{ return m_examples; }

References m_examples.

getFiles()

const FileList & GroupDefImpl::getFiles ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 110 of file groupdef.cpp.

{ return m_fileList; }

References m_fileList.

getGroupScope()

Definition * GroupDefImpl::getGroupScope ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 102 of file groupdef.cpp.

{ return m_groupScope; }

References m_groupScope.

getMemberGroups()

const MemberGroupList & GroupDefImpl::getMemberGroups ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 108 of file groupdef.cpp.

{ return m_memberGroups; }

References m_memberGroups.

getMemberList()

MemberList * GroupDefImpl::getMemberList ( MemberListType lt ) const

overridevirtual

Implements GroupDef.

Definition at line 1952 of file groupdef.cpp.

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

References m_memberLists.

Referenced by removeMemberFromList(), writeMemberDeclarations(), writeMemberDocumentation(), writeSummaryLinks(), and writeTagFile().

getMemberLists()

const MemberLists & GroupDefImpl::getMemberLists ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 105 of file groupdef.cpp.

{ return m_memberLists; }

References m_memberLists.

getModules()

const ModuleLinkedRefMap & GroupDefImpl::getModules ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 113 of file groupdef.cpp.

{ return m_modules; }

References m_modules.

getNamespaces()

const NamespaceLinkedRefMap & GroupDefImpl::getNamespaces ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 114 of file groupdef.cpp.

{ return m_namespaces; }

References m_namespaces.

getOutputFileBase()

QCString GroupDefImpl::getOutputFileBase ( ) const

overridevirtual

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

Implements Definition.

Definition at line 1801 of file groupdef.cpp.

{
  return m_fileName;
}

References m_fileName.

Referenced by addListReferences(), writeDocumentation(), and writeTagFile().

getPages()

const PageLinkedRefMap & GroupDefImpl::getPages ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 116 of file groupdef.cpp.

{ return m_pages; }

References m_pages.

getSubGroups()

const GroupList & GroupDefImpl::getSubGroups ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 115 of file groupdef.cpp.

{ return m_groups; }

References m_groups.

Referenced by writeDocumentation().

groupTitle()

QCString GroupDefImpl::groupTitle ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 65 of file groupdef.cpp.

{ return m_title; }

References m_title.

hasDetailedDescription()

bool GroupDefImpl::hasDetailedDescription ( ) const

overridevirtual

Implements GroupDef.

Definition at line 2052 of file groupdef.cpp.

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

References DefinitionMixin< GroupDef >::briefDescription(), Config_getBool, DefinitionMixin< GroupDef >::documentation(), DefinitionMixin< GroupDef >::inbodyDocumentation(), m_pages, and numDocMembers().

Referenced by writeBriefDescription().

hasGroupGraph()

bool GroupDefImpl::hasGroupGraph ( ) const

overridevirtual

Implements GroupDef.

Definition at line 2066 of file groupdef.cpp.

{
  return m_hasGroupGraph;
}

References m_hasGroupGraph.

hasGroupTitle()

bool GroupDefImpl::hasGroupTitle ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 67 of file groupdef.cpp.

{ return m_titleSet; }

References m_titleSet.

Referenced by displayName().

insertMember()

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

overridevirtual

Implements GroupDef.

Definition at line 359 of file groupdef.cpp.

{
  if (md->isHidden()) return FALSE;
  updateLanguage(md);
  //printf("GroupDef(%s)::insertMember(%s)\n", qPrint(title), qPrint(md->name()));
  MemberNameInfo *mni = m_allMemberNameInfoLinkedMap.add(md->name());
  for (auto &srcMi : *mni)
  {
    const MemberDef *srcMd = srcMi->memberDef();
    if (srcMd==md) return FALSE; // already added before!
 
    bool sameScope = srcMd->getOuterScope()==md->getOuterScope() || // same class or namespace
        // both inside a file => definition and declaration do not have to be in the same file
         (srcMd->getOuterScope()->definitionType()==Definition::TypeFile &&
             md->getOuterScope()->definitionType()==Definition::TypeFile);
 
    const ArgumentList &srcMdAl  = srcMd->argumentList();
    const ArgumentList &mdAl     = md->argumentList();
    const ArgumentList &tSrcMdAl = srcMd->templateArguments();
    const ArgumentList &tMdAl    = md->templateArguments();
 
    if (srcMd->isFunction() && md->isFunction() && // both are a function
        (tSrcMdAl.size()==tMdAl.size()) &&       // same number of template arguments
        matchArguments2(srcMd->getOuterScope(),srcMd->getFileDef(),srcMd->typeString(),&srcMdAl,
                           md->getOuterScope(),   md->getFileDef(),   md->typeString(),&mdAl,
                           TRUE,srcMd->getLanguage()
                       ) && // matching parameters
        sameScope // both are found in the same scope
       )
    {
      MemberDefMutable *mdm = toMemberDefMutable(md);
      if (mdm && srcMd->getGroupAlias()==nullptr)
      {
        mdm->setGroupAlias(srcMd);
      }
      else if (mdm && md!=srcMd->getGroupAlias())
      {
        mdm->setGroupAlias(srcMd->getGroupAlias());
      }
      return FALSE; // member is the same as one that is already added
    }
  }
  mni->push_back(std::make_unique<MemberInfo>(md,md->protection(),md->virtualness(),false,false));
  //printf("Added member!\n");
  m_allMemberList.push_back(md);
  switch(md->memberType())
  {
    case MemberType::Variable:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecVarMembers(),md);
      }
      addMemberToList(MemberListType::DocVarMembers(),md);
      break;
    case MemberType::Function:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecFuncMembers(),md);
      }
      addMemberToList(MemberListType::DocFuncMembers(),md);
      break;
    case MemberType::Typedef:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecTypedefMembers(),md);
      }
      addMemberToList(MemberListType::DocTypedefMembers(),md);
      break;
    case MemberType::Enumeration:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecEnumMembers(),md);
      }
      addMemberToList(MemberListType::DocEnumMembers(),md);
      break;
    case MemberType::EnumValue:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecEnumValMembers(),md);
      }
      addMemberToList(MemberListType::DocEnumValMembers(),md);
      break;
    case MemberType::Define:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecDefineMembers(),md);
      }
      addMemberToList(MemberListType::DocDefineMembers(),md);
      break;
    case MemberType::Signal:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecSignalMembers(),md);
      }
      addMemberToList(MemberListType::DocSignalMembers(),md);
      break;
    case MemberType::Slot:
      if (md->protection()==Protection::Public)
      {
        if (!docOnly)
        {
          addMemberToList(MemberListType::DecPubSlotMembers(),md);
        }
        addMemberToList(MemberListType::DocPubSlotMembers(),md);
      }
      else if (md->protection()==Protection::Protected)
      {
        if (!docOnly)
        {
          addMemberToList(MemberListType::DecProSlotMembers(),md);
        }
        addMemberToList(MemberListType::DocProSlotMembers(),md);
      }
      else
      {
        if (!docOnly)
        {
          addMemberToList(MemberListType::DecPriSlotMembers(),md);
        }
        addMemberToList(MemberListType::DocPriSlotMembers(),md);
      }
      break;
    case MemberType::Event:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecEventMembers(),md);
      }
      addMemberToList(MemberListType::DocEventMembers(),md);
      break;
    case MemberType::Property:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecPropMembers(),md);
      }
      addMemberToList(MemberListType::DocPropMembers(),md);
      break;
    case MemberType::Friend:
      if (!docOnly)
      {
        addMemberToList(MemberListType::DecFriendMembers(),md);
      }
      addMemberToList(MemberListType::DocFriendMembers(),md);
      break;
    default:
      err("GroupDefImpl::insertMembers(): "
           "member '{}' (typeid='{}') with scope '{}' inserted in group scope '{}'!\n",
           md->name(),md->memberTypeName(),
           md->getClassDef() ? md->getClassDef()->name() : "",
           name());
  }
  return TRUE;
}

References addMemberToList(), MemberDef::argumentList(), Define, Definition::definitionType(), definitionType(), Enumeration, EnumValue, err, Event, FALSE, Friend, Function, MemberDef::getClassDef(), MemberDef::getFileDef(), MemberDef::getGroupAlias(), Definition::getLanguage(), Definition::getOuterScope(), MemberDef::isFunction(), Definition::isHidden(), m_allMemberList, m_allMemberNameInfoLinkedMap, matchArguments2(), MemberDef::memberType(), MemberDef::memberTypeName(), Definition::name(), DefinitionMixin< GroupDef >::name(), Property, MemberDef::protection(), MemberNameInfo::push_back(), MemberDefMutable::setGroupAlias(), Signal, ArgumentList::size(), Slot, MemberDef::templateArguments(), toMemberDefMutable(), TRUE, Typedef, Definition::TypeFile, MemberDef::typeString(), updateLanguage(), Variable, and MemberDef::virtualness().

isASubGroup()

bool GroupDefImpl::isASubGroup ( ) const

overridevirtual

Implements GroupDef.

Definition at line 611 of file groupdef.cpp.

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

References DefinitionMixin< GroupDef >::partOfGroups().

isLinkable()

bool GroupDefImpl::isLinkable ( ) const

overridevirtual

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 2037 of file groupdef.cpp.

{
  return hasUserDocumentation();
}

References DefinitionMixin< GroupDef >::hasUserDocumentation().

Referenced by isLinkableInProject(), and isVisibleInHierarchy().

isLinkableInProject()

bool GroupDefImpl::isLinkableInProject ( ) const

overridevirtual

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

Implements Definition.

Definition at line 2032 of file groupdef.cpp.

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

References isLinkable(), and DefinitionMixin< GroupDef >::isReference().

isVisibleInHierarchy()

bool GroupDefImpl::isVisibleInHierarchy ( ) const

overridevirtual

Implements GroupDef.

Definition at line 2026 of file groupdef.cpp.

{
  bool allExternals = Config_getBool(EXTERNAL_GROUPS);
  return (allExternals || hasNonReferenceNestedGroupRec(this,0)) && isLinkable();
}

References Config_getBool, hasNonReferenceNestedGroupRec(), and isLinkable().

numDocMembers()

size_t GroupDefImpl::numDocMembers ( ) const

overridevirtual

Implements GroupDef.

Definition at line 630 of file groupdef.cpp.

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

References m_allMemberList, m_classes, m_examples, m_fileList, m_groups, m_namespaces, and m_pages.

Referenced by hasDetailedDescription(), and writeDetailedDescription().

overrideGroupGraph()

void GroupDefImpl::overrideGroupGraph ( bool e )

overridevirtual

Implements GroupDef.

Definition at line 2061 of file groupdef.cpp.

{
  m_hasGroupGraph=e;
}

References m_hasGroupGraph.

removeMember()

void GroupDefImpl::removeMember ( MemberDef * md )

overridevirtual

Implements GroupDef.

Definition at line 512 of file groupdef.cpp.

{
  // fprintf(stderr, "GroupDef(%s)::removeMember( %s )\n", qPrint(title), qPrint(md->name()));
  MemberNameInfo *mni = m_allMemberNameInfoLinkedMap.find(md->name());
  if (mni)
  {
    m_allMemberNameInfoLinkedMap.del(md->name());
 
    removeMemberFromList(MemberListType::AllMembersList(),md);
    switch(md->memberType())
    {
      case MemberType::Variable:
        removeMemberFromList(MemberListType::DecVarMembers(),md);
        removeMemberFromList(MemberListType::DocVarMembers(),md);
        break;
      case MemberType::Function:
        removeMemberFromList(MemberListType::DecFuncMembers(),md);
        removeMemberFromList(MemberListType::DocFuncMembers(),md);
        break;
      case MemberType::Typedef:
        removeMemberFromList(MemberListType::DecTypedefMembers(),md);
        removeMemberFromList(MemberListType::DocTypedefMembers(),md);
        break;
      case MemberType::Enumeration:
        removeMemberFromList(MemberListType::DecEnumMembers(),md);
        removeMemberFromList(MemberListType::DocEnumMembers(),md);
        break;
      case MemberType::EnumValue:
        removeMemberFromList(MemberListType::DecEnumValMembers(),md);
        removeMemberFromList(MemberListType::DocEnumValMembers(),md);
        break;
      case MemberType::Define:
        removeMemberFromList(MemberListType::DecDefineMembers(),md);
        removeMemberFromList(MemberListType::DocDefineMembers(),md);
        break;
      case MemberType::Signal:
        removeMemberFromList(MemberListType::DecSignalMembers(),md);
        removeMemberFromList(MemberListType::DocSignalMembers(),md);
        break;
      case MemberType::Slot:
        if (md->protection()==Protection::Public)
        {
          removeMemberFromList(MemberListType::DecPubSlotMembers(),md);
          removeMemberFromList(MemberListType::DocPubSlotMembers(),md);
        }
        else if (md->protection()==Protection::Protected)
        {
          removeMemberFromList(MemberListType::DecProSlotMembers(),md);
          removeMemberFromList(MemberListType::DocProSlotMembers(),md);
        }
        else
        {
          removeMemberFromList(MemberListType::DecPriSlotMembers(),md);
          removeMemberFromList(MemberListType::DocPriSlotMembers(),md);
        }
        break;
      case MemberType::Event:
        removeMemberFromList(MemberListType::DecEventMembers(),md);
        removeMemberFromList(MemberListType::DocEventMembers(),md);
        break;
      case MemberType::Property:
        removeMemberFromList(MemberListType::DecPropMembers(),md);
        removeMemberFromList(MemberListType::DocPropMembers(),md);
        break;
      case MemberType::Friend:
        removeMemberFromList(MemberListType::DecFriendMembers(),md);
        removeMemberFromList(MemberListType::DocFriendMembers(),md);
        break;
      default:
        err("GroupDefImpl::removeMember(): unexpected member remove in file!\n");
    }
  }
}

References Define, Enumeration, EnumValue, err, Event, Friend, Function, m_allMemberNameInfoLinkedMap, MemberDef::memberType(), Definition::name(), Property, MemberDef::protection(), removeMemberFromList(), Signal, Slot, Typedef, and Variable.

removeMemberFromList()

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

private

Definition at line 1986 of file groupdef.cpp.

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

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

Referenced by removeMember().

setGroupScope()

void GroupDefImpl::setGroupScope ( Definition * d )

inlineoverridevirtual

Implements GroupDef.

Definition at line 101 of file groupdef.cpp.

{ m_groupScope = d; }

References m_groupScope.

setGroupTitle()

void GroupDefImpl::setGroupTitle ( const QCString & newtitle )

overridevirtual

Implements GroupDef.

Definition at line 223 of file groupdef.cpp.

{
  setGroupTitleLocal(t);
}

References setGroupTitleLocal().

setGroupTitleLocal()

void GroupDefImpl::setGroupTitleLocal ( const QCString & title )

private

Definition at line 208 of file groupdef.cpp.

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

References FALSE, QCString::isEmpty(), m_title, m_titleSet, DefinitionMixin< GroupDef >::name(), and TRUE.

Referenced by GroupDefImpl(), and setGroupTitle().

sortMemberLists()

void GroupDefImpl::sortMemberLists ( )

overridevirtual

Implements GroupDef.

Definition at line 1902 of file groupdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
  }
  if (Config_getBool(SORT_BRIEF_DOCS))
  {
    std::stable_sort(m_dirList.begin(), m_dirList.end(), compareDirDefs);
 
    auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
    {
      return Config_getBool(SORT_BY_SCOPE_NAME)     ?
        qstricmp_sort(c1->name(), c2->name())<0          :
        qstricmp_sort(c1->className(), c2->className())<0;
    };
    std::stable_sort(m_classes.begin(), m_classes.end(), classComp);
 
    auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
    {
      return qstricmp_sort(n1->name(),n2->name())<0;
    };
 
    std::stable_sort(m_namespaces.begin(),m_namespaces.end(),namespaceComp);
 
    auto moduleComp = [](const ModuleLinkedRefMap::Ptr &m1,const ModuleLinkedRefMap::Ptr &m2)
    {
      return qstricmp_sort(m1->name(),m2->name())<0;
    };
 
    std::stable_sort(m_modules.begin(), m_modules.end(), moduleComp);
 
    auto conceptComp = [](const ConceptLinkedRefMap::Ptr &c1,const ConceptLinkedRefMap::Ptr &c2)
    {
      return qstricmp_sort(c1->name(),c2->name())<0;
    };
 
    std::stable_sort(m_concepts.begin(), m_concepts.end(), conceptComp);
 
    std::stable_sort(m_dirList.begin(), m_dirList.end(), compareDirDefs);
    std::stable_sort(m_fileList.begin(), m_fileList.end(), compareFileDefs);
 
  }
  else
  {
    groupClassesWithSameScope(m_classes);
    groupClassesWithSameScope(m_namespaces);
  }
}

References ClassDef::className(), compareDirDefs(), compareFileDefs(), Config_getBool, FALSE, groupClassesWithSameScope(), m_classes, m_concepts, m_dirList, m_fileList, m_memberLists, m_modules, m_namespaces, Definition::name(), and qstricmp_sort().

sortSubGroups()

void GroupDefImpl::sortSubGroups ( )

overridevirtual

Implements GroupDef.

Definition at line 1992 of file groupdef.cpp.

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

References Config_getBool, and m_groups.

startMemberDeclarations()

void GroupDefImpl::startMemberDeclarations ( OutputList & ol )

private

Definition at line 1123 of file groupdef.cpp.

{
  ol.startMemberSections();
}

References OutputList::startMemberSections().

Referenced by writeDocumentation().

startMemberDocumentation()

void GroupDefImpl::startMemberDocumentation ( OutputList & ol )

private

Definition at line 1133 of file groupdef.cpp.

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

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

Referenced by writeDocumentation().

subGrouping()

bool GroupDefImpl::subGrouping ( ) const

inlineoverridevirtual

Implements GroupDef.

Definition at line 99 of file groupdef.cpp.

{ return m_subGrouping; }

References m_subGrouping.

updateLanguage()

void GroupDefImpl::updateLanguage ( const Definition * d )

private

Definition at line 2044 of file groupdef.cpp.

{
  if (getLanguage()==SrcLangExt::Unknown && d->getLanguage()!=SrcLangExt::Unknown)
  {
    setLanguage(d->getLanguage());
  }
}

References Definition::getLanguage(), DefinitionMixin< GroupDef >::getLanguage(), and DefinitionMixin< GroupDef >::setLanguage().

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

writeAuthorSection()

void GroupDefImpl::writeAuthorSection ( OutputList & ol )

private

Definition at line 1154 of file groupdef.cpp.

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

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, and TRUE.

Referenced by writeDocumentation().

writeBriefDescription()

void GroupDefImpl::writeBriefDescription ( OutputList & ol )

private

Definition at line 859 of file groupdef.cpp.

{
  if (hasBriefDescription())
  {
    auto parser { createDocParser() };
    auto ast    { validatingParseDoc(*parser.get(),
                                     briefFile(),
                                     briefLine(),
                                     this,
                                     nullptr,
                                     briefDescription(),
                                     DocOptions()
                                     .setIndexWords(true)
                                     .setSingleLine(true))
                };
    if (!ast->isEmpty())
    {
      ol.startParagraph();
      ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Man);
      ol.writeString(" - ");
      ol.popGeneratorState();
      ol.writeDoc(ast.get(),this,nullptr);
      ol.pushGeneratorState();
      ol.disable(OutputType::RTF);
      ol.writeString(" \n");
      ol.enable(OutputType::RTF);
 
      if (hasDetailedDescription())
      {
        ol.disableAllBut(OutputType::Html);
        ol.startTextLink(QCString(),"details");
        ol.parseText(theTranslator->trMore());
        ol.endTextLink();
      }
      ol.popGeneratorState();
      ol.endParagraph();
    }
  }
  ol.writeSynopsis();
}

References DefinitionMixin< GroupDef >::briefDescription(), DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), createDocParser(), OutputList::disable(), OutputList::disableAllBut(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), DefinitionMixin< GroupDef >::hasBriefDescription(), hasDetailedDescription(), Html, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

writeClasses()

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

private

Definition at line 1063 of file groupdef.cpp.

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

References FALSE, and m_classes.

Referenced by writeDocumentation().

writeConcepts()

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

private

Definition at line 1069 of file groupdef.cpp.

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

References FALSE, and m_concepts.

Referenced by writeDocumentation().

writeDetailedDescription()

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

private

Definition at line 782 of file groupdef.cpp.

{
  if ((!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
      || !documentation().isEmpty() || !inbodyDocumentation().isEmpty()
     )
  {
    ol.pushGeneratorState();
    if (m_pages.size()!=numDocMembers()) // not only pages -> classical layout
    {
      ol.pushGeneratorState();
        ol.disable(OutputType::Html);
        ol.writeRuler();
      ol.popGeneratorState();
      ol.pushGeneratorState();
        ol.disableAllBut(OutputType::Html);
        ol.writeAnchor(QCString(),"details");
      ol.popGeneratorState();
    }
    else
    {
      ol.disableAllBut(OutputType::Man); // always print title for man page
    }
    ol.startGroupHeader("details");
    ol.parseText(title);
    ol.endGroupHeader();
    ol.popGeneratorState();
 
    // repeat brief description
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
    {
      ol.generateDoc(briefFile(),
                     briefLine(),
                     this,
                     nullptr,
                     briefDescription(),
                     DocOptions());
    }
    // write separator between brief and details
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF) &&
        !documentation().isEmpty())
    {
      ol.pushGeneratorState();
      ol.disable(OutputType::Man);
      ol.disable(OutputType::RTF);
      ol.enableAll();
      ol.disableAllBut(OutputType::Man);
      ol.enable(OutputType::Latex);
      ol.writeString("\n\n");
      ol.popGeneratorState();
    }
 
    // write detailed documentation
    if (!documentation().isEmpty())
    {
      ol.generateDoc(docFile(),
                     docLine(),
                     this,
                     nullptr,
                     documentation()+"\n",
                     DocOptions()
                     .setIndexWords(true));
    }
 
    // write inbody documentation
    if (!inbodyDocumentation().isEmpty())
    {
      ol.generateDoc(inbodyFile(),
                     inbodyLine(),
                     this,
                     nullptr,
                     inbodyDocumentation()+"\n",
                     DocOptions()
                     .setIndexWords(true));
    }
  }
}

References DefinitionMixin< GroupDef >::briefDescription(), DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< GroupDef >::docFile(), DefinitionMixin< GroupDef >::docLine(), DefinitionMixin< GroupDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::generateDoc(), Html, DefinitionMixin< GroupDef >::inbodyDocumentation(), DefinitionMixin< GroupDef >::inbodyFile(), DefinitionMixin< GroupDef >::inbodyLine(), Latex, m_pages, Man, numDocMembers(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startGroupHeader(), OutputList::writeAnchor(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

writeDirs()

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

private

Definition at line 1024 of file groupdef.cpp.

{
  // write list of directories
  if (!m_dirList.empty())
  {
    ol.startMemberHeader("dirs");
    ol.parseText(title);
    ol.endMemberHeader();
    ol.startMemberList();
    for(const auto dd : m_dirList)
    {
      if (!dd->hasDocumentation()) continue;
      ol.startMemberDeclaration();
      QCString anc = dd->anchor();
      if (anc.isEmpty()) anc=dd->shortName(); else anc.prepend(dd->shortName()+"_");
      ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
      ol.parseText(theTranslator->trDir(FALSE,TRUE));
      ol.insertMemberAlign();
      ol.writeObjectLink(dd->getReference(),dd->getOutputFileBase(),QCString(),dd->shortName());
      ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
      if (!dd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
      {
        ol.startMemberDescription(dd->getOutputFileBase());
        ol.generateDoc(briefFile(),
                       briefLine(),
                       dd,
                       nullptr,
                       dd->briefDescription(),
                       DocOptions()
                       .setSingleLine(true));
        ol.endMemberDescription();
      }
      ol.endMemberDeclaration(QCString(),QCString());
    }
 
    ol.endMemberList();
  }
}

References DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), QCString::isEmpty(), m_dirList, OutputGenerator::Normal, OutputList::parseText(), QCString::prepend(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, TRUE, and OutputList::writeObjectLink().

Referenced by writeDocumentation().

writeDocumentation()

void GroupDefImpl::writeDocumentation ( OutputList & ol )

overridevirtual

Implements GroupDef.

Definition at line 1223 of file groupdef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
 
  // Find out how deep this group is nested. In case of multiple parents, use the first one.
  int hierarchyLevel = 0;
  const GroupDef *gd = this;
  while (!gd->partOfGroups().empty())
  {
    gd = gd->partOfGroups().front();
    ++hierarchyLevel;
  }
 
  startFile(ol,getOutputFileBase(),false,name(),m_title,HighlightedItem::Topics,
            FALSE /* additionalIndices*/, QCString() /*altSidebarName*/, hierarchyLevel);
 
  ol.startHeaderSection();
  bool writeOutlinePanel = generateTreeView && Config_getBool(PAGE_OUTLINE_PANEL);
  if (!writeOutlinePanel) writeSummaryLinks(ol);
  ol.startTitleHead(getOutputFileBase());
  //1.{
  ol.pushGeneratorState();
  ol.disable(OutputType::Man);
  ol.generateDoc(docFile(),
                 getStartBodyLine(),
                 this,
                 nullptr,
                 m_title,
                 DocOptions()
                 .setIndexWords(true)
                 .setSingleLine(true)
                 .setAutolinkSupport(false));
  ol.popGeneratorState();
  //1.}
  addGroupListToTitle(ol,this);
  //2.{
  ol.pushGeneratorState();
  ol.disable(OutputType::Man);
  ol.endTitleHead(getOutputFileBase(),m_title);
  ol.popGeneratorState();
  //2.}
  //3.{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Man);
  ol.endTitleHead(getOutputFileBase(),name());
  if (!m_title.isEmpty())
  {
    ol.writeString(" - ");
    ol.parseText(m_title);
  }
  ol.popGeneratorState();
  //3.}
  ol.endHeaderSection();
  ol.startContents();
 
  //---------------------------------------- start flexible part -------------------------------
 
  SrcLangExt lang=getLanguage();
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Group))
  {
    const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc:
        writeBriefDescription(ol);
        break;
      case LayoutDocEntry::MemberDeclStart:
        startMemberDeclarations(ol);
        break;
      case LayoutDocEntry::GroupClasses:
        if (ls) writeClasses(ol,ls->title(lang));
        break;
      case LayoutDocEntry::GroupConcepts:
        if (ls) writeConcepts(ol,ls->title(lang));
        break;
      case LayoutDocEntry::GroupModules:
        if (ls) writeModules(ol,ls->title(lang));
        break;
      case LayoutDocEntry::GroupInlineClasses:
        writeInlineClasses(ol);
        break;
      case LayoutDocEntry::GroupNamespaces:
        if (ls) writeNamespaces(ol,ls->title(lang));
        break;
      case LayoutDocEntry::MemberGroups:
        writeMemberGroups(ol);
        break;
      case LayoutDocEntry::MemberDecl:
        {
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd)
          {
            writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
          }
        }
        break;
      case LayoutDocEntry::MemberDeclEnd:
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc:
        if (ls) writeDetailedDescription(ol,ls->title(lang));
        break;
      case LayoutDocEntry::MemberDefStart:
        startMemberDocumentation(ol);
        break;
      case LayoutDocEntry::MemberDef:
        {
          const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
          if (lmd)
          {
            writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
          }
        }
        break;
      case LayoutDocEntry::MemberDefEnd:
        endMemberDocumentation(ol);
        break;
      case LayoutDocEntry::GroupNestedGroups:
        if (ls) writeNestedGroups(ol,ls->title(lang));
        break;
      case LayoutDocEntry::GroupPageDocs:
        writePageDocumentation(ol);
        break;
      case LayoutDocEntry::GroupDirs:
        if (ls) writeDirs(ol,ls->title(lang));
        break;
      case LayoutDocEntry::GroupFiles:
        if (ls) writeFiles(ol,ls->title(lang));
        break;
      case LayoutDocEntry::GroupGraph:
        writeGroupGraph(ol);
        break;
      case LayoutDocEntry::AuthorSection:
        writeAuthorSection(ol);
        break;
      case LayoutDocEntry::ClassIncludes:
      case LayoutDocEntry::ClassInheritanceGraph:
      case LayoutDocEntry::ClassNestedClasses:
      case LayoutDocEntry::ClassCollaborationGraph:
      case LayoutDocEntry::ClassAllMembersLink:
      case LayoutDocEntry::ClassUsedFiles:
      case LayoutDocEntry::ClassInlineClasses:
      case LayoutDocEntry::NamespaceNestedNamespaces:
      case LayoutDocEntry::NamespaceNestedConstantGroups:
      case LayoutDocEntry::NamespaceClasses:
      case LayoutDocEntry::NamespaceConcepts:
      case LayoutDocEntry::NamespaceInterfaces:
      case LayoutDocEntry::NamespaceStructs:
      case LayoutDocEntry::NamespaceExceptions:
      case LayoutDocEntry::NamespaceInlineClasses:
      case LayoutDocEntry::ConceptDefinition:
      case LayoutDocEntry::FileClasses:
      case LayoutDocEntry::FileConcepts:
      case LayoutDocEntry::FileInterfaces:
      case LayoutDocEntry::FileStructs:
      case LayoutDocEntry::FileExceptions:
      case LayoutDocEntry::FileNamespaces:
      case LayoutDocEntry::FileConstantGroups:
      case LayoutDocEntry::FileIncludes:
      case LayoutDocEntry::FileIncludeGraph:
      case LayoutDocEntry::FileIncludedByGraph:
      case LayoutDocEntry::FileSourceLink:
      case LayoutDocEntry::FileInlineClasses:
      case LayoutDocEntry::ModuleExports:
      case LayoutDocEntry::ModuleClasses:
      case LayoutDocEntry::ModuleConcepts:
      case LayoutDocEntry::ModuleUsedFiles:
      case LayoutDocEntry::DirSubDirs:
      case LayoutDocEntry::DirFiles:
      case LayoutDocEntry::DirGraph:
        err("Internal inconsistency: member '{}' should not be part of "
            "LayoutDocManager::Group entry list\n",lde->entryToString());
        break;
    }
  }
 
  //---------------------------------------- end flexible part -------------------------------
 
  for (auto &subgd : getSubGroups())
  {
    if (!subgd->isReference())
    {
      if (subgd->partOfGroups().front() == this)
      {
        ol.writePageLink(subgd->getOutputFileBase(), FALSE);
      }
      else
      {
        // Could write a note explaining that the subgroup belongs to another
        // group and add a link here.
      }
    }
  }
  if (generateTreeView && Config_getBool(PAGE_OUTLINE_PANEL))
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Html);
    ol.endContents();
    ol.writeString("</div><!-- doc-content -->\n");
    writePageNavigation(ol);
    ol.writeString("</div><!-- container -->\n");
    ol.popGeneratorState();
    endFile(ol,true,true);
  }
  else
  {
    endFile(ol);
  }
 
  ol.popGeneratorState();
 
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    m_allMemberList.sort();
    writeMemberPages(ol, hierarchyLevel + 1);
  }
}

References addGroupListToTitle(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< GroupDef >::docFile(), OutputList::endContents(), endFile(), OutputList::endHeaderSection(), endMemberDeclarations(), endMemberDocumentation(), OutputList::endTitleHead(), err, FALSE, OutputList::generateDoc(), DefinitionMixin< GroupDef >::getLanguage(), getOutputFileBase(), DefinitionMixin< GroupDef >::getStartBodyLine(), getSubGroups(), Html, LayoutDocManager::instance(), m_allMemberList, m_title, Man, DefinitionMixin< GroupDef >::name(), OutputList::parseText(), Definition::partOfGroups(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startContents(), startFile(), OutputList::startHeaderSection(), startMemberDeclarations(), startMemberDocumentation(), OutputList::startTitleHead(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), LayoutDocEntrySection::title(), Topics, LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, writeAuthorSection(), writeBriefDescription(), writeClasses(), writeConcepts(), writeDetailedDescription(), writeDirs(), writeFiles(), writeGroupGraph(), writeInlineClasses(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), writeMemberPages(), writeModules(), writeNamespaces(), writeNestedGroups(), writePageDocumentation(), OutputList::writePageLink(), writePageNavigation(), OutputList::writeString(), and writeSummaryLinks().

writeFiles()

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

private

Definition at line 926 of file groupdef.cpp.

{
  // write list of files
  if (!m_fileList.empty())
  {
    ol.startMemberHeader("files");
    ol.parseText(title);
    ol.endMemberHeader();
    ol.startMemberList();
    for (const auto &fd : m_fileList)
    {
      if (!fd->hasDocumentation()) continue;
      ol.startMemberDeclaration();
      QCString anc = fd->anchor();
      if (anc.isEmpty()) anc=fd->displayName(); else anc.prepend(fd->displayName()+"_");
      ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
      ol.docify(theTranslator->trFile(FALSE,TRUE)+" ");
      ol.insertMemberAlign();
      ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),QCString(),fd->displayName());
      ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
      if (!fd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
      {
        ol.startMemberDescription(fd->getOutputFileBase());
        ol.generateDoc(briefFile(),
                       briefLine(),
                       fd,
                       nullptr,
                       fd->briefDescription(),
                       DocOptions()
                       .setSingleLine(true));
        ol.endMemberDescription();
      }
      ol.endMemberDeclaration(QCString(),QCString());
    }
    ol.endMemberList();
  }
}

References DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::docify(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), QCString::isEmpty(), m_fileList, OutputGenerator::Normal, OutputList::parseText(), QCString::prepend(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, TRUE, and OutputList::writeObjectLink().

Referenced by writeDocumentation().

writeGroupGraph()

void GroupDefImpl::writeGroupGraph ( OutputList & ol )

private

Definition at line 901 of file groupdef.cpp.

{
  if (Config_getBool(HAVE_DOT) && m_hasGroupGraph /*&& Config_getBool(GROUP_GRAPHS)*/)
  {
    DotGroupCollaboration graph(this);
    if (graph.isTooBig())
    {
       warn_uncond("Group dependency graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           name(), graph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!graph.isTrivial())
    {
      msg("Generating dependency graph for group {}\n",qualifiedName());
      ol.pushGeneratorState();
      ol.disable(OutputType::Man);
      //ol.startParagraph();
      ol.startGroupCollaboration();
      ol.parseText(theTranslator->trCollaborationDiagram(m_title));
      ol.endGroupCollaboration(graph);
      //ol.endParagraph();
      ol.popGeneratorState();
    }
  }
}

References Config_getBool, Config_getInt, OutputList::disable(), OutputList::endGroupCollaboration(), DotGroupCollaboration::isTooBig(), DotGroupCollaboration::isTrivial(), m_hasGroupGraph, m_title, Man, msg, DefinitionMixin< GroupDef >::name(), DotGroupCollaboration::numNodes(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DefinitionMixin< GroupDef >::qualifiedName(), OutputList::startGroupCollaboration(), theTranslator, and warn_uncond.

Referenced by writeDocumentation().

writeInlineClasses()

void GroupDefImpl::writeInlineClasses ( OutputList & ol )

private

Definition at line 1082 of file groupdef.cpp.

{
  m_classes.writeDocumentation(ol);
}

References m_classes.

Referenced by writeDocumentation().

writeMemberDeclarations()

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

private

Definition at line 1964 of file groupdef.cpp.

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

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

Referenced by writeDocumentation().

writeMemberDocumentation()

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

private

Definition at line 1980 of file groupdef.cpp.

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

References getMemberList(), MemberList::listType(), DefinitionMixin< GroupDef >::name(), MemberListType::toLabel(), and MemberList::writeDocumentation().

Referenced by writeDocumentation().

writeMemberGroups()

void GroupDefImpl::writeMemberGroups ( OutputList & ol )

private

Definition at line 1114 of file groupdef.cpp.

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

References m_memberGroups.

Referenced by writeDocumentation().

writeMemberPages()

void GroupDefImpl::writeMemberPages ( OutputList & ol, int hierarchyLevel )

overridevirtual

Implements GroupDef.

Definition at line 1442 of file groupdef.cpp.

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

References OutputList::disableAllBut(), Html, m_memberLists, DefinitionMixin< GroupDef >::name(), OutputList::popGeneratorState(), and OutputList::pushGeneratorState().

Referenced by writeDocumentation().

writeModules()

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

private

Definition at line 1075 of file groupdef.cpp.

{
  // write list of modules
  m_modules.writeDeclaration(ol,title,FALSE);
}

References FALSE, and m_modules.

Referenced by writeDocumentation().

writeNamespaces()

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

private

Definition at line 964 of file groupdef.cpp.

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

References m_namespaces.

Referenced by writeDocumentation().

writeNestedGroups()

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

private

Definition at line 970 of file groupdef.cpp.

{
  // write list of groups
  int count=0;
  for (const auto &gd : m_groups)
  {
    if (gd->isVisible()) count++;
  }
  if (count>0)
  {
    ol.startMemberHeader("groups");
    ol.parseText(title);
    ol.endMemberHeader();
    ol.startMemberList();
    for (const auto &gd : m_groups)
    {
      if (gd->isVisible())
      {
        if (!gd->hasDocumentation()) continue;
        ol.startMemberDeclaration();
        QCString anc = gd->anchor();
        if (anc.isEmpty()) anc=gd->name(); else anc.prepend(gd->name()+"_");
        ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
        ol.insertMemberAlign();
        ol.startIndexItem(gd->getReference(),gd->getOutputFileBase());
        ol.generateDoc(gd->getDefFileName(),
                       gd->getDefLine(),
                       gd,
                       nullptr,
                       gd->groupTitle(),
                       DocOptions()
                       .setSingleLine(true)
                       .setAutolinkSupport(false));
        ol.endIndexItem(gd->getReference(),gd->getOutputFileBase());
        ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
        if (!gd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
        {
          ol.startMemberDescription(gd->getOutputFileBase());
          ol.generateDoc(briefFile(),
                         briefLine(),
                         gd,
                         nullptr,
                         gd->briefDescription(),
                         DocOptions()
                         .setSingleLine(true));
          ol.endMemberDescription();
        }
        ol.endMemberDeclaration(QCString(),QCString());
      }
    }
    ol.endMemberList();
  }
}

References DefinitionMixin< GroupDef >::briefFile(), DefinitionMixin< GroupDef >::briefLine(), Config_getBool, OutputList::endIndexItem(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::generateDoc(), OutputList::insertMemberAlign(), QCString::isEmpty(), m_groups, OutputGenerator::Normal, OutputList::parseText(), QCString::prepend(), OutputList::startIndexItem(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), and OutputList::startMemberList().

Referenced by writeDocumentation().

writePageDocumentation()

void GroupDefImpl::writePageDocumentation ( OutputList & ol )

private

Definition at line 1087 of file groupdef.cpp.

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

References OutputList::docify(), OutputList::endSection(), OutputList::endTextBlock(), OutputList::generateDoc(), SectionManager::instance(), SectionInfo::label(), m_pages, OutputList::startSection(), OutputList::startTextBlock(), SectionType::Subsection, and SectionInfo::title().

Referenced by writeDocumentation().

writePageNavigation()

void GroupDefImpl::writePageNavigation ( OutputList & ol ) const

overridevirtual

Reimplemented from DefinitionMixin< GroupDef >.

Definition at line 1218 of file groupdef.cpp.

{
  ol.writePageOutline();
}

References OutputList::writePageOutline().

Referenced by writeDocumentation().

writeQuickMemberLinks()

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

overridevirtual

Reimplemented from DefinitionMixin< GroupDef >.

Definition at line 1458 of file groupdef.cpp.

{
  bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
 
  ol.writeString("      <div class=\"navtab\">\n");
  ol.writeString("        <table>\n");
 
  for (const auto *md : m_allMemberList)
  {
    if (md->getGroupDef()==this && md->isLinkable() && !md->isEnumValue())
    {
      if (md->isLinkableInProject())
      {
        QCString fn = md->getOutputFileBase();
        addHtmlExtensionIfMissing(fn);
        if (md==currentMd) // selected item => highlight
        {
          ol.writeString("          <tr><td class=\"navtabHL\">");
        }
        else
        {
          ol.writeString("          <tr><td class=\"navtab\">");
        }
        ol.writeString("<span class=\"label\"><a ");
        ol.writeString("href=\"");
        if (createSubDirs) ol.writeString("../../");
        ol.writeString(fn+"#"+md->anchor());
        ol.writeString("\">");
        ol.writeString(convertToHtml(md->localName()));
        ol.writeString("</a></span>");
        ol.writeString("</td></tr>\n");
      }
    }
  }
  ol.writeString("        </table>\n");
  ol.writeString("      </div>\n");
}

References addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), createSubDirs(), m_allMemberList, and OutputList::writeString().

writeSummaryLinks()

void GroupDefImpl::writeSummaryLinks ( OutputList & ol ) const

overridevirtual

Reimplemented from DefinitionMixin< GroupDef >.

Definition at line 1166 of file groupdef.cpp.

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  bool first=TRUE;
  SrcLangExt lang = getLanguage();
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Group))
  {
    if ((lde->kind()==LayoutDocEntry::GroupClasses      &&  m_classes.declVisible()) ||
        (lde->kind()==LayoutDocEntry::GroupConcepts     &&  m_concepts.declVisible()) ||
        (lde->kind()==LayoutDocEntry::GroupModules      &&  m_modules.declVisible()) ||
        (lde->kind()==LayoutDocEntry::GroupNamespaces   &&  m_namespaces.declVisible(false)) ||
        (lde->kind()==LayoutDocEntry::GroupFiles        && !m_fileList.empty()) ||
        (lde->kind()==LayoutDocEntry::GroupNestedGroups && !m_groups.empty()) ||
        (lde->kind()==LayoutDocEntry::GroupDirs         && !m_dirList.empty())
       )
    {
      const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
      if (ls)
      {
        QCString label = lde->kind()==LayoutDocEntry::GroupClasses      ? "nested-classes" :
                         lde->kind()==LayoutDocEntry::GroupConcepts     ? "concepts"       :
                         lde->kind()==LayoutDocEntry::GroupModules      ? "modules"        :
                         lde->kind()==LayoutDocEntry::GroupNamespaces   ? "namespaces"     :
                         lde->kind()==LayoutDocEntry::GroupFiles        ? "files"          :
                         lde->kind()==LayoutDocEntry::GroupNestedGroups ? "groups"         :
                                                                          "dirs";
        ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
        first=FALSE;
      }
    }
    else if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd)
      {
        MemberList * ml = getMemberList(lmd->type);
        if (ml && ml->declVisible())
        {
          ol.writeSummaryLink(QCString(),ml->listType().toLabel(),lmd->title(lang),first);
          first=FALSE;
        }
      }
    }
  }
  if (!first)
  {
    ol.writeString("  </div>\n");
  }
  ol.popGeneratorState();
}

References MemberList::declVisible(), OutputList::disableAllBut(), FALSE, DefinitionMixin< GroupDef >::getLanguage(), getMemberList(), Html, LayoutDocManager::instance(), MemberList::listType(), m_classes, m_concepts, m_dirList, m_fileList, m_groups, m_modules, m_namespaces, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntryMemberDecl::title(), LayoutDocEntrySection::title(), MemberListType::toLabel(), TRUE, LayoutDocEntryMemberDecl::type, OutputList::writeString(), and OutputList::writeSummaryLink().

Referenced by writeDocumentation().

writeTagFile()

void GroupDefImpl::writeTagFile ( TextStream & tagFile )

overridevirtual

Implements GroupDef.

Definition at line 648 of file groupdef.cpp.

{
  QCString fn = getOutputFileBase();
  addHtmlExtensionIfMissing(fn);
  tagFile << "  <compound kind=\"group\">\n";
  tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
  tagFile << "    <title>" << convertToXML(m_title) << "</title>\n";
  tagFile << "    <filename>" << fn << "</filename>\n";
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Group))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::GroupClasses:
        {
          for (const auto &cd : m_classes)
          {
            if (cd->isLinkableInProject())
            {
              tagFile << "    <class kind=\"" << cd->compoundTypeString()
                      << "\">" << convertToXML(cd->name()) << "</class>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupConcepts:
        {
          for (const auto &cd : m_concepts)
          {
            if (cd->isLinkableInProject())
            {
              tagFile << "    <concept>" << convertToXML(cd->name())
                      << "</concept>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupModules:
        {
          for (const auto &mod : m_modules)
          {
            if (mod->isLinkableInProject())
            {
              tagFile << "    <module>" << convertToXML(mod->name())
                      << "</module>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupNamespaces:
        {
          for (const auto &nd : m_namespaces)
          {
            if (nd->isLinkableInProject())
            {
              tagFile << "    <namespace>" << convertToXML(nd->name())
                      << "</namespace>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupFiles:
        {
          for (const auto &fd : m_fileList)
          {
            if (fd->isLinkableInProject())
            {
              tagFile << "    <file>" << convertToXML(fd->name()) << "</file>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupPageDocs:
        {
          for (const auto &pd : m_pages)
          {
            QCString pageName = pd->getOutputFileBase();
            if (pd->isLinkableInProject())
            {
              tagFile << "    <page>" << convertToXML(pageName) << "</page>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupDirs:
        {
          for (const auto &dd : m_dirList)
          {
            if (dd->isLinkableInProject())
            {
              tagFile << "    <dir>" << convertToXML(dd->displayName()) << "</dir>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::GroupNestedGroups:
        {
          for (const auto &gd : m_groups)
          {
            if (gd->isVisible())
            {
              tagFile << "    <subgroup>" << convertToXML(gd->name()) << "</subgroup>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::MemberDecl:
        {
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd)
          {
            MemberList * ml = getMemberList(lmd->type);
            if (ml)
            {
              ml->writeTagFile(tagFile,true);
            }
          }
        }
        break;
      case LayoutDocEntry::MemberGroups:
        {
          for (const auto &mg : m_memberGroups)
          {
            mg->writeTagFile(tagFile,true);
          }
        }
        break;
      default:
        break;
    }
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>\n";
}

References addHtmlExtensionIfMissing(), convertToXML(), getMemberList(), getOutputFileBase(), LayoutDocManager::instance(), m_classes, m_concepts, m_dirList, m_fileList, m_groups, m_memberGroups, m_modules, m_namespaces, m_pages, m_title, DefinitionMixin< GroupDef >::name(), LayoutDocEntryMemberDecl::type, DefinitionMixin< GroupDef >::writeDocAnchorsToTagFile(), and MemberList::writeTagFile().

Member Data Documentation

m_allMemberList

MemberList GroupDefImpl::m_allMemberList

private

Definition at line 165 of file groupdef.cpp.

Referenced by computeAnchors(), GroupDefImpl(), insertMember(), numDocMembers(), writeDocumentation(), and writeQuickMemberLinks().

m_allMemberNameInfoLinkedMap

MemberNameInfoLinkedMap GroupDefImpl::m_allMemberNameInfoLinkedMap

private

Definition at line 166 of file groupdef.cpp.

Referenced by insertMember(), and removeMember().

m_classes

ClassLinkedRefMap GroupDefImpl::m_classes

private

Definition at line 157 of file groupdef.cpp.

Referenced by addClass(), getClasses(), numDocMembers(), sortMemberLists(), writeClasses(), writeInlineClasses(), writeSummaryLinks(), and writeTagFile().

m_concepts

ConceptLinkedRefMap GroupDefImpl::m_concepts

private

Definition at line 158 of file groupdef.cpp.

Referenced by addConcept(), getConcepts(), sortMemberLists(), writeConcepts(), writeSummaryLinks(), and writeTagFile().

m_dirList

DirList GroupDefImpl::m_dirList

private

Definition at line 164 of file groupdef.cpp.

Referenced by addDir(), getDirs(), sortMemberLists(), writeDirs(), writeSummaryLinks(), and writeTagFile().

m_examples

PageLinkedRefMap GroupDefImpl::m_examples

private

Definition at line 163 of file groupdef.cpp.

Referenced by addExample(), getExamples(), and numDocMembers().

m_fileList

FileList GroupDefImpl::m_fileList

private

Definition at line 156 of file groupdef.cpp.

Referenced by addFile(), containsFile(), getFiles(), numDocMembers(), sortMemberLists(), writeFiles(), writeSummaryLinks(), and writeTagFile().

m_fileName

QCString GroupDefImpl::m_fileName

private

Definition at line 155 of file groupdef.cpp.

Referenced by getOutputFileBase().

m_groups

GroupList GroupDefImpl::m_groups

private

Definition at line 161 of file groupdef.cpp.

Referenced by addGroup(), findGroup(), getSubGroups(), numDocMembers(), sortSubGroups(), writeNestedGroups(), writeSummaryLinks(), and writeTagFile().

m_groupScope

Definition* GroupDefImpl::m_groupScope

private

Definition at line 167 of file groupdef.cpp.

Referenced by getGroupScope(), GroupDefImpl(), and setGroupScope().

m_hasGroupGraph

bool GroupDefImpl::m_hasGroupGraph = false

private

Definition at line 171 of file groupdef.cpp.

Referenced by GroupDefImpl(), hasGroupGraph(), overrideGroupGraph(), and writeGroupGraph().

m_memberGroups

MemberGroupList GroupDefImpl::m_memberGroups

private

Definition at line 169 of file groupdef.cpp.

Referenced by addListReferences(), addMembersToMemberGroup(), countMembers(), distributeMemberGroupDocumentation(), findSectionsInDocumentation(), getMemberGroups(), writeMemberGroups(), and writeTagFile().

m_memberLists

MemberLists GroupDefImpl::m_memberLists

private

Definition at line 168 of file groupdef.cpp.

Referenced by addListReferences(), addMembersToMemberGroup(), addMemberToList(), countMembers(), findSectionsInDocumentation(), getMemberList(), getMemberLists(), sortMemberLists(), and writeMemberPages().

m_modules

ModuleLinkedRefMap GroupDefImpl::m_modules

private

Definition at line 159 of file groupdef.cpp.

Referenced by addModule(), getModules(), sortMemberLists(), writeModules(), writeSummaryLinks(), and writeTagFile().

m_namespaces

NamespaceLinkedRefMap GroupDefImpl::m_namespaces

private

Definition at line 160 of file groupdef.cpp.

Referenced by addNamespace(), getNamespaces(), numDocMembers(), sortMemberLists(), writeNamespaces(), writeSummaryLinks(), and writeTagFile().

m_pages

PageLinkedRefMap GroupDefImpl::m_pages

private

Definition at line 162 of file groupdef.cpp.

Referenced by addPage(), getPages(), hasDetailedDescription(), numDocMembers(), writeDetailedDescription(), writePageDocumentation(), and writeTagFile().

m_subGrouping

bool GroupDefImpl::m_subGrouping

private

Definition at line 170 of file groupdef.cpp.

Referenced by GroupDefImpl(), and subGrouping().

m_title

QCString GroupDefImpl::m_title

private

Definition at line 153 of file groupdef.cpp.

Referenced by displayName(), groupTitle(), setGroupTitleLocal(), writeDocumentation(), writeGroupGraph(), and writeTagFile().

m_titleSet

bool GroupDefImpl::m_titleSet

private

Definition at line 154 of file groupdef.cpp.

Referenced by hasGroupTitle(), and setGroupTitleLocal().

---

The documentation for this class was generated from the following file:

• src/groupdef.cpp