Skip to main content

The Doxygen Class Reference

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

Declaration

class Doxygen { ... }

Included Headers

#include <src/doxygen.h>

Public Static Attributes Index

static ClassLinkedMap *classLinkedMap = nullptr
static ClassLinkedMap *hiddenClassLinkedMap = nullptr
static ConceptLinkedMap *conceptLinkedMap = nullptr
static PageLinkedMap *exampleLinkedMap = nullptr
static PageLinkedMap *pageLinkedMap = nullptr
static std::unique_ptr< PageDef >mainPage
static FileNameLinkedMap *includeNameLinkedMap = nullptr
static FileNameLinkedMap *exampleNameLinkedMap = nullptr
static StringUnorderedSetinputPaths
static FileNameLinkedMap *inputNameLinkedMap = nullptr
static FileNameLinkedMap *imageNameLinkedMap = nullptr
static FileNameLinkedMap *dotFileNameLinkedMap = nullptr
static FileNameLinkedMap *mscFileNameLinkedMap = nullptr
static FileNameLinkedMap *diaFileNameLinkedMap = nullptr
static FileNameLinkedMap *plantUmlFileNameLinkedMap = nullptr
static MemberNameLinkedMap *memberNameLinkedMap = nullptr
static MemberNameLinkedMap *functionNameLinkedMap = nullptr
static NamespaceAliasInfoMapnamespaceAliasMap
static GroupLinkedMap *groupLinkedMap = nullptr
static NamespaceLinkedMap *namespaceLinkedMap = nullptr
static StringMaptagDestinationMap
static StringUnorderedSettagFileSet
static MemberGroupInfoMapmemberGroupInfoMap
static StringUnorderedSetexpandAsDefinedSet
static std::unique_ptr< NamespaceDef >globalNamespaceDef
static NamespaceDefMutable *globalScope
static QCStringhtmlFileExtension
static boolparseSourcesNeeded = FALSE
static SearchIndexIntfsearchIndex
static SymbolMap< Definition > *symbolMap
static ClangUsrMap *clangUsrMap = nullptr
static Cache< std::string, LookupInfo > *typeLookupCache
static Cache< std::string, LookupInfo > *symbolLookupCache
static DirLinkedMap *dirLinkedMap
static DirRelationLinkedMapdirRelations
static ParserManager *parserManager = nullptr
static boolsuppressDocWarnings = FALSE
static QCStringfilterDBFileName
static IndexList *indexList
static QCStringspaces
static boolgeneratingXmlOutput = FALSE
static DefinesPerFileListmacroDefinitions
static boolclangAssistedParsing = FALSE
static QCStringverifiedDotPath
static InputFileEncodingListinputFileEncodingList
static std::mutexcountFlowKeywordsMutex
static std::mutexaddExampleMutex
static StaticInitMapstaticInitMap

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 93 of file doxygen.h.

Public Static Attributes

addExampleMutex

std::mutex Doxygen::addExampleMutex
static

Definition at line 142 of file doxygen.h.

142 static std::mutex addExampleMutex;

Referenced by generateClassMemberLink, generateClassOrGlobalLink and getLinkInScope.

clangAssistedParsing

bool Doxygen::clangAssistedParsing = FALSE
static

clangUsrMap

ClangUsrMap * Doxygen::clangUsrMap = nullptr
static

Definition at line 126 of file doxygen.h.

Referenced by generateOutput, initDoxygen and DefinitionImpl::setId.

classLinkedMap

conceptLinkedMap

countFlowKeywordsMutex

std::mutex Doxygen::countFlowKeywordsMutex
static

Definition at line 141 of file doxygen.h.

141 static std::mutex countFlowKeywordsMutex;

Referenced by incrementFlowKeyWordCount and incrementFlowKeyWordCount.

diaFileNameLinkedMap

FileNameLinkedMap * Doxygen::diaFileNameLinkedMap = nullptr
static

dirLinkedMap

dirRelations

DirRelationLinkedMap Doxygen::dirRelations
static

Definition at line 130 of file doxygen.h.

Referenced by generateDirDocs.

dotFileNameLinkedMap

FileNameLinkedMap * Doxygen::dotFileNameLinkedMap = nullptr
static

exampleLinkedMap

exampleNameLinkedMap

FileNameLinkedMap * Doxygen::exampleNameLinkedMap = nullptr
static

expandAsDefinedSet

StringUnorderedSet Doxygen::expandAsDefinedSet
static

Definition at line 119 of file doxygen.h.

Referenced by addDefine and adjustConfiguration.

filterDBFileName

QCString Doxygen::filterDBFileName
static

functionNameLinkedMap

generatingXmlOutput

bool Doxygen::generatingXmlOutput = FALSE
static

Definition at line 136 of file doxygen.h.

Referenced by ClassDefImpl::anchor, generateOutput and ClassDefImpl::getOutputFileBase.

globalNamespaceDef

std::unique_ptr< NamespaceDef > Doxygen::globalNamespaceDef
static

Definition at line 120 of file doxygen.h.

120 static std::unique_ptr<NamespaceDef> globalNamespaceDef;

Referenced by adjustConfiguration and cleanUpDoxygen.

globalScope

NamespaceDefMutable * Doxygen::globalScope
static

Definition at line 121 of file doxygen.h.

Referenced by addConceptToContext, MemberDefImpl::addListReference, addPageToContext, adjustConfiguration, buildFunctionList, buildNamespaceList, buildScopeFromQualifiedName, cleanUpDoxygen, createTagLessInstance, dumpSymbol, findClassRelation, findGlobalMember, findGroupScope, findMember, findMembersWithSpecificName, findScopeFromQualifiedName, SymbolResolver::Private::followPath, generateClassMemberLink, generateClassOrGlobalLink, generateClassOrGlobalLink, generateConceptDocs, generateDocsForClassList, getDefsNew, getDefsOld, getLink, getLinkInScope, getLinkInScope, getMemberFromSymbol, ClassDefImpl::getOutputFileBase, getResolvedConcept, SymbolResolver::Private::getResolvedSymbol, SymbolResolver::Private::getResolvedSymbolRec, SymbolResolver::Private::getResolvedType, SymbolResolver::Private::getResolvedTypeRec, DocPara::handleCommand, DocPara::handleInheritDoc, DefinitionImpl::Private::init, initDoxygen, NamespaceDefImpl::insertMember, insertMemberAlias, SymbolResolver::Private::isAccessibleFrom, SymbolResolver::Private::isAccessibleFromWithExpScope, ClassDefImpl::isEmbeddedInOuterScope, DefinitionImpl::navigationPathAsString, DefinitionImpl::pathFragment, SymbolResolver::resolveClass, resolveClassNestingRelations, resolveRef, SymbolResolver::resolveSymbol, resolveTemplateInstanceInType, resolveTypeDef, startCodeLine, validatingParseDoc, writeClassTree, writeClassTreeInsideNamespaceElement, writeConceptRootList, writeConceptTreeInsideNamespaceElement, writeDefArgumentList, ConceptDefImpl::writeDefinition, writeDirHierarchy, ClassDefImpl::writeDocumentation, ConceptDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, PageDefImpl::writeDocumentation, writeJavasScriptSearchDataPage, ClassDefImpl::writeMemberList, writeMemberToIndex, writeNamespaceTreeElement and writeObjCMethodCall.

groupLinkedMap

hiddenClassLinkedMap

htmlFileExtension

imageNameLinkedMap

includeNameLinkedMap

FileNameLinkedMap * Doxygen::includeNameLinkedMap = nullptr
static

indexList

IndexList * Doxygen::indexList
static

Definition at line 134 of file doxygen.h.

Referenced by addMembersToIndex, PageDefImpl::addSectionsToIndex, addToIndices, cleanUpDoxygen, copyExtraFiles, copyIcon, copyLogo, FormulaManager::createLatexFile, DocParser::findAndCopyImage, generateOutput, PlantumlManager::generatePlantUMLOutput, initDoxygen, HtmlDocVisitor::operator(), parseInput, HtmlGenerator::startFile, writeAlphabeticalExceptionIndex, writeAlphabeticalIndex, writeAlphabeticalInterfaceIndex, writeAlphabeticalStructIndex, writeAnnotatedIndexGeneric, writeClassHierarchy, writeClassMemberIndex, writeClassMemberIndexFiltered, writeClassTreeForList, writeClassTreeInsideNamespaceElement, writeClassTreeToOutput, writeColoredImgData, writeConceptIndex, writeConceptList, writeConceptRootList, writeConceptTreeInsideNamespaceElement, writeDirHierarchy, writeDirTreeNode, writeDotGraphFromFile, writeExampleIndex, writeFileIndex, writeFileMemberIndex, writeFileMemberIndexFiltered, DotGraph::writeGraph, writeGroupTreeNode, writeHierarchicalExceptionIndex, writeHierarchicalIndex, writeHierarchicalInterfaceIndex, ClassDiagram::writeImage, writeIndex, writeIndexHierarchyEntries, writeJavaScriptSearchIndex, writeJavasScriptSearchDataPage, writeMemberToIndex, writeModuleIndex, writeModuleMemberIndex, writeModuleMemberIndexFiltered, writeModuleTreeNode, writeMscGraphFromFile, writeNamespaceIndex, writeNamespaceMemberIndex, writeNamespaceMemberIndexFiltered, writeNamespaceTreeElement, writePages, HtmlGenerator::writeSearchData, HtmlGenerator::writeStyleInfo, HtmlGenerator::writeTabData and writeTopicIndex.

inputFileEncodingList

InputFileEncodingList Doxygen::inputFileEncodingList
static

Definition at line 140 of file doxygen.h.

Referenced by adjustConfiguration and getEncoding.

inputNameLinkedMap

inputPaths

StringUnorderedSet Doxygen::inputPaths
static

Definition at line 104 of file doxygen.h.

Referenced by searchInputFiles.

macroDefinitions

DefinesPerFileList Doxygen::macroDefinitions
static

Definition at line 137 of file doxygen.h.

Referenced by buildDefineList and Preprocessor::processFile.

mainPage

memberGroupInfoMap

MemberGroupInfoMap Doxygen::memberGroupInfoMap
static

memberNameLinkedMap

mscFileNameLinkedMap

FileNameLinkedMap * Doxygen::mscFileNameLinkedMap = nullptr
static

namespaceAliasMap

NamespaceAliasInfoMap Doxygen::namespaceAliasMap
static

Definition at line 113 of file doxygen.h.

Referenced by findClassRelation and replaceNamespaceAliasesRec.

namespaceLinkedMap

pageLinkedMap

parserManager

parseSourcesNeeded

plantUmlFileNameLinkedMap

FileNameLinkedMap * Doxygen::plantUmlFileNameLinkedMap = nullptr
static

searchIndex

spaces

QCString Doxygen::spaces
static

Definition at line 135 of file doxygen.h.

Referenced by adjustConfiguration.

staticInitMap

StaticInitMap Doxygen::staticInitMap
static

Definition at line 143 of file doxygen.h.

Referenced by addVariable and transferStaticInstanceInitializers.

suppressDocWarnings

symbolLookupCache

Cache< std::string, LookupInfo > * Doxygen::symbolLookupCache
static

symbolMap

tagDestinationMap

StringMap Doxygen::tagDestinationMap
static

Definition at line 116 of file doxygen.h.

Referenced by clearAll, externalRef, DefinitionImpl::externalReference and readTagFile.

tagFileSet

StringUnorderedSet Doxygen::tagFileSet
static

Definition at line 117 of file doxygen.h.

Referenced by readTagFile.

typeLookupCache

Cache< std::string, LookupInfo > * Doxygen::typeLookupCache
static

verifiedDotPath

QCString Doxygen::verifiedDotPath
static

Definition at line 139 of file doxygen.h.

Referenced by computeVerifiedDotPath and FlowChart::createSVG.


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


Generated via doxygen2docusaurus by Doxygen 1.14.0.