index.h 文件参考

#include <utility>
#include <vector>
#include <memory>
#include "qcstring.h"

index.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

类
class	IndexIntf
	Abstract interface for index generators. 更多...
class	IndexList
	A list of index interfaces. 更多...

枚举
enum	IndexSections {   isTitlePageStart, isTitlePageAuthor, isMainPage, isModuleIndex,   isDirIndex, isNamespaceIndex, isConceptIndex, isClassHierarchyIndex,   isCompoundIndex, isFileIndex, isPageIndex, isModuleDocumentation,   isDirDocumentation, isNamespaceDocumentation, isClassDocumentation, isConceptDocumentation,   isFileDocumentation, isExampleDocumentation, isPageDocumentation, isPageDocumentation2,   isEndIndex }
enum	HighlightedItem {   HLI_None =0, HLI_Main, HLI_Modules, HLI_Namespaces,   HLI_ClassHierarchy, HLI_InterfaceHierarchy, HLI_ExceptionHierarchy, HLI_Classes,   HLI_Concepts, HLI_Interfaces, HLI_Structs, HLI_Exceptions,   HLI_AnnotatedClasses, HLI_AnnotatedInterfaces, HLI_AnnotatedStructs, HLI_AnnotatedExceptions,   HLI_Files, HLI_NamespaceMembers, HLI_Functions, HLI_Globals,   HLI_Pages, HLI_Examples, HLI_Search, HLI_UserGroup,   HLI_ClassVisible, HLI_ConceptVisible, HLI_InterfaceVisible, HLI_StructVisible,   HLI_ExceptionVisible, HLI_NamespaceVisible, HLI_FileVisible }
enum	ClassMemberHighlight {   CMHL_All = 0, CMHL_Functions, CMHL_Variables, CMHL_Typedefs,   CMHL_Enums, CMHL_EnumValues, CMHL_Properties, CMHL_Events,   CMHL_Related, CMHL_Total = CMHL_Related+1 }
enum	FileMemberHighlight {   FMHL_All = 0, FMHL_Functions, FMHL_Variables, FMHL_Typedefs,   FMHL_Sequences, FMHL_Dictionaries, FMHL_Enums, FMHL_EnumValues,   FMHL_Defines, FMHL_Total = FMHL_Defines+1 }
enum	NamespaceMemberHighlight {   NMHL_All = 0, NMHL_Functions, NMHL_Variables, NMHL_Typedefs,   NMHL_Sequences, NMHL_Dictionaries, NMHL_Enums, NMHL_EnumValues,   NMHL_Total = NMHL_EnumValues+1 }
enum	ClassHighlight {   CHL_All = 0, CHL_Classes, CHL_Structs, CHL_Unions,   CHL_Interfaces, CHL_Protocols, CHL_Categories, CHL_Exceptions,   CHL_Total = CHL_Exceptions+1 }

函数
void	writeGraphInfo (OutputList &ol)
void	writeIndexHierarchy (OutputList &ol)
void	countDataStructures ()
void	startTitle (OutputList &ol, const QCString &fileName, const DefinitionMutable *def=0)
void	endTitle (OutputList &ol, const QCString &fileName, const QCString &name)
void	startFile (OutputList &ol, const QCString &name, const QCString &manName, const QCString &title, HighlightedItem hli=HLI_None, bool additionalIndices=FALSE, const QCString &altSidebarName=QCString())
void	endFile (OutputList &ol, bool skipNavIndex=FALSE, bool skipEndContents=FALSE, const QCString &navPath=QCString())
void	endFileWithNavPath (const Definition *d, OutputList &ol)
void	initClassMemberIndices ()
void	initFileMemberIndices ()
void	initNamespaceMemberIndices ()
void	addClassMemberNameToIndex (const MemberDef *md)
void	addFileMemberNameToIndex (const MemberDef *md)
void	addNamespaceMemberNameToIndex (const MemberDef *md)
void	sortMemberIndexLists ()
QCString	fixSpaces (const QCString &s)
int	countVisibleMembers (const NamespaceDef *nd)

变量
int	annotatedClasses
int	annotatedInterfaces
int	annotatedStructs
int	annotatedExceptions
int	hierarchyClasses
int	hierarchyInterfaces
int	hierarchyExceptions
int	documentedFiles
int	documentedGroups
int	documentedNamespaces
int	documentedConcepts
int	indexedPages
int	documentedClassMembers [CMHL_Total]
int	documentedFileMembers [FMHL_Total]
int	documentedNamespaceMembers [NMHL_Total]
int	documentedDirs
int	documentedPages

