Doxygen
Doxygen类 参考

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

#include <doxygen.h>

+ Doxygen 的协作图:

静态 Public 属性

static ClassLinkedMapclassLinkedMap = 0
 
static ClassLinkedMaphiddenClassLinkedMap = 0
 
static ConceptLinkedMapconceptLinkedMap = 0
 
static PageLinkedMapexampleLinkedMap = 0
 
static PageLinkedMappageLinkedMap = 0
 
static std::unique_ptr< PageDefmainPage
 
static bool insideMainPage = FALSE
 
static FileNameLinkedMapincludeNameLinkedMap = 0
 
static FileNameLinkedMapexampleNameLinkedMap = 0
 
static StringSet inputPaths
 
static FileNameLinkedMapinputNameLinkedMap = 0
 
static FileNameLinkedMapimageNameLinkedMap = 0
 
static FileNameLinkedMapdotFileNameLinkedMap = 0
 
static FileNameLinkedMapmscFileNameLinkedMap = 0
 
static FileNameLinkedMapdiaFileNameLinkedMap = 0
 
static MemberNameLinkedMapmemberNameLinkedMap = 0
 
static MemberNameLinkedMapfunctionNameLinkedMap = 0
 
static StringUnorderedMap namespaceAliasMap
 
static GroupLinkedMapgroupLinkedMap = 0
 
static NamespaceLinkedMapnamespaceLinkedMap = 0
 
static StringMap tagDestinationMap
 
static StringMap aliasMap
 
static MemberGroupInfoMap memberGroupInfoMap
 
static StringUnorderedSet expandAsDefinedSet
 
static NamespaceDefMutableglobalScope = 0
 
static QCString htmlFileExtension
 
static bool parseSourcesNeeded = FALSE
 
static SearchIndexIntfsearchIndex =0
 
static SymbolMap< Definition > * symbolMap
 
static ClangUsrMapclangUsrMap = 0
 
static Cache< std::string, LookupInfo > * lookupCache
 
static DirLinkedMapdirLinkedMap
 
static DirRelationLinkedMap dirRelations
 
static ParserManagerparserManager = 0
 
static bool suppressDocWarnings = FALSE
 
static QCString filterDBFileName
 
static IndexListindexList
 
static int subpageNestingLevel = 0
 
static QCString spaces
 
static bool generatingXmlOutput = FALSE
 
static DefinesPerFileList macroDefinitions
 
static bool clangAssistedParsing = FALSE
 

详细描述

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.

在文件 doxygen.h75 行定义.

类成员变量说明

◆ aliasMap

StringMap Doxygen::aliasMap
static

在文件 doxygen.h99 行定义.

被这些函数引用 escapeAliases(), expandAliases(), expandAliasRec() , 以及 readAliases().

◆ clangAssistedParsing

bool Doxygen::clangAssistedParsing = FALSE
static

◆ clangUsrMap

ClangUsrMap * Doxygen::clangUsrMap = 0
static

在文件 doxygen.h107 行定义.

被这些函数引用 generateOutput(), initDoxygen() , 以及 DefinitionImpl::setId().

◆ classLinkedMap

ClassLinkedMap * Doxygen::classLinkedMap = 0
static

在文件 doxygen.h78 行定义.

