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 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 StringUnorderedSet inputPaths
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 FileNameLinkedMap * mermaidFileNameLinkedMap = nullptr
static MemberNameLinkedMap * memberNameLinkedMap = nullptr
static MemberNameLinkedMap * functionNameLinkedMap = nullptr
static NamespaceAliasInfoMap namespaceAliasMap
static GroupLinkedMap * groupLinkedMap = nullptr
static NamespaceLinkedMap * namespaceLinkedMap = nullptr
static StringMap tagDestinationMap
static StringUnorderedSet tagFileSet
static MemberGroupInfoMap memberGroupInfoMap
static StringUnorderedSet expandAsDefinedSet
static std::unique_ptr< NamespaceDef > globalNamespaceDef
static NamespaceDefMutable * globalScope
static DString htmlFileExtension
static bool parseSourcesNeeded = false
static SearchIndexIntf searchIndex
static SymbolMap< Definition > * symbolMap
static ClangUsrMap * clangUsrMap = nullptr
static DirLinkedMap * dirLinkedMap
static DirRelationLinkedMap dirRelations
static ParserManager * parserManager = nullptr
static bool suppressDocWarnings = false
static DString filterDBFileName
static IndexList * indexList
static DString spaces
static bool generatingXmlOutput = false
static DefinesPerFileList macroDefinitions
static bool clangAssistedParsing = false
static DString 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 85 of file doxygen.h.

Member Data Documentation

◆ addExampleMutex

std::mutex Doxygen::addExampleMutex
static

Definition at line 133 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 119 of file doxygen.h.

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

◆ classLinkedMap

ClassLinkedMap * Doxygen::classLinkedMap = nullptr
static

◆ conceptLinkedMap

◆ countFlowKeywordsMutex

std::mutex Doxygen::countFlowKeywordsMutex
static

Definition at line 132 of file doxygen.h.

Referenced by incrementFlowKeyWordCount(), and incrementFlowKeyWordCount().

◆ diaFileNameLinkedMap

FileNameLinkedMap * Doxygen::diaFileNameLinkedMap = nullptr
static

◆ dirLinkedMap

◆ dirRelations

DirRelationLinkedMap Doxygen::dirRelations
static

Definition at line 121 of file doxygen.h.

Referenced by generateDirDocs().

◆ dotFileNameLinkedMap

FileNameLinkedMap * Doxygen::dotFileNameLinkedMap = nullptr
static

◆ exampleLinkedMap

◆ exampleNameLinkedMap

◆ expandAsDefinedSet

StringUnorderedSet Doxygen::expandAsDefinedSet
static

Definition at line 112 of file doxygen.h.

Referenced by addDefine(), and adjustConfiguration().

◆ filterDBFileName

DString Doxygen::filterDBFileName
static

◆ functionNameLinkedMap

◆ generatingXmlOutput

bool Doxygen::generatingXmlOutput = false
static

◆ globalNamespaceDef

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

Definition at line 113 of file doxygen.h.

Referenced by adjustConfiguration(), and cleanUpDoxygen().

◆ globalScope

NamespaceDefMutable * Doxygen::globalScope
static

Definition at line 114 of file doxygen.h.

Referenced by addConceptToContext(), MemberDefImpl::addListReference(), addPageToContext(), addVariable(), adjustConfiguration(), buildFunctionList(), buildNamespaceList(), buildScopeFromQualifiedName(), cleanUpDoxygen(), createTagLessInstance(), dumpSymbol(), findClassRelation(), findGlobalMember(), findGroupScope(), findMember(), findScopeFromQualifiedName(), findTagLessClasses(), SymbolResolver::Private::followPath(), generateClassMemberLink(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), generateConceptDocs(), generateDocsForClassList(), getDefs(), 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(), processTagLessClasses(), SymbolResolver::resolveClass(), resolveClassNestingRelations(), resolveRef(), SymbolResolver::resolveSymbol(), resolveTemplateInstanceInType(), resolveTypeDef(), startCodeLine(), validatingParseDoc(), writeClassTree(), writeClassTreeInsideNamespaceElement(), 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

◆ inputFileEncodingList

InputFileEncodingList Doxygen::inputFileEncodingList
static

Definition at line 131 of file doxygen.h.

Referenced by adjustConfiguration(), and getEncoding().

◆ inputNameLinkedMap

◆ inputPaths

StringUnorderedSet Doxygen::inputPaths
static

Definition at line 96 of file doxygen.h.

Referenced by searchInputFiles().

◆ macroDefinitions

DefinesPerFileList Doxygen::macroDefinitions
static

Definition at line 128 of file doxygen.h.

Referenced by buildDefineList(), and Preprocessor::processFile().

◆ mainPage

◆ memberGroupInfoMap

MemberGroupInfoMap Doxygen::memberGroupInfoMap
static

◆ memberNameLinkedMap

◆ mermaidFileNameLinkedMap

FileNameLinkedMap * Doxygen::mermaidFileNameLinkedMap = nullptr
static

◆ mscFileNameLinkedMap

FileNameLinkedMap * Doxygen::mscFileNameLinkedMap = nullptr
static

◆ namespaceAliasMap

NamespaceAliasInfoMap Doxygen::namespaceAliasMap
static

Definition at line 106 of file doxygen.h.

Referenced by findClassRelation(), and replaceNamespaceAliasesRec().

◆ namespaceLinkedMap

◆ pageLinkedMap

◆ parserManager

◆ parseSourcesNeeded

◆ plantUmlFileNameLinkedMap

FileNameLinkedMap * Doxygen::plantUmlFileNameLinkedMap = nullptr
static

◆ searchIndex

◆ spaces

DString Doxygen::spaces
static

Definition at line 126 of file doxygen.h.

Referenced by adjustConfiguration().

◆ staticInitMap

StaticInitMap Doxygen::staticInitMap
static

Definition at line 134 of file doxygen.h.

Referenced by addVariable(), and transferStaticInstanceInitializers().

◆ suppressDocWarnings

◆ symbolMap

◆ tagDestinationMap

StringMap Doxygen::tagDestinationMap
static

Definition at line 109 of file doxygen.h.

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

◆ tagFileSet

StringUnorderedSet Doxygen::tagFileSet
static

Definition at line 110 of file doxygen.h.

Referenced by readTagFile().

◆ verifiedDotPath

DString Doxygen::verifiedDotPath
static

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