枚举类型说明

ClassHighlight

enum ClassHighlight

枚举值
CHL_All
CHL_Classes
CHL_Structs
CHL_Unions
CHL_Interfaces
CHL_Protocols
CHL_Categories
CHL_Exceptions
CHL_Total

在文件 index.h 第 218 行定义.

{
  CHL_All = 0,
  CHL_Classes,
  CHL_Structs,
  CHL_Unions,
  CHL_Interfaces,
  CHL_Protocols,
  CHL_Categories,
  CHL_Exceptions,
  CHL_Total = CHL_Exceptions+1
};

ClassMemberHighlight

enum ClassMemberHighlight

枚举值
CMHL_All
CMHL_Functions
CMHL_Variables
CMHL_Typedefs
CMHL_Enums
CMHL_EnumValues
CMHL_Properties
CMHL_Events
CMHL_Related
CMHL_Total

在文件 index.h 第 177 行定义.

{
  CMHL_All = 0,
  CMHL_Functions,
  CMHL_Variables,
  CMHL_Typedefs,
  CMHL_Enums,
  CMHL_EnumValues,
  CMHL_Properties,
  CMHL_Events,
  CMHL_Related,
  CMHL_Total = CMHL_Related+1
};

FileMemberHighlight

enum FileMemberHighlight

枚举值
FMHL_All
FMHL_Functions
FMHL_Variables
FMHL_Typedefs
FMHL_Sequences
FMHL_Dictionaries
FMHL_Enums
FMHL_EnumValues
FMHL_Defines
FMHL_Total

在文件 index.h 第 191 行定义.

{
  FMHL_All = 0,
  FMHL_Functions,
  FMHL_Variables,
  FMHL_Typedefs,
  FMHL_Sequences,
  FMHL_Dictionaries,
  FMHL_Enums,
  FMHL_EnumValues,
  FMHL_Defines,
  FMHL_Total = FMHL_Defines+1
};

HighlightedItem

enum HighlightedItem

枚举值
HLI_None
HLI_Main
HLI_Modules
HLI_Namespaces
HLI_ClassHierarchy
HLI_InterfaceHierarchy
HLI_ExceptionHierarchy
HLI_Classes
HLI_Concepts
HLI_Interfaces
HLI_Structs
HLI_Exceptions
HLI_AnnotatedClasses
HLI_AnnotatedInterfaces
HLI_AnnotatedStructs
HLI_AnnotatedExceptions
HLI_Files
HLI_NamespaceMembers
HLI_Functions
HLI_Globals
HLI_Pages
HLI_Examples
HLI_Search
HLI_UserGroup
HLI_ClassVisible
HLI_ConceptVisible
HLI_InterfaceVisible
HLI_StructVisible
HLI_ExceptionVisible
HLI_NamespaceVisible
HLI_FileVisible

在文件 index.h 第 140 行定义.

{
  HLI_None=0,
  HLI_Main,
  HLI_Modules,
  //HLI_Directories,
  HLI_Namespaces,
  HLI_ClassHierarchy,
  HLI_InterfaceHierarchy,
  HLI_ExceptionHierarchy,
  HLI_Classes,
  HLI_Concepts,
  HLI_Interfaces,
  HLI_Structs,
  HLI_Exceptions,
  HLI_AnnotatedClasses,
  HLI_AnnotatedInterfaces,
  HLI_AnnotatedStructs,
  HLI_AnnotatedExceptions,
  HLI_Files,
  HLI_NamespaceMembers,
  HLI_Functions,
  HLI_Globals,
  HLI_Pages,
  HLI_Examples,
  HLI_Search,
  HLI_UserGroup,
 
  HLI_ClassVisible,
  HLI_ConceptVisible,
  HLI_InterfaceVisible,
  HLI_StructVisible,
  HLI_ExceptionVisible,
  HLI_NamespaceVisible,
  HLI_FileVisible
};

IndexSections

enum IndexSections

枚举值
isTitlePageStart
isTitlePageAuthor
isMainPage
isModuleIndex
isDirIndex
isNamespaceIndex
isConceptIndex
isClassHierarchyIndex
isCompoundIndex
isFileIndex
isPageIndex
isModuleDocumentation
isDirDocumentation
isNamespaceDocumentation
isClassDocumentation
isConceptDocumentation
isFileDocumentation
isExampleDocumentation
isPageDocumentation
isPageDocumentation2
isEndIndex

在文件 index.h 第 115 行定义.

{
  isTitlePageStart,
  isTitlePageAuthor,
  isMainPage,
  isModuleIndex,
  isDirIndex,
  isNamespaceIndex,
  isConceptIndex,
  isClassHierarchyIndex,
  isCompoundIndex,
  isFileIndex,
  isPageIndex,
  isModuleDocumentation,
  isDirDocumentation,
  isNamespaceDocumentation,
  isClassDocumentation,
  isConceptDocumentation,
  isFileDocumentation,
  isExampleDocumentation,
  isPageDocumentation,
  isPageDocumentation2,
  isEndIndex
};

NamespaceMemberHighlight

enum NamespaceMemberHighlight

枚举值
NMHL_All
NMHL_Functions
NMHL_Variables
NMHL_Typedefs
NMHL_Sequences
NMHL_Dictionaries
NMHL_Enums
NMHL_EnumValues
NMHL_Total

在文件 index.h 第 205 行定义.

{
  NMHL_All = 0,
  NMHL_Functions,
  NMHL_Variables,
  NMHL_Typedefs,
  NMHL_Sequences,
  NMHL_Dictionaries,
  NMHL_Enums,
  NMHL_EnumValues,
  NMHL_Total = NMHL_EnumValues+1
};

函数说明

addClassMemberNameToIndex()

void addClassMemberNameToIndex

(

const MemberDef *

md

)

在文件 index.cpp 第 2659 行定义.

{
  static bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
  const ClassDef *cd=0;
 
  if (md->isLinkableInProject() &&
      (cd=md->getClassDef())    &&
      cd->isLinkableInProject() &&
      cd->templateMaster()==0)
  {
    QCString n = md->name();
    int index = getPrefixIndex(n);
    std::string letter = getUTF8CharAt(n.str(),index);
    if (!letter.empty())
    {
      letter = convertUTF8ToLower(letter);
      bool isFriendToHide = hideFriendCompounds &&
        (QCString(md->typeString())=="friend class" ||
         QCString(md->typeString())=="friend struct" ||
         QCString(md->typeString())=="friend union");
      if (!(md->isFriend() && isFriendToHide) &&
          (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
         )
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_All],letter,md);
        documentedClassMembers[CMHL_All]++;
      }
      if (md->isFunction()  || md->isSlot() || md->isSignal())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Functions],letter,md);
        documentedClassMembers[CMHL_Functions]++;
      }
      else if (md->isVariable())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Variables],letter,md);
        documentedClassMembers[CMHL_Variables]++;
      }
      else if (md->isTypedef())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Typedefs],letter,md);
        documentedClassMembers[CMHL_Typedefs]++;
      }
      else if (md->isEnumerate())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Enums],letter,md);
        documentedClassMembers[CMHL_Enums]++;
      }
      else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_EnumValues],letter,md);
        documentedClassMembers[CMHL_EnumValues]++;
      }
      else if (md->isProperty())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Properties],letter,md);
        documentedClassMembers[CMHL_Properties]++;
      }
      else if (md->isEvent())
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Events],letter,md);
        documentedClassMembers[CMHL_Events]++;
      }
      else if (md->isRelated() || md->isForeign() ||
               (md->isFriend() && !isFriendToHide))
      {
        MemberIndexMap_add(g_classIndexLetterUsed[CMHL_Related],letter,md);
        documentedClassMembers[CMHL_Related]++;
      }
    }
  }
}

引用了 CMHL_All, CMHL_Enums, CMHL_EnumValues, CMHL_Events, CMHL_Functions, CMHL_Properties, CMHL_Related, CMHL_Typedefs, CMHL_Variables, Config_getBool, convertUTF8ToLower(), documentedClassMembers, g_classIndexLetterUsed, MemberDef::getClassDef(), MemberDef::getEnumScope(), getPrefixIndex(), getUTF8CharAt(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isEvent(), MemberDef::isForeign(), MemberDef::isFriend(), MemberDef::isFunction(), MemberDef::isLinkableInProject(), ClassDef::isLinkableInProject(), MemberDef::isProperty(), MemberDef::isRelated(), MemberDef::isSignal(), MemberDef::isSlot(), MemberDef::isStrong(), MemberDef::isTypedef(), MemberDef::isVariable(), MemberIndexMap_add(), Definition::name(), QCString::str(), ClassDef::templateMaster() , 以及 MemberDef::typeString().

被这些函数引用 addMembersToIndex().

addFileMemberNameToIndex()

void addFileMemberNameToIndex

(

const MemberDef *

md

)

在文件 index.cpp 第 2811 行定义.

{
  const FileDef *fd=md->getFileDef();
  if (fd && fd->isLinkableInProject() && md->isLinkableInProject())
  {
    QCString n = md->name();
    int index = getPrefixIndex(n);
    std::string letter = getUTF8CharAt(n.str(),index);
    if (!letter.empty())
    {
      letter = convertUTF8ToLower(letter);
      if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_All],letter,md);
        documentedFileMembers[FMHL_All]++;
      }
 
      if (md->isFunction())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Functions],letter,md);
        documentedFileMembers[FMHL_Functions]++;
      }
      else if (md->isVariable())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Variables],letter,md);
        documentedFileMembers[FMHL_Variables]++;
      }
      else if (md->isTypedef())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Typedefs],letter,md);
        documentedFileMembers[FMHL_Typedefs]++;
      }
      else if (md->isSequence())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Sequences],letter,md);
        documentedFileMembers[FMHL_Sequences]++;
      }
      else if (md->isDictionary())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Dictionaries],letter,md);
        documentedFileMembers[FMHL_Dictionaries]++;
      }
      else if (md->isEnumerate())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Enums],letter,md);
        documentedFileMembers[FMHL_Enums]++;
      }
      else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_EnumValues],letter,md);
        documentedFileMembers[FMHL_EnumValues]++;
      }
      else if (md->isDefine())
      {
        MemberIndexMap_add(g_fileIndexLetterUsed[FMHL_Defines],letter,md);
        documentedFileMembers[FMHL_Defines]++;
      }
    }
  }
}

引用了 convertUTF8ToLower(), documentedFileMembers, FMHL_All, FMHL_Defines, FMHL_Dictionaries, FMHL_Enums, FMHL_EnumValues, FMHL_Functions, FMHL_Sequences, FMHL_Typedefs, FMHL_Variables, g_fileIndexLetterUsed, MemberDef::getEnumScope(), MemberDef::getFileDef(), getPrefixIndex(), getUTF8CharAt(), MemberDef::isDefine(), MemberDef::isDictionary(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isFunction(), FileDef::isLinkableInProject(), MemberDef::isLinkableInProject(), MemberDef::isSequence(), MemberDef::isStrong(), MemberDef::isTypedef(), MemberDef::isVariable(), MemberIndexMap_add(), Definition::name() , 以及 QCString::str().

被这些函数引用 addMembersToIndex().

addNamespaceMemberNameToIndex()

void addNamespaceMemberNameToIndex

(

const MemberDef *

md

)

在文件 index.cpp 第 2743 行定义.

{
  const NamespaceDef *nd=md->getNamespaceDef();
  if (nd && nd->isLinkableInProject() && md->isLinkableInProject())
  {
    QCString n = md->name();
    int index = getPrefixIndex(n);
    std::string letter = getUTF8CharAt(n.str(),index);
    if (!letter.empty())
    {
      letter = convertUTF8ToLower(letter);
      if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_All],letter,md);
        documentedNamespaceMembers[NMHL_All]++;
      }
 
      if (md->isFunction())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_Functions],letter,md);
        documentedNamespaceMembers[NMHL_Functions]++;
      }
      else if (md->isVariable())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_Variables],letter,md);
        documentedNamespaceMembers[NMHL_Variables]++;
      }
      else if (md->isTypedef())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_Typedefs],letter,md);
        documentedNamespaceMembers[NMHL_Typedefs]++;
      }
      else if (md->isSequence())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_Sequences],letter,md);
        documentedNamespaceMembers[NMHL_Sequences]++;
      }
      else if (md->isDictionary())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_Dictionaries],letter,md);
        documentedNamespaceMembers[NMHL_Dictionaries]++;
      }
      else if (md->isEnumerate())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_Enums],letter,md);
        documentedNamespaceMembers[NMHL_Enums]++;
      }
      else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
      {
        MemberIndexMap_add(g_namespaceIndexLetterUsed[NMHL_EnumValues],letter,md);
        documentedNamespaceMembers[NMHL_EnumValues]++;
      }
    }
  }
}

