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)  

Doxygen Class Reference

This class serves as a namespace for global variables used by doxygen. More...

#include <doxygen.h>

+ Collaboration diagram for Doxygen:

Static Public Attributes

static ClassSDictclassSDict = 0
 
static ClassSDicthiddenClasses = 0
 
static PageSDictexampleSDict = 0
 
static PageSDictpageSDict = 0
 
static PageDefmainPage = 0
 
static bool insideMainPage = FALSE
 
static FileNameLinkedMapincludeNameLinkedMap = 0
 
static FileNameLinkedMapexampleNameLinkedMap = 0
 
static QDict< void > inputPaths
 
static FileNameLinkedMapinputNameLinkedMap = 0
 
static FileNameLinkedMapimageNameLinkedMap = 0
 
static FileNameLinkedMapdotFileNameLinkedMap = 0
 
static FileNameLinkedMapmscFileNameLinkedMap = 0
 
static FileNameLinkedMapdiaFileNameLinkedMap = 0
 
static MemberNameLinkedMapmemberNameLinkedMap = 0
 
static MemberNameLinkedMapfunctionNameLinkedMap = 0
 
static QStrList tagfileList
 
static StringDict namespaceAliasDict
 
static GroupSDictgroupSDict = 0
 
static NamespaceSDictnamespaceSDict = 0
 
static StringDict tagDestinationDict
 
static StringDict aliasDict
 
static QIntDict< MemberGroupInfomemGrpInfoDict
 
static QDict< void > expandAsDefinedDict
 
static NamespaceDefglobalScope = 0
 
static QCString htmlFileExtension
 
static bool parseSourcesNeeded = FALSE
 
static QTime runningTime
 
static SearchIndexIntfsearchIndex =0
 
static QDict< DefinitionIntf > * symbolMap = 0
 
static QDict< Definition > * clangUsrMap = 0
 
static bool outputToWizard =FALSE
 
static QDict< int > * htmlDirMap = 0
 
static QCache< LookupInfo > * lookupCache
 
static DirSDictdirectories
 
static SDict< DirRelationdirRelations
 
static ParserManagerparserManager = 0
 
static bool suppressDocWarnings = FALSE
 
static Store * symbolStorage
 
static QCString objDBFileName
 
static QCString entryDBFileName
 
static QCString filterDBFileName
 
static bool userComments = FALSE
 
static IndexListindexList
 
static int subpageNestingLevel = 0
 
static QCString spaces
 
static bool generatingXmlOutput = FALSE
 
static bool markdownSupport = TRUE
 
static GenericsSDictgenericsDict
 
static Preprocessorpreprocessor = 0
 

Detailed Description

This class serves as a namespace for global variables used by doxygen.

All fields in this class are public and static, so they can be used directly.

Definition at line 91 of file doxygen.h.

Member Data Documentation

◆ aliasDict

StringDict Doxygen::aliasDict
static

Definition at line 115 of file doxygen.h.

Referenced by escapeAliases(), expandAliases(), expandAliasRec(), readAliases(), and statistics().

◆ clangUsrMap

QDict< Definition > * Doxygen::clangUsrMap = 0
static

Definition at line 124 of file doxygen.h.

Referenced by generateOutput(), initDoxygen(), and DefinitionImpl::setId().

◆ classSDict

ClassSDict * Doxygen::classSDict = 0
static

Definition at line 94 of file doxygen.h.

Referenced by addClassToContext(), addListReferences(), addMembersToMemberGroup(), addSourceReferences(), buildCompleteMemberLists(), ClassListContext::ClassListContext(), cleanUpDoxygen(), clearAll(), clearVisitFlags(), computeClassRelations(), computeMemberReferences(), VhdlDocGen::computeVhdlComponentRelations(), countAnnotatedClasses(), countClassHierarchy(), countMembers(), createJavaScriptSearchIndex(), createTagLessInstance(), createTemplateInstanceMembers(), distributeClassGroupRelations(), distributeMemberGroupDocumentation(), DotGfxHierarchyTable::DotGfxHierarchyTable(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), DocbookGenerator::endIndexSection(), VhdlDocGen::findAllArchitectures(), VhdlDocGen::findArchitecture(), findClassRelation(), findDocsForMemberOrCompound(), findInheritedTemplateInstances(), findSectionsInDocumentation(), findTagLessClasses(), findTemplateInstanceRelation(), findUsedTemplateInstances(), VhdlDocGen::findVhdlClass(), generateClassDocs(), generateDEF(), PerlModGenerator::generatePerlModOutput(), generateXML(), VhdlDocGen::getClass(), getClass(), initDoxygen(), ClassIndexContext::Private::list(), mergeCategories(), parseInput(), ClassHierarchyContext::Private::Private(), ClassTreeContext::Private::Private(), resolveClassNestingRelations(), setAnonymousEnumType(), sortMemberLists(), RTFGenerator::startIndexSection(), LatexGenerator::startIndexSection(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), writeClassHierarchy(), VhdlDocGen::writeOverview(), and writeTagFile().

◆ diaFileNameLinkedMap

FileNameLinkedMap * Doxygen::diaFileNameLinkedMap = 0
static

◆ directories

◆ dirRelations

SDict< DirRelation > Doxygen::dirRelations
static

Definition at line 129 of file doxygen.h.

Referenced by generateDirDocs(), initDoxygen(), and writeDotDirDepGraph().

◆ dotFileNameLinkedMap

FileNameLinkedMap * Doxygen::dotFileNameLinkedMap = 0
static

◆ entryDBFileName

QCString Doxygen::entryDBFileName
static

Definition at line 134 of file doxygen.h.

Referenced by exitDoxygen(), main(), parseInput(), and stopDoxygen().

◆ exampleNameLinkedMap

FileNameLinkedMap * Doxygen::exampleNameLinkedMap = 0
static

◆ exampleSDict

◆ expandAsDefinedDict

QDict< void > Doxygen::expandAsDefinedDict
static

Definition at line 117 of file doxygen.h.

Referenced by adjustConfiguration(), and statistics().

◆ filterDBFileName

QCString Doxygen::filterDBFileName
static

◆ functionNameLinkedMap

◆ generatingXmlOutput

bool Doxygen::generatingXmlOutput = FALSE
static

◆ genericsDict

GenericsSDict * Doxygen::genericsDict
static

◆ globalScope

NamespaceDef * Doxygen::globalScope = 0
static

◆ groupSDict

◆ hiddenClasses

◆ htmlDirMap

QDict< int > * Doxygen::htmlDirMap = 0
static

Definition at line 126 of file doxygen.h.

Referenced by convertNameToFile().

◆ htmlFileExtension

QCString Doxygen::htmlFileExtension
static

Definition at line 119 of file doxygen.h.

Referenced by DocSets::addContentsItem(), EclipseHelp::addContentsItem(), HtmlHelp::addContentsItem(), addHtmlExtensionIfMissing(), DotGroupCollaboration::addMemberList(), addRelatedPage(), TooltipManager::addTooltip(), adjustConfiguration(), DotGroupCollaboration::buildGraph(), MemberContext::Private::callerGraph(), MemberContext::Private::callGraph(), ClassContext::Private::collaborationDiagram(), convertMapFile(), HtmlHelp::createProjectFile(), DirContext::Private::dirGraph(), dumpSymbol(), HtmlGenerator::endDotGraph(), field2URL(), generateJSNavTree(), FTVHelp::generateTree(), InheritanceGraphContext::Private::graph(), ModuleContext::Private::groupGraph(), FileContext::Private::includedByGraph(), FileContext::Private::includeGraph(), ClassContext::Private::inheritanceDiagram(), Qhp::initialize(), DocSets::initialize(), EclipseHelp::initialize(), makeFileName(), DefinitionImpl::navigationPathAsString(), renderMemberIndicesAsJs(), replaceRef(), SearchIndexExternal::setCurrentDoc(), stripExtension(), stripKnownExtensions(), LayoutNavEntry::url(), DotNode::writeBox(), writeClassMemberIndexFiltered(), writeClassToDot(), writeColumn(), writeDefaultQuickLinks(), writeDotDirDepGraph(), HtmlGenerator::writeExternalSearchPage(), writeFileMemberIndexFiltered(), TextGeneratorHtml::writeLink(), writeMapArea(), writeNamespaceMemberIndexFiltered(), writeQuickMemberIndex(), NamespaceDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), ClassDefImpl::writeQuickMemberLinks(), writeServerSearchBox(), DirDefImpl::writeTagFile(), NamespaceDefImpl::writeTagFile(), PageDefImpl::writeTagFile(), GroupDefImpl::writeTagFile(), FileDefImpl::writeTagFile(), VhdlDocGen::writeTagFile(), ClassDefImpl::writeTagFile(), MemberDefImpl::writeTagFile(), and DocSets::writeToken().

◆ imageNameLinkedMap

◆ includeNameLinkedMap

FileNameLinkedMap * Doxygen::includeNameLinkedMap = 0
static

◆ indexList

IndexList * Doxygen::indexList
static

Definition at line 137 of file doxygen.h.

Referenced by MemberDefImpl::_writeEnumValues(), addMembersToIndex(), DefinitionImpl::addSectionsToIndex(), cleanUpDoxygen(), copyExtraFiles(), copyLogo(), findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), PlantumlManager::generatePlantUMLOutput(), initDoxygen(), HtmlGenerator::startFile(), HtmlDocVisitor::visit(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), writeClassHierarchy(), writeClassMemberIndex(), writeClassMemberIndexFiltered(), writeClassTree(), writeClassTreeForList(), writeColoredImgData(), MemberDefImpl::writeDeclaration(), writeDirHierarchy(), writeDirTreeNode(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), writeDotGraphFromFile(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeFileMemberIndexFiltered(), DotGraph::writeGraph(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDiagram::writeImage(), writeIndex(), writeIndexHierarchyEntries(), writeJavaScriptSearchIndex(), writeMscGraphFromFile(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTree(), writePages(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeStyleInfo(), and HtmlGenerator::writeTabData().

◆ inputNameLinkedMap

◆ inputPaths

QDict< void > Doxygen::inputPaths
static

Definition at line 102 of file doxygen.h.

Referenced by searchInputFiles().

◆ insideMainPage

bool Doxygen::insideMainPage = FALSE
static

Definition at line 99 of file doxygen.h.

Referenced by generatePageDocs(), getSectionName(), and writeIndex().

◆ lookupCache

QCache< LookupInfo > * Doxygen::lookupCache
static

◆ mainPage

◆ markdownSupport

◆ memberNameLinkedMap

◆ memGrpInfoDict

◆ mscFileNameLinkedMap

FileNameLinkedMap * Doxygen::mscFileNameLinkedMap = 0
static

◆ namespaceAliasDict

StringDict Doxygen::namespaceAliasDict
static

◆ namespaceSDict

◆ objDBFileName

QCString Doxygen::objDBFileName
static

Definition at line 133 of file doxygen.h.

Referenced by exitDoxygen(), generateOutput(), main(), parseInput(), and stopDoxygen().

◆ outputToWizard

bool Doxygen::outputToWizard =FALSE
static

Definition at line 125 of file doxygen.h.

Referenced by readConfiguration().

◆ pageSDict

◆ parserManager

◆ parseSourcesNeeded

◆ preprocessor

Preprocessor * Doxygen::preprocessor = 0
static

Definition at line 143 of file doxygen.h.

Referenced by adjustConfiguration(), cleanUpDoxygen(), initDoxygen(), and parseFile().

◆ runningTime

QTime Doxygen::runningTime
static

Definition at line 121 of file doxygen.h.

Referenced by generateOutput(), initDoxygen(), and msg().

◆ searchIndex

◆ spaces

QCString Doxygen::spaces
static

◆ subpageNestingLevel

int Doxygen::subpageNestingLevel = 0
static

◆ suppressDocWarnings

◆ symbolMap

◆ symbolStorage

Store* Doxygen::symbolStorage
static

Definition at line 132 of file doxygen.h.

◆ tagDestinationDict

StringDict Doxygen::tagDestinationDict
static

◆ tagfileList

QStrList Doxygen::tagfileList
static

Definition at line 110 of file doxygen.h.

◆ userComments

bool Doxygen::userComments = FALSE
static

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