被这些函数引用 addClassToContext(), addListReferences(), addMembersToMemberGroup(), addSourceReferences(), addToIndices(), buildCompleteMemberLists(), ClassListContext::ClassListContext(), clearAll(), computeMemberReferences(), VhdlDocGen::computeVhdlComponentRelations(), countAnnotatedClasses(), countClassHierarchy(), countMembers(), ClassIndexContext::Private::createClasses(), createJavaScriptSearchIndex(), createTagLessInstance(), createTemplateInstanceMembers(), distributeClassGroupRelations(), distributeMemberGroupDocumentation(), DotGfxHierarchyTable::DotGfxHierarchyTable(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), DocbookGenerator::endIndexSection(), VhdlDocGen::findAllArchitectures(), VhdlDocGen::findArchitecture(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), findSectionsInDocumentation(), findTagLessClasses(), VhdlDocGen::findVhdlClass(), generateClassDocs(), generateDEF(), PerlModGenerator::generatePerlModOutput(), generateXML(), VhdlDocGen::getClass(), getClass(), initDoxygen(), ClassDefImpl::insertTemplateInstance(), mergeCategories(), parseInput(), ClassHierarchyContext::Private::Private(), ClassTreeContext::Private::Private(), resolveClassNestingRelations(), setAnonymousEnumType(), sortMemberLists(), RTFGenerator::startIndexSection(), LatexGenerator::startIndexSection(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeAnnotatedIndexGeneric(), writeClassHierarchy(), VhdlDocGen::writeOverview() , 以及 writeTagFile().

◆ conceptLinkedMap

◆ diaFileNameLinkedMap

FileNameLinkedMap * Doxygen::diaFileNameLinkedMap = 0
static

◆ dirLinkedMap

◆ dirRelations

DirRelationLinkedMap Doxygen::dirRelations
static

在文件 doxygen.h110 行定义.

被这些函数引用 generateDirDocs().

◆ dotFileNameLinkedMap

FileNameLinkedMap * Doxygen::dotFileNameLinkedMap = 0
static

◆ exampleLinkedMap

◆ exampleNameLinkedMap

FileNameLinkedMap * Doxygen::exampleNameLinkedMap = 0
static

◆ expandAsDefinedSet

StringUnorderedSet Doxygen::expandAsDefinedSet
static

在文件 doxygen.h101 行定义.

被这些函数引用 adjustConfiguration().

◆ filterDBFileName

QCString Doxygen::filterDBFileName
static

在文件 doxygen.h113 行定义.

被这些函数引用 exitDoxygen(), generateOutput(), FilterCache::getFileContents(), parseInput() , 以及 stopDoxygen().

◆ functionNameLinkedMap

◆ generatingXmlOutput

bool Doxygen::generatingXmlOutput = FALSE
static

在文件 doxygen.h117 行定义.

被这些函数引用 ClassDefImpl::anchor(), generateOutput() , 以及 ClassDefImpl::getOutputFileBase().

◆ globalScope

NamespaceDefMutable * Doxygen::globalScope = 0
static

在文件 doxygen.h102 行定义.

被这些函数引用 NestingContext::Private::addClass(), NestingContext::Private::addConcept(), addConceptToContext(), NestingContext::Private::addDirs(), MemberDefImpl::addListReference(), NestingContext::Private::addNamespace(), addPageToContext(), adjustConfiguration(), buildNamespaceList(), buildScopeFromQualifiedName(), cleanUpDoxygen(), ConceptContext::Private::createInitializerAsCode(), DefinitionContext< FileContext::Private >::createNavigationPath(), SymbolContext::Private::createScope(), createTagLessInstance(), dumpSymbol(), DefinitionContext< FileContext::Private >::fillPath(), findClassRelation(), findGlobalMember(), findGroupScope(), findMembersWithSpecificName(), findScopeFromQualifiedName(), generateClassList(), generateConceptDocs(), getDefs(), getMemberFromSymbol(), ClassDefImpl::getOutputFileBase(), getResolvedConcept(), SymbolResolver::Private::getResolvedSymbol(), DocPara::handleCommand(), DocPara::handleInheritDoc(), DefinitionImpl::IMPL::init(), initDoxygen(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), ClassDefImpl::isEmbeddedInOuterScope(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment(), SymbolResolver::resolveClass(), resolveClassNestingRelations(), resolveRef(), validatingParseDoc(), writeClassTree(), writeClassTreeInsideNamespaceElement(), writeConceptRootList(), writeConceptTreeInsideNamespaceElement(), ConceptDefImpl::writeDefinition(), writeDirHierarchy(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentation(), writeJavaScriptSearchIndex(), ClassDefImpl::writeMemberList(), writeMemberToIndex() , 以及 writeNamespaceTreeElement().

◆ groupLinkedMap

◆ hiddenClassLinkedMap

◆ htmlFileExtension

◆ imageNameLinkedMap

◆ includeNameLinkedMap

FileNameLinkedMap * Doxygen::includeNameLinkedMap = 0
static

在文件 doxygen.h85 行定义.

被这些函数引用 adjustConfiguration(), cleanUpDoxygen(), clearAll(), initDoxygen() , 以及 searchInputFiles().

◆ indexList

IndexList * Doxygen::indexList
static

在文件 doxygen.h114 行定义.

被这些函数引用 addMembersToIndex(), DefinitionImpl::addSectionsToIndex(), addToIndices(), cleanUpDoxygen(), copyExtraFiles(), copyLogo(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), PlantumlManager::generatePlantUMLOutput(), initDoxygen(), parseInput(), HtmlGenerator::startFile(), HtmlDocVisitor::visit(), 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(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDiagram::writeImage(), writeIndex(), writeIndexHierarchyEntries(), writeJavaScriptSearchIndex(), writeMemberToIndex(), writeMscGraphFromFile(), writeNamespaceIndex(), writeNamespaceMemberIndex(), writeNamespaceMemberIndexFiltered(), writeNamespaceTreeElement(), writePages(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeStyleInfo() , 以及 HtmlGenerator::writeTabData().

◆ inputNameLinkedMap

◆ inputPaths

StringSet Doxygen::inputPaths
static

在文件 doxygen.h87 行定义.

被这些函数引用 searchInputFiles().

◆ insideMainPage

bool Doxygen::insideMainPage = FALSE
static

在文件 doxygen.h84 行定义.

被这些函数引用 generatePageDocs(), getSectionName() , 以及 writeIndex().

◆ lookupCache

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

◆ macroDefinitions

DefinesPerFileList Doxygen::macroDefinitions
static

在文件 doxygen.h118 行定义.

被这些函数引用 buildDefineList().

◆ mainPage

◆ memberGroupInfoMap

◆ memberNameLinkedMap

◆ mscFileNameLinkedMap

FileNameLinkedMap * Doxygen::mscFileNameLinkedMap = 0
static

◆ namespaceAliasMap

StringUnorderedMap Doxygen::namespaceAliasMap
static

在文件 doxygen.h95 行定义.

被这些函数引用 findClassRelation(), getResolvedNamespace() , 以及 replaceNamespaceAliases().

◆ namespaceLinkedMap

◆ pageLinkedMap

◆ parserManager

◆ parseSourcesNeeded

◆ searchIndex

◆ spaces

QCString Doxygen::spaces
static

◆ subpageNestingLevel

int Doxygen::subpageNestingLevel = 0
static

◆ suppressDocWarnings

◆ symbolMap

◆ tagDestinationMap

StringMap Doxygen::tagDestinationMap
static

在文件 doxygen.h98 行定义.

被这些函数引用 clearAll(), externalRef(), DefinitionImpl::externalReference() , 以及 readTagFile().


该类的文档由以下文件生成: