doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

LayoutDocManager Class Reference

Singleton providing access to the (user configurable) layout of the documentation. More...

#include <layout.h>

+ Collaboration diagram for LayoutDocManager:

Classes

class  Private
 

Public Types

enum  LayoutPart {
  Class, Namespace, File, Group,
  Directory, NrParts
}
 

Public Member Functions

const QList< LayoutDocEntry > & docEntries (LayoutPart part) const
 Returns the list of LayoutDocEntry's in representation order for a given page identified by part. More...
 
LayoutNavEntryrootNavEntry () const
 returns the (invisible) root of the navigation tree. More...
 
void parse (const char *fileName)
 Parses a user provided layout. More...
 
void init ()
 

Static Public Member Functions

static LayoutDocManagerinstance ()
 Returns a reference to this singleton. More...
 

Private Member Functions

void addEntry (LayoutPart p, LayoutDocEntry *e)
 
void clear (LayoutPart p)
 
 LayoutDocManager ()
 
 ~LayoutDocManager ()
 

Private Attributes

Privated
 

Friends

class LayoutParser
 

Detailed Description

Singleton providing access to the (user configurable) layout of the documentation.

Definition at line 185 of file layout.h.

Member Enumeration Documentation

◆ LayoutPart

Enumerator
Class 
Namespace 
File 
Group 
Directory 
NrParts 

Definition at line 189 of file layout.h.

Constructor & Destructor Documentation

◆ LayoutDocManager()

LayoutDocManager::LayoutDocManager ( )
private

◆ ~LayoutDocManager()

LayoutDocManager::~LayoutDocManager ( )
private

Definition at line 1509 of file layout.cpp.

References d, and LayoutDocManager::Private::rootNav.

Member Function Documentation

◆ addEntry()

◆ clear()

◆ docEntries()

const QList< LayoutDocEntry > & LayoutDocManager::docEntries ( LayoutDocManager::LayoutPart  part) const

Returns the list of LayoutDocEntry's in representation order for a given page identified by part.

Definition at line 1521 of file layout.cpp.

References d, and LayoutDocManager::Private::docEntries.

◆ init()

◆ instance()

LayoutDocManager & LayoutDocManager::instance ( )
static

Returns a reference to this singleton.

Definition at line 1515 of file layout.cpp.

References LayoutDocManager().

Referenced by addMembersToIndex(), ClassDefImpl::countAdditionalInheritedMembers(), LayoutParser::endMemberDecl(), LayoutParser::endMemberDef(), generateJSNavTree(), ClassDefImpl::getTitleForMemberListType(), parseInput(), renderQuickLinksAsTabs(), ClassDefImpl::setAnonymousEnumType(), LayoutParser::startClass(), LayoutParser::startDirectory(), LayoutParser::startFile(), LayoutParser::startGroup(), LayoutParser::startMemberDecl(), LayoutParser::startMemberDeclEntry(), LayoutParser::startMemberDef(), LayoutParser::startMemberDefEntry(), LayoutParser::startNamespace(), LayoutParser::startNavEntry(), LayoutParser::startNavIndex(), LayoutParser::startSectionEntry(), LayoutParser::startSimpleEntry(), ClassDefImpl::writeAdditionalInheritedMembers(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), ClassDefImpl::writeDeclaration(), writeDefaultQuickLinks(), DirDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndexHierarchy(), writeIndexHierarchyEntries(), ClassDefImpl::writeInlineDocumentation(), writeMenuData(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex(), writePages(), FileDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ClassDefImpl::writeSummaryLinks(), DirDefImpl::writeTagFile(), NamespaceDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), and ClassDefImpl::writeTagFile().

◆ parse()

void LayoutDocManager::parse ( const char *  fileName)

◆ rootNavEntry()

Friends And Related Function Documentation

◆ LayoutParser

friend class LayoutParser
friend

Definition at line 212 of file layout.h.

Member Data Documentation

◆ d

Private* LayoutDocManager::d
private

Definition at line 211 of file layout.h.

Referenced by addEntry(), clear(), docEntries(), LayoutDocManager(), rootNavEntry(), and ~LayoutDocManager().


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