引用了 convertUTF8ToLower(), documentedNamespaceMembers, g_namespaceIndexLetterUsed, MemberDef::getEnumScope(), MemberDef::getNamespaceDef(), getPrefixIndex(), getUTF8CharAt(), MemberDef::isDictionary(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isFunction(), NamespaceDef::isLinkableInProject(), MemberDef::isLinkableInProject(), MemberDef::isSequence(), MemberDef::isStrong(), MemberDef::isTypedef(), MemberDef::isVariable(), MemberIndexMap_add(), Definition::name(), NMHL_All, NMHL_Dictionaries, NMHL_Enums, NMHL_EnumValues, NMHL_Functions, NMHL_Sequences, NMHL_Typedefs, NMHL_Variables , 以及 QCString::str().

被这些函数引用 addMembersToIndex().

countDataStructures()

void countDataStructures

(

)

在文件 index.cpp 第 87 行定义.

{
  static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
  annotatedClasses           = countAnnotatedClasses(&annotatedClassesPrinted, ClassDef::Class); // "classes" + "annotated"
  hierarchyClasses           = countClassHierarchy(ClassDef::Class);     // "hierarchy"
  // "interfaces" + "annotated"
  annotatedInterfaces        = sliceOpt ? countAnnotatedClasses(&annotatedInterfacesPrinted, ClassDef::Interface) : 0;
  // "interfacehierarchy"
  hierarchyInterfaces        = sliceOpt ? countClassHierarchy(ClassDef::Interface) : 0;
  // "structs" + "annotated"
  annotatedStructs           = sliceOpt ? countAnnotatedClasses(&annotatedStructsPrinted, ClassDef::Struct) : 0;
  // "exceptions" + "annotated"
  annotatedExceptions        = sliceOpt ? countAnnotatedClasses(&annotatedExceptionsPrinted, ClassDef::Exception) : 0;
  // "exceptionhierarchy"
  hierarchyExceptions        = sliceOpt ? countClassHierarchy(ClassDef::Exception) : 0;
  countFiles(documentedFiles,documentedFiles);        // "files"
  countRelatedPages(documentedPages,indexedPages);        // "pages"
  documentedGroups           = countGroups();             // "modules"
  documentedNamespaces       = countNamespaces();         // "namespaces"
  documentedConcepts         = countConcepts();           // "concepts"
  documentedDirs             = countDirs();               // "dirs"
  // "globals"
  // "namespacemembers"
  // "functions"
}

引用了 annotatedClasses, annotatedClassesPrinted, annotatedExceptions, annotatedExceptionsPrinted, annotatedInterfaces, annotatedInterfacesPrinted, annotatedStructs, annotatedStructsPrinted, ClassDef::Class, Config_getBool, countAnnotatedClasses(), countClassHierarchy(), countConcepts(), countDirs(), countFiles(), countGroups(), countNamespaces(), countRelatedPages(), documentedConcepts, documentedDirs, documentedFiles, documentedGroups, documentedNamespaces, documentedPages, ClassDef::Exception, hierarchyClasses, hierarchyExceptions, hierarchyInterfaces, indexedPages, ClassDef::Interface , 以及 ClassDef::Struct.

被这些函数引用 parseInput().

countVisibleMembers()

int countVisibleMembers

(

const NamespaceDef *

nd

)

在文件 index.cpp 第 1591 行定义.

{
  int count=0;
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
  {
    if (lde->kind()==LayoutDocEntry::MemberDef)
    {
      const LayoutDocEntryMemberDef *lmd = (const LayoutDocEntryMemberDef*)lde.get();
      MemberList *ml = nd->getMemberList(lmd->type);
      if (ml)
      {
        for (const auto &md : *ml)
        {
          if (md->visibleInIndex())
          {
            count++;
          }
        }
      }
    }
  }
  return count;
}

引用了 NamespaceDef::getMemberList(), LayoutDocManager::instance(), LayoutDocEntry::MemberDef, LayoutDocManager::Namespace , 以及 LayoutDocEntryMemberDef::type.

被这些函数引用 NestingContext::Private::addNamespace() , 以及 writeNamespaceTreeElement().

endFile()

void endFile	(	OutputList &	ol,
		bool	skipNavIndex = FALSE,
		bool	skipEndContents = FALSE,
		const QCString &	navPath = QCString()
	)

在文件 index.cpp 第 254 行定义.

{
  static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  if (!skipNavIndex)
  {
    if (!skipEndContents) ol.endContents();
    if (generateTreeView)
    {
      ol.writeString("</div><!-- doc-content -->\n");
    }
  }
 
  ol.writeFooter(navPath); // write the footer
  ol.popGeneratorState();
  ol.endFile();
}

引用了 Config_getBool, OutputList::disableAllBut(), OutputList::endContents(), OutputList::endFile(), OutputGenerator::Html, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::writeFooter() , 以及 OutputList::writeString().

被这些函数引用 endFileWithNavPath(), generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeClassMemberIndexFiltered(), writeConceptIndex(), PageDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), writePageIndex() , 以及 writeUserGroupStubPage().

endFileWithNavPath()

void endFileWithNavPath	(	const Definition *	d,
		OutputList &	ol
	)

在文件 index.cpp 第 274 行定义.

{
  static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  QCString navPath;
  if (generateTreeView)
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputGenerator::Html);
    ol.writeString("</div><!-- doc-content -->\n");
    ol.popGeneratorState();
    navPath = d->navigationPathAsString();
  }
  endFile(ol,generateTreeView,TRUE,navPath);
}

引用了 Config_getBool, OutputList::disableAllBut(), endFile(), OutputGenerator::Html, Definition::navigationPathAsString(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), TRUE , 以及 OutputList::writeString().

被这些函数引用 NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), ClassDefImpl::writeDocumentation(), MemberList::writeDocumentationPage() , 以及 FileDefImpl::writeSourceFooter().

endTitle()

void endTitle	(	OutputList &	ol,
		const QCString &	fileName,
		const QCString &	name
	)

在文件 index.cpp 第 228 行定义.

{
  ol.popGeneratorState();
  ol.endTitleHead(fileName,name);
  ol.endHeaderSection();
}

引用了 OutputList::endHeaderSection(), OutputList::endTitleHead() , 以及 OutputList::popGeneratorState().

被这些函数引用 generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeConceptIndex(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), writePageIndex(), FileDefImpl::writeSourceHeader() , 以及 writeUserGroupStubPage().

fixSpaces()

QCString fixSpaces

(

const QCString &

s

)

在文件 index.cpp 第 214 行定义.

{
  return substitute(s," "," ");
}

引用了 substitute().

被这些函数引用 renderQuickLinksAsTabs(), renderQuickLinksAsTree(), writeClassMemberIndexFiltered(), writeFileMemberIndexFiltered(), writeNamespaceMemberIndexFiltered() , 以及 writeUserGroupStubPage().

initClassMemberIndices()

void initClassMemberIndices

(

)

在文件 index.cpp 第 2649 行定义.

{
  int j=0;
  for (j=0;j<CMHL_Total;j++)
  {
    documentedClassMembers[j]=0;
    g_classIndexLetterUsed[j].clear();
  }
}

引用了 CMHL_Total, documentedClassMembers , 以及 g_classIndexLetterUsed.

被这些函数引用 initDoxygen().

initFileMemberIndices()

void initFileMemberIndices

(

)

在文件 index.cpp 第 2801 行定义.

{
  int j=0;
  for (j=0;j<NMHL_Total;j++)
  {
    documentedFileMembers[j]=0;
    g_fileIndexLetterUsed[j].clear();
  }
}

引用了 documentedFileMembers, g_fileIndexLetterUsed , 以及 NMHL_Total.

被这些函数引用 initDoxygen().

initNamespaceMemberIndices()

void initNamespaceMemberIndices

(

)

在文件 index.cpp 第 2733 行定义.

{
  int j=0;
  for (j=0;j<NMHL_Total;j++)
  {
    documentedNamespaceMembers[j]=0;
    g_namespaceIndexLetterUsed[j].clear();
  }
}

引用了 documentedNamespaceMembers, g_namespaceIndexLetterUsed , 以及 NMHL_Total.

被这些函数引用 initDoxygen().

sortMemberIndexLists()

void sortMemberIndexLists

(

)

在文件 index.cpp 第 2887 行定义.

{
  for (auto &idx : g_classIndexLetterUsed)
  {
    sortMemberIndexList(idx);
  }
  for (auto &idx : g_fileIndexLetterUsed)
  {
    sortMemberIndexList(idx);
  }
  for (auto &idx : g_namespaceIndexLetterUsed)
  {
    sortMemberIndexList(idx);
  }
}

引用了 g_classIndexLetterUsed, g_fileIndexLetterUsed, g_namespaceIndexLetterUsed , 以及 sortMemberIndexList().

被这些函数引用 addMembersToIndex().

startFile()

void startFile	(	OutputList &	ol,
		const QCString &	name,
		const QCString &	manName,
		const QCString &	title,
		HighlightedItem	hli = HLI_None,
		bool	additionalIndices = FALSE,
		const QCString &	altSidebarName = QCString()
	)

在文件 index.cpp 第 235 行定义.

{
  static bool disableIndex     = Config_getBool(DISABLE_INDEX);
  ol.startFile(name,manName,title);
  ol.startQuickIndices();
  if (!disableIndex)
  {
    ol.writeQuickLinks(TRUE,hli,name);
  }
  if (!additionalIndices)
  {
    ol.endQuickIndices();
  }
  ol.writeSplitBar(!altSidebarName.isEmpty() ? altSidebarName : name);
  ol.writeSearchInfo();
}

引用了 Config_getBool, OutputList::endQuickIndices(), QCString::isEmpty(), OutputList::startFile(), OutputList::startQuickIndices(), TRUE, OutputList::writeQuickLinks(), OutputList::writeSearchInfo() , 以及 OutputList::writeSplitBar().

被这些函数引用 generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeConceptIndex(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), ClassDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), writePageIndex(), FileDefImpl::writeSourceHeader() , 以及 writeUserGroupStubPage().

startTitle()

void startTitle	(	OutputList &	ol,
		const QCString &	fileName,
		const DefinitionMutable *	def = 0
	)

在文件 index.cpp 第 219 行定义.

{
  ol.startHeaderSection();
  if (def) def->writeSummaryLinks(ol);
  ol.startTitleHead(fileName);
  ol.pushGeneratorState();
  ol.disable(OutputGenerator::Man);
}

引用了 OutputList::disable(), OutputGenerator::Man, OutputList::pushGeneratorState(), OutputList::startHeaderSection(), OutputList::startTitleHead() , 以及 DefinitionMutable::writeSummaryLinks().

被这些函数引用 generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeConceptIndex(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), writePageIndex(), FileDefImpl::writeSourceHeader() , 以及 writeUserGroupStubPage().

writeGraphInfo()

void writeGraphInfo

(

OutputList &

ol

)

在文件 index.cpp 第 3686 行定义.

{
  if (!Config_getBool(HAVE_DOT) || !Config_getBool(GENERATE_HTML)) return;
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
 
  DotLegendGraph gd;
  gd.writeGraph(Config_getString(HTML_OUTPUT));
 
  bool stripCommentsStateRef = Config_getBool(STRIP_CODE_COMMENTS);
  bool oldStripCommentsState = stripCommentsStateRef;
  bool createSubdirs = Config_getBool(CREATE_SUBDIRS);
  bool oldCreateSubdirs = createSubdirs;
  // temporarily disable the stripping of comments for our own code example!
  stripCommentsStateRef = Config_updateBool(STRIP_CODE_COMMENTS,FALSE);
  // temporarily disable create subdirs for linking to our example
  createSubdirs = Config_updateBool(CREATE_SUBDIRS,FALSE);
 
  startFile(ol,"graph_legend",QCString(),theTranslator->trLegendTitle());
  startTitle(ol,QCString());
  ol.parseText(theTranslator->trLegendTitle());
  endTitle(ol,QCString(),QCString());
  ol.startContents();
  QCString legendDocs = theTranslator->trLegendDocs();
  int s = legendDocs.find("<center>");
  int e = legendDocs.find("</center>");
  QCString imgExt = getDotImageExtension();
  if (imgExt=="svg" && s!=-1 && e!=-1)
  {
    legendDocs = legendDocs.left(s+8) + "[!-- SVG 0 --]\n" + legendDocs.mid(e);
    //printf("legendDocs=%s\n",qPrint(legendDocs));
  }
  FileDef *fd = createFileDef("","graph_legend.dox");
  ol.generateDoc("graph_legend",1,fd,0,legendDocs,FALSE,FALSE,
                 QCString(),FALSE,FALSE,FALSE);
  delete fd;
 
  // restore config settings
  Config_updateBool(STRIP_CODE_COMMENTS,oldStripCommentsState);
  Config_updateBool(CREATE_SUBDIRS,oldCreateSubdirs);
 
  endFile(ol);
  ol.popGeneratorState();
}

引用了 Config_getBool, Config_getString, Config_updateBool, createFileDef(), OutputList::disableAllBut(), endFile(), endTitle(), FALSE, QCString::find(), OutputList::generateDoc(), getDotImageExtension(), OutputGenerator::Html, QCString::left(), QCString::mid(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startContents(), startFile(), startTitle(), theTranslator, Translator::trLegendDocs(), Translator::trLegendTitle() , 以及 DotLegendGraph::writeGraph().

被这些函数引用 generateOutput().

writeIndexHierarchy()

void writeIndexHierarchy

(

OutputList &

ol

)

在文件 index.cpp 第 5155 行定义.

{
  writeMenuData();
  LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry();
  if (lne)
  {
    writeIndexHierarchyEntries(ol,lne->children());
  }
}

引用了 LayoutNavEntry::children(), LayoutDocManager::instance(), LayoutDocManager::rootNavEntry(), writeIndexHierarchyEntries() , 以及 writeMenuData().

被这些函数引用 generateOutput().

变量说明

annotatedClasses

int annotatedClasses

在文件 index.cpp 第 56 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeAlphabeticalIndex(), writeAnnotatedIndex() , 以及 writeIndexHierarchyEntries().

annotatedExceptions

int annotatedExceptions

在文件 index.cpp 第 64 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeAlphabeticalExceptionIndex(), writeAnnotatedExceptionIndex() , 以及 writeIndexHierarchyEntries().

annotatedInterfaces

int annotatedInterfaces

在文件 index.cpp 第 59 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeAlphabeticalInterfaceIndex(), writeAnnotatedInterfaceIndex() , 以及 writeIndexHierarchyEntries().

annotatedStructs

int annotatedStructs

在文件 index.cpp 第 62 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeAlphabeticalStructIndex(), writeAnnotatedStructIndex() , 以及 writeIndexHierarchyEntries().

documentedClassMembers

int documentedClassMembers[CMHL_Total]

在文件 index.cpp 第 71 行定义.

被这些函数引用 addClassMemberNameToIndex(), initClassMemberIndices(), quickLinkVisible(), renderQuickLinksAsJs(), writeClassMemberIndex() , 以及 writeClassMemberIndexFiltered().

documentedConcepts

int documentedConcepts

在文件 index.cpp 第 69 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeConceptIndex() , 以及 writeIndex().

documentedDirs

int documentedDirs

在文件 index.cpp 第 76 行定义.

被这些函数引用 countDataStructures().

documentedFileMembers

int documentedFileMembers[FMHL_Total]

在文件 index.cpp 第 72 行定义.

被这些函数引用 addFileMemberNameToIndex(), initFileMemberIndices(), quickLinkVisible(), renderQuickLinksAsJs(), writeFileMemberIndex() , 以及 writeFileMemberIndexFiltered().

documentedFiles

int documentedFiles

在文件 index.cpp 第 74 行定义.

被这些函数引用 countDataStructures(), generateFileDocs(), quickLinkVisible(), writeFileIndex(), writeIndex() , 以及 writeIndexHierarchyEntries().

documentedGroups

int documentedGroups

在文件 index.cpp 第 67 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeGroupIndex() , 以及 writeIndex().

documentedNamespaceMembers

int documentedNamespaceMembers[NMHL_Total]

在文件 index.cpp 第 73 行定义.

被这些函数引用 addNamespaceMemberNameToIndex(), initNamespaceMemberIndices(), quickLinkVisible(), renderQuickLinksAsJs(), writeNamespaceMemberIndex() , 以及 writeNamespaceMemberIndexFiltered().

documentedNamespaces

int documentedNamespaces

在文件 index.cpp 第 68 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeIndex(), writeIndexHierarchyEntries() , 以及 writeNamespaceIndex().

documentedPages

int documentedPages

在文件 index.cpp 第 75 行定义.

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

hierarchyClasses

int hierarchyClasses

在文件 index.cpp 第 58 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeGraphicalClassHierarchy(), writeHierarchicalIndex() , 以及 writeIndex().

hierarchyExceptions

int hierarchyExceptions

在文件 index.cpp 第 66 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeGraphicalExceptionHierarchy(), writeHierarchicalExceptionIndex() , 以及 writeIndex().

hierarchyInterfaces

int hierarchyInterfaces

在文件 index.cpp 第 61 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible(), writeGraphicalInterfaceHierarchy(), writeHierarchicalInterfaceIndex() , 以及 writeIndex().

indexedPages

int indexedPages

在文件 index.cpp 第 70 行定义.

被这些函数引用 countDataStructures(), quickLinkVisible() , 以及 writePageIndex().