Doxygen
Loading...
Searching...
No Matches
Doxygen Class Reference

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

#include <src/doxygen.h>

Collaboration diagram for Doxygen:

Static Public Attributes

static ClassLinkedMapclassLinkedMap = nullptr
static ClassLinkedMaphiddenClassLinkedMap = nullptr
static ConceptLinkedMapconceptLinkedMap = nullptr
static PageLinkedMapexampleLinkedMap = nullptr
static PageLinkedMappageLinkedMap = nullptr
static std::unique_ptr< PageDefmainPage
static FileNameLinkedMapincludeNameLinkedMap = nullptr
static FileNameLinkedMapexampleNameLinkedMap = nullptr
static StringUnorderedSet inputPaths
static FileNameLinkedMapinputNameLinkedMap = nullptr
static FileNameLinkedMapimageNameLinkedMap = nullptr
static FileNameLinkedMapdotFileNameLinkedMap = nullptr
static FileNameLinkedMapmscFileNameLinkedMap = nullptr
static FileNameLinkedMapdiaFileNameLinkedMap = nullptr
static FileNameLinkedMapplantUmlFileNameLinkedMap = nullptr
static MemberNameLinkedMapmemberNameLinkedMap = nullptr
static MemberNameLinkedMapfunctionNameLinkedMap = nullptr
static NamespaceAliasInfoMap namespaceAliasMap
static GroupLinkedMapgroupLinkedMap = nullptr
static NamespaceLinkedMapnamespaceLinkedMap = nullptr
static StringMap tagDestinationMap
static StringUnorderedSet tagFileSet
static MemberGroupInfoMap memberGroupInfoMap
static StringUnorderedSet expandAsDefinedSet
static std::unique_ptr< NamespaceDefglobalNamespaceDef
static NamespaceDefMutableglobalScope
static QCString htmlFileExtension
static bool parseSourcesNeeded = FALSE
static SearchIndexIntf searchIndex
static SymbolMap< Definition > * symbolMap
static ClangUsrMapclangUsrMap = nullptr
static Cache< std::string, LookupInfo > * typeLookupCache
static Cache< std::string, LookupInfo > * symbolLookupCache
static DirLinkedMapdirLinkedMap
static DirRelationLinkedMap dirRelations
static ParserManagerparserManager = nullptr
static bool suppressDocWarnings = FALSE
static QCString filterDBFileName
static IndexListindexList
static QCString spaces
static bool generatingXmlOutput = FALSE
static DefinesPerFileList macroDefinitions
static bool clangAssistedParsing = FALSE
static QCString verifiedDotPath
static InputFileEncodingList inputFileEncodingList
static std::mutex countFlowKeywordsMutex
static std::mutex addExampleMutex
static StaticInitMap staticInitMap

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

Member Data Documentation

◆ addExampleMutex

std::mutex Doxygen::addExampleMutex
static

Definition at line 142 of file doxygen.h.

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

ClassLinkedMap * Doxygen::classLinkedMap = nullptr
static

◆ conceptLinkedMap

◆ countFlowKeywordsMutex

std::mutex Doxygen::countFlowKeywordsMutex
static

Definition at line 141 of file doxygen.h.

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

◆ 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

◆ globalNamespaceDef

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

Definition at line 120 of file doxygen.h.

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 files: