index.cpp File Reference

This file contains functions for the various index pages. More...

#include <stdlib.h>
#include <qtextstream.h>
#include <qdatetime.h>
#include <qdir.h>
#include <qregexp.h>
#include "message.h"
#include "index.h"
#include "doxygen.h"
#include "config.h"
#include "filedef.h"
#include "outputlist.h"
#include "util.h"
#include "groupdef.h"
#include "language.h"
#include "htmlhelp.h"
#include "ftvhelp.h"
#include "dot.h"
#include "pagedef.h"
#include "dirdef.h"
#include "vhdldocgen.h"

Go to the source code of this file.

Classes

class  MemberIndexList
class  PrefixIgnoreClassList

Defines

#define MAX_ITEMS_BEFORE_MULTIPAGE_INDEX   200
#define MAX_ITEMS_BEFORE_QUICK_INDEX   30
#define MEMBER_INDEX_ENTRIES   128

Functions

int countClassHierarchy ()
int countClassMembers (int filter=CMHL_All)
int countFileMembers (int filter=FMHL_All)
void countFiles (int &htmlFiles, int &files)
int countGroups ()
int countDirs ()
int countNamespaces ()
int countAnnotatedClasses ()
int countNamespaceMembers (int filter=NMHL_All)
int countIncludeFiles ()
void countRelatedPages (int &docPages, int &indexPages)
void countDataStructures ()
bool stripWord (QCString &s, QCString w)
QCString abbreviate (const char *s, const char *name)
void startTitle (OutputList &ol, const char *fileName)
void endTitle (OutputList &ol, const char *fileName, const char *name)
void startFile (OutputList &ol, const char *name, const char *manName, const char *title, HighlightedItem hli, bool additionalIndices)
void endFile (OutputList &ol, bool)
void writeClassTree (OutputList &ol, BaseClassList *bcl, bool hideSuper, int level)
void writeClassTree (BaseClassList *cl, int level)
void writeClassTreeNode (ClassDef *cd, bool &started, int level)
void writeClassTree (ClassList *cl, int level)
void writeClassTree (ClassSDict *d, int level)
void writeClassHierarchy (OutputList &ol)
void writeHierarchicalIndex (OutputList &ol)
void writeGraphicalClassHierarchy (OutputList &ol)
void writeFileIndex (OutputList &ol)
void writeNamespaceIndex (OutputList &ol)
void writeAnnotatedClassList (OutputList &ol)
void writeAlphabeticalClassList (OutputList &ol)
void writeAlphabeticalIndex (OutputList &ol)
void writeAnnotatedIndex (OutputList &ol)
void initClassMemberIndices ()
void addClassMemberNameToIndex (MemberDef *md)
void initNamespaceMemberIndices ()
void addNamespaceMemberNameToIndex (MemberDef *md)
void initFileMemberIndices ()
void addFileMemberNameToIndex (MemberDef *md)
void writeQuickMemberIndex (OutputList &ol, MemberIndexList charUsed[MEMBER_INDEX_ENTRIES], int page, QCString fullName, bool multiPage)
void writeClassMemberIndex (OutputList &ol)
void writeFileMemberIndex (OutputList &ol)
void writeNamespaceMemberIndex (OutputList &ol)
void writeExampleIndex (OutputList &ol)
void writePageIndex (OutputList &ol)
void writeGraphInfo (OutputList &ol)
void writeGroupIndexItem (GroupDef *gd, MemberList *ml, const QCString &title)
void writeGroupTreeNode (OutputList &ol, GroupDef *gd, int level)
void writeGroupHierarchy (OutputList &ol)
void writeDirTreeNode (OutputList &ol, DirDef *dd, int level)
void writeDirHierarchy (OutputList &ol)
void writeGroupIndex (OutputList &ol)
void writeDirIndex (OutputList &ol)
void writeIndex (OutputList &ol)

Variables

int annotatedClasses
int hierarchyClasses
int documentedFiles
int documentedGroups
int documentedNamespaces
int indexedPages
int documentedClassMembers [CMHL_Total]
int documentedFileMembers [FMHL_Total]
int documentedNamespaceMembers [NMHL_Total]
int documentedHtmlFiles
int documentedPages
int documentedDirs
const int maxItemsBeforeQuickIndex = MAX_ITEMS_BEFORE_QUICK_INDEX


Detailed Description

This file contains functions for the various index pages.

Definition in file index.cpp.


Define Documentation

#define MAX_ITEMS_BEFORE_MULTIPAGE_INDEX   200

Definition at line 45 of file index.cpp.

#define MAX_ITEMS_BEFORE_QUICK_INDEX   30

Definition at line 46 of file index.cpp.

#define MEMBER_INDEX_ENTRIES   128

Definition at line 125 of file index.cpp.


Function Documentation

QCString abbreviate ( const char *  s,
const char *  name 
)

Definition at line 151 of file index.cpp.

References Config_getList, QCString, and stripWord().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void addClassMemberNameToIndex ( MemberDef md  ) 

Definition at line 1485 of file index.cpp.

References VhdlDocGen::adjustRecordMember(), CMHL_All, CMHL_Enums, CMHL_EnumValues, CMHL_Events, CMHL_Functions, CMHL_Properties, CMHL_Related, CMHL_Typedefs, CMHL_Variables, Config_getBool, documentedClassMembers, MemberDef::getClassDef(), getPrefixIndex(), MemberDef::isLinkableInProject(), ClassDef::isLinkableInProject(), VhdlDocGen::isRecord(), VhdlDocGen::isUnit(), QCString, and ClassDef::templateMaster().

void addFileMemberNameToIndex ( MemberDef md  ) 

Definition at line 1632 of file index.cpp.

References documentedFileMembers, FMHL_All, FMHL_Defines, FMHL_Enums, FMHL_EnumValues, FMHL_Functions, FMHL_Typedefs, FMHL_Variables, MemberDef::getFileDef(), getPrefixIndex(), FileDef::isLinkableInProject(), MemberDef::isLinkableInProject(), MemberDef::name, and QCString.

void addNamespaceMemberNameToIndex ( MemberDef md  ) 

Definition at line 1574 of file index.cpp.

References documentedNamespaceMembers, MemberDef::getNamespaceDef(), getPrefixIndex(), NamespaceDef::isLinkableInProject(), MemberDef::isLinkableInProject(), MemberDef::name, NMHL_All, NMHL_Enums, NMHL_EnumValues, NMHL_Functions, NMHL_Typedefs, NMHL_Variables, and QCString.

int countAnnotatedClasses (  ) 

Definition at line 950 of file index.cpp.

References Doxygen::classSDict, ClassDef::isLinkableInProject(), SDict< ClassDef >::Iterator, and ClassDef::templateMaster().

Referenced by countDataStructures().

int countClassHierarchy (  ) 

Definition at line 571 of file index.cpp.

References Doxygen::classSDict, Doxygen::hiddenClasses, and initClassHierarchy().

Referenced by countDataStructures().

int countClassMembers ( int  filter = CMHL_All  ) 

void countDataStructures (  ) 

Definition at line 73 of file index.cpp.

References annotatedClasses, countAnnotatedClasses(), countClassHierarchy(), countDirs(), countFiles(), countGroups(), countNamespaces(), countRelatedPages(), documentedDirs, documentedFiles, documentedGroups, documentedHtmlFiles, documentedNamespaces, documentedPages, hierarchyClasses, and indexedPages.

Referenced by parseInput().

int countDirs (  ) 

Definition at line 2281 of file index.cpp.

References Doxygen::directories, DirDef::isLinkableInProject(), and DirDef::visited.

Referenced by countDataStructures().

int countFileMembers ( int  filter = FMHL_All  ) 

void countFiles ( int &  htmlFiles,
int &  files 
)

Definition at line 652 of file index.cpp.

References FileDef::generateSourceFile(), Doxygen::inputNameList, FileDef::isDocumentationFile(), and FileDef::isLinkableInProject().

Referenced by countDataStructures().

int countGroups (  ) 

Definition at line 2263 of file index.cpp.

References Doxygen::groupSDict, Definition::isReference(), SDict< GroupDef >::Iterator, and GroupDef::visited.

Referenced by countDataStructures().

int countIncludeFiles (  ) 

int countNamespaceMembers ( int  filter = NMHL_All  ) 

int countNamespaces (  ) 

Definition at line 840 of file index.cpp.

References NamespaceDef::isLinkableInProject(), SDict< NamespaceDef >::Iterator, and Doxygen::namespaceSDict.

Referenced by countDataStructures().

void countRelatedPages ( int &  docPages,
int &  indexPages 
)

Definition at line 2157 of file index.cpp.

References PageDef::documentedPage(), SDict< PageDef >::Iterator, Doxygen::pageSDict, and PageDef::visibleInIndex().

Referenced by countDataStructures().

void endFile ( OutputList ol,
bool   
)

Definition at line 294 of file index.cpp.

References OutputList::disableAllBut(), OutputList::endContents(), OutputList::endFile(), OutputGenerator::Html, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and OutputList::writeFooter().

Referenced by writeAlphabeticalIndex(), writeAnnotatedIndex(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberList::writeDocumentationPage(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), writePageIndex(), and FileDef::writeSource().

void endTitle ( OutputList ol,
const char *  fileName,
const char *  name 
)

Definition at line 265 of file index.cpp.

References OutputList::endTitleHead(), and OutputList::popGeneratorState().

Referenced by writeAlphabeticalIndex(), writeAnnotatedIndex(), writeDirIndex(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), writePageIndex(), and FileDef::writeSource().

void initClassMemberIndices (  ) 

Definition at line 1471 of file index.cpp.

References CMHL_Total, and documentedClassMembers.

Referenced by initDoxygen().

void initFileMemberIndices (  ) 

Definition at line 1618 of file index.cpp.

References documentedFileMembers, and NMHL_Total.

Referenced by initDoxygen().

void initNamespaceMemberIndices (  ) 

Definition at line 1560 of file index.cpp.

References documentedNamespaceMembers, and NMHL_Total.

Referenced by initDoxygen().

void startFile ( OutputList ol,
const char *  name,
const char *  manName,
const char *  title,
HighlightedItem  hli,
bool  additionalIndices 
)

Definition at line 271 of file index.cpp.

References Config_getBool, OutputList::endQuickIndices(), OutputList::startContents(), OutputList::startFile(), OutputList::startQuickIndices(), and OutputList::writeQuickLinks().

Referenced by writeAlphabeticalIndex(), writeAnnotatedIndex(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberList::writeDocumentationPage(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), writePageIndex(), and FileDef::writeSource().

void startTitle ( OutputList ol,
const char *  fileName 
)

Definition at line 258 of file index.cpp.

References OutputList::disable(), OutputGenerator::Man, OutputList::pushGeneratorState(), and OutputList::startTitleHead().

Referenced by writeAlphabeticalIndex(), writeAnnotatedIndex(), writeDirIndex(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), writePageIndex(), and FileDef::writeSource().

bool stripWord ( QCString &  s,
QCString  w 
)

Definition at line 138 of file index.cpp.

Referenced by abbreviate().

void writeAlphabeticalClassList ( OutputList ol  ) 

Definition at line 1072 of file index.cpp.

References annotatedClasses, ClassDef::className(), Doxygen::classSDict, Config_getBool, Config_getInt, OutputList::docify(), extractNamespaceName(), NamespaceDef::getOutputFileBase(), ClassDef::getOutputFileBase(), getPrefixIndex(), Definition::getReference(), ClassDef::getReference(), getResolvedNamespace(), NamespaceDef::isLinkable(), ClassDef::isLinkableInProject(), SDict< ClassDef >::Iterator, ClassDef::name, QCString, substitute(), ClassDef::templateMaster(), OutputList::writeNonBreakableSpace(), OutputList::writeObjectLink(), and OutputList::writeString().

Referenced by writeAlphabeticalIndex().

void writeAlphabeticalIndex ( OutputList ol  ) 

Definition at line 1284 of file index.cpp.

References annotatedClasses, Config_getBool, OutputList::disableAllBut(), endFile(), endTitle(), HLI_Classes, OutputGenerator::Html, Doxygen::htmlFileExtension, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), startFile(), startTitle(), theTranslator, Translator::trAlphabeticalList(), Translator::trCompoundIndex(), Translator::trCompoundIndexFortran(), VhdlDocGen::trDesignUnitIndex(), and writeAlphabeticalClassList().

void writeAnnotatedClassList ( OutputList ol  ) 

Definition at line 969 of file index.cpp.

References abbreviate(), IndexList::addContentsItem(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), ClassDef::Category, CHL_All, CHL_Categories, CHL_Classes, CHL_Exceptions, CHL_Interfaces, CHL_Protocols, CHL_Structs, CHL_Total, CHL_Unions, ClassDef::Class, Doxygen::classSDict, ClassDef::compoundType(), ClassDef::compoundTypeString(), ClassDef::displayName(), OutputList::endIndexKey(), OutputList::endIndexList(), OutputList::endIndexValue(), ClassDef::Exception, ClassDef::getOutputFileBase(), getPrefixIndex(), ClassDef::getReference(), Doxygen::indexList, ClassDef::Interface, ClassDef::isLinkableInProject(), SDict< ClassDef >::Iterator, OutputList::parseDoc(), ClassDef::Protocol, QCString, OutputList::startIndexKey(), OutputList::startIndexList(), OutputList::startIndexValue(), ClassDef::Struct, ClassDef::templateMaster(), ClassDef::Union, and OutputList::writeObjectLink().

Referenced by writeAnnotatedIndex().

void writeAnnotatedIndex ( OutputList ol  ) 

Definition at line 1306 of file index.cpp.

References IndexList::addContentsItem(), annotatedClasses, Config_getBool, IndexList::decContentsDepth(), OutputList::disable(), endFile(), OutputList::endTextBlock(), endTitle(), HLI_Annotated, IndexList::incContentsDepth(), Doxygen::indexList, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, startFile(), OutputList::startTextBlock(), startTitle(), theTranslator, Translator::trCompoundList(), Translator::trCompoundListDescription(), Translator::trCompoundListDescriptionFortran(), Translator::trCompoundListFortran(), VhdlDocGen::trDesignUnitList(), VhdlDocGen::trDesignUnitListDescription(), and writeAnnotatedClassList().

void writeClassHierarchy ( OutputList ol  ) 

Definition at line 533 of file index.cpp.

References Doxygen::classSDict, IndexList::decContentsDepth(), Doxygen::hiddenClasses, Doxygen::indexList, and initClassHierarchy().

Referenced by writeHierarchicalIndex().

void writeClassMemberIndex ( OutputList ol  ) 

Definition at line 1832 of file index.cpp.

References IndexList::addContentsItem(), CMHL_All, CMHL_Enums, CMHL_EnumValues, CMHL_Events, CMHL_Functions, CMHL_Properties, CMHL_Related, CMHL_Typedefs, CMHL_Variables, Config_getBool, documentedClassMembers, Doxygen::indexList, QCString, theTranslator, Translator::trCompoundMembers(), and Translator::trCompoundMembersFortran().

void writeClassTree ( ClassSDict d,
int  level 
)

Definition at line 461 of file index.cpp.

References SDict< ClassDef >::Iterator, and writeClassTreeNode().

void writeClassTree ( ClassList cl,
int  level 
)

Definition at line 446 of file index.cpp.

References writeClassTreeNode().

void writeClassTree ( BaseClassList cl,
int  level 
)

Generates HTML Help tree of classes

Definition at line 385 of file index.cpp.

References ClassDef::baseClasses(), IndexList::decContentsDepth(), ClassDef::displayName(), ClassDef::getOutputFileBase(), ClassDef::getReference(), hasVisibleRoot(), IndexList::incContentsDepth(), Doxygen::indexList, ClassDef::isLinkable(), ClassDef::isVisibleInHierarchy(), ClassDef::subClasses(), ClassDef::visited, and writeClassTree().

void writeClassTree ( OutputList ol,
BaseClassList bcl,
bool  hideSuper,
int  level 
)

Definition at line 321 of file index.cpp.

References IndexList::addContentsItem(), ClassDef::baseClasses(), IndexList::decContentsDepth(), ClassDef::displayName(), OutputList::docify(), OutputList::endIndexItem(), OutputList::endTypewriter(), ClassDef::getOutputFileBase(), ClassDef::getReference(), hasVisibleRoot(), IndexList::incContentsDepth(), Doxygen::indexList, ClassDef::isLinkable(), ClassDef::isReference(), ClassDef::isVisibleInHierarchy(), ClassDef::name, OutputList::parseText(), OutputList::startIndexItem(), OutputList::startTypewriter(), ClassDef::subClasses(), and ClassDef::visited.

Referenced by writeClassTree(), and writeClassTreeNode().

void writeClassTreeNode ( ClassDef cd,
bool &  started,
int  level 
)

Generates HTML Help tree of classes

Definition at line 423 of file index.cpp.

References ClassDef::displayName(), ClassDef::getOutputFileBase(), ClassDef::getReference(), Doxygen::indexList, ClassDef::isLinkable(), ClassDef::isVisibleInHierarchy(), ClassDef::subClasses(), ClassDef::visited, and writeClassTree().

Referenced by writeClassTree().

void writeDirHierarchy ( OutputList ol  ) 

Definition at line 2622 of file index.cpp.

References Doxygen::directories, Definition::getOuterScope(), Doxygen::globalScope, and writeDirTreeNode().

Referenced by writeDirIndex().

void writeDirIndex ( OutputList ol  ) 

Definition at line 2664 of file index.cpp.

References IndexList::addContentsItem(), IndexList::decContentsDepth(), OutputList::disable(), documentedDirs, endFile(), OutputList::endTextBlock(), endTitle(), HLI_Directories, IndexList::incContentsDepth(), Doxygen::indexList, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, startFile(), OutputList::startTextBlock(), startTitle(), theTranslator, Translator::trDirDescription(), Translator::trDirectories(), Translator::trDirIndex(), and writeDirHierarchy().

Referenced by generateOutput().

void writeDirTreeNode ( OutputList ol,
DirDef dd,
int  level 
)

Definition at line 2561 of file index.cpp.

References IndexList::addContentsItem(), Config_getBool, convertToHtml(), IndexList::decContentsDepth(), OutputList::docify(), OutputList::endIndexItem(), OutputList::endTypewriter(), fileList, Definition::getDefFileName(), Definition::getDefLine(), DirDef::getFiles(), FileDef::getOutputFileBase(), DirDef::getOutputFileBase(), Definition::getReference(), IndexList::incContentsDepth(), Doxygen::indexList, Definition::isReference(), FileDef::name(), Definition::name(), OutputList::parseText(), DirDef::shortName(), OutputList::startIndexItem(), OutputList::startTypewriter(), DirDef::subDirs(), and warn().

Referenced by writeDirHierarchy().

void writeExampleIndex ( OutputList ol  ) 

Definition at line 2110 of file index.cpp.

References IndexList::addContentsItem(), IndexList::decContentsDepth(), OutputList::disable(), endFile(), OutputList::endItemList(), OutputList::endTextBlock(), endTitle(), Doxygen::exampleSDict, PageDef::getOutputFileBase(), Definition::getReference(), HLI_Examples, IndexList::incContentsDepth(), Doxygen::indexList, SDict< PageDef >::Iterator, OutputGenerator::Man, Definition::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, startFile(), OutputList::startItemList(), OutputList::startTextBlock(), startTitle(), theTranslator, PageDef::title(), Translator::trExamples(), Translator::trExamplesDescription(), OutputList::writeListItem(), OutputList::writeObjectLink(), and OutputList::writeString().

Referenced by generateOutput().

void writeFileIndex ( OutputList ol  ) 

Definition at line 684 of file index.cpp.

References abbreviate(), IndexList::addContentsItem(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, IndexList::decContentsDepth(), OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), documentedFiles, documentedHtmlFiles, OutputList::endBold(), endFile(), OutputList::endIndexKey(), OutputList::endIndexList(), OutputList::endIndexValue(), OutputList::endTextBlock(), OutputList::endTextLink(), endTitle(), FileDef::generateSourceFile(), FileDef::getOutputFileBase(), FileDef::getPath(), Definition::getReference(), HLI_Files, OutputGenerator::Html, IndexList::incContentsDepth(), FileDef::includeName(), Doxygen::indexList, Doxygen::inputNameList, FileDef::isDocumentationFile(), FileDef::isLinkableInProject(), Definition::isReference(), OutputGenerator::Man, FileDef::name(), OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, OutputList::startBold(), startFile(), OutputList::startIndexKey(), OutputList::startIndexList(), OutputList::startIndexValue(), OutputList::startTextBlock(), OutputList::startTextLink(), startTitle(), stripFromPath(), theTranslator, Translator::trCode(), Translator::trFileIndex(), Translator::trFileList(), Translator::trFileListDescription(), and OutputList::writeObjectLink().

Referenced by generateOutput().

void writeFileMemberIndex ( OutputList ol  ) 

Definition at line 1963 of file index.cpp.

References IndexList::addContentsItem(), documentedFileMembers, FMHL_All, FMHL_Defines, FMHL_Enums, FMHL_EnumValues, FMHL_Functions, FMHL_Typedefs, FMHL_Variables, Doxygen::indexList, QCString, theTranslator, and Translator::trFileMembers().

Referenced by generateOutput().

void writeGraphicalClassHierarchy ( OutputList ol  ) 

Definition at line 622 of file index.cpp.

References IndexList::addContentsItem(), OutputList::disableAllBut(), OutputList::enableAll(), endFile(), OutputList::endTextBlock(), OutputList::endTextLink(), endTitle(), hierarchyClasses, HLI_Hierarchy, OutputGenerator::Html, Doxygen::indexList, OutputList::newParagraph(), OutputList::parseText(), QCString, startFile(), OutputList::startTextBlock(), OutputList::startTextLink(), startTitle(), theTranslator, Translator::trGotoTextualHierarchy(), Translator::trGraphicalHierarchy(), and OutputList::writeGraphicalHierarchy().

Referenced by generateOutput().

void writeGraphInfo ( OutputList ol  ) 

Definition at line 2300 of file index.cpp.

References Config_getBool, Config_getString, OutputList::disableAllBut(), endFile(), endTitle(), generateGraphLegend(), OutputGenerator::Html, OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), startFile(), startTitle(), theTranslator, Translator::trLegendDocs(), and Translator::trLegendTitle().

Referenced by generateOutput().

void writeGroupHierarchy ( OutputList ol  ) 

Definition at line 2546 of file index.cpp.

References Config_getBool, Doxygen::groupSDict, SDict< GroupDef >::Iterator, SDict< T >::sort(), and writeGroupTreeNode().

Referenced by writeGroupIndex().

void writeGroupIndex ( OutputList ol  ) 

Definition at line 2636 of file index.cpp.

References IndexList::addContentsItem(), IndexList::decContentsDepth(), OutputList::disable(), documentedGroups, endFile(), OutputList::endTextBlock(), endTitle(), HLI_Modules, IndexList::incContentsDepth(), Doxygen::indexList, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, startFile(), OutputList::startTextBlock(), startTitle(), theTranslator, Translator::trModuleIndex(), Translator::trModules(), Translator::trModulesDescription(), and writeGroupHierarchy().

Referenced by generateOutput().

void writeGroupIndexItem ( GroupDef gd,
MemberList ml,
const QCString &  title 
)

Definition at line 2319 of file index.cpp.

References IndexList::addContentsItem(), MemberDef::anchor, convertToHtml(), IndexList::decContentsDepth(), MemberDef::getOutputFileBase(), GroupDef::getOutputFileBase(), MemberDef::getReference(), Definition::getReference(), IndexList::incContentsDepth(), Doxygen::indexList, MemberDef::isDetailedSectionVisible(), and MemberDef::name.

Referenced by writeGroupTreeNode().

void writeGroupTreeNode ( OutputList ol,
GroupDef gd,
int  level 
)

write groups as hierarchical trees

Author:
KPW

gd->visited &&

Definition at line 2352 of file index.cpp.

References IndexList::addContentsItem(), GroupDef::classSDict, Config_getBool, convertToHtml(), SDict< T >::count(), IndexList::decContentsDepth(), ClassDef::displayName(), MemberList::docDefineMembers, MemberList::docEnumMembers, MemberList::docFuncMembers, OutputList::docify(), MemberList::docProtoMembers, MemberList::docTypedefMembers, MemberList::documentationLists, MemberList::docVarMembers, OutputList::endIndexItem(), OutputList::endTypewriter(), GroupDef::exampleDict, fileList, GroupDef::fileList, Definition::getDefFileName(), Definition::getDefLine(), GroupDef::getMemberList(), GroupDef::getMemberLists(), PageDef::getOutputFileBase(), FileDef::getOutputFileBase(), ClassDef::getOutputFileBase(), NamespaceDef::getOutputFileBase(), GroupDef::getOutputFileBase(), ClassDef::getReference(), Definition::getReference(), GroupDef::groupList, GroupDef::groupTitle(), IndexList::incContentsDepth(), Doxygen::indexList, GroupDef::isASubGroup(), ClassDef::isLinkable(), Definition::isReference(), SDict< ClassDef >::Iterator, SDict< NamespaceDef >::Iterator, SDict< PageDef >::Iterator, FileDef::name(), Definition::name(), GroupDef::namespaceSDict, GroupDef::pageDict, OutputList::parseText(), Doxygen::sectionDict, OutputList::startIndexItem(), OutputList::startTypewriter(), theTranslator, PageDef::title(), Translator::trClasses(), Translator::trDataTypes(), Translator::trDefines(), Translator::trEnumerations(), Translator::trExamples(), Translator::trFile(), Translator::trFuncProtos(), VhdlDocGen::trFunctionAndProc(), Translator::trFunctions(), Translator::trModules(), Translator::trNamespaces(), Translator::trSubprograms(), Translator::trTypedefs(), Translator::trVariables(), warn(), and writeGroupIndexItem().

Referenced by writeGroupHierarchy().

void writeHierarchicalIndex ( OutputList ol  ) 

Definition at line 583 of file index.cpp.

References IndexList::addContentsItem(), Config_getBool, OutputList::disable(), OutputList::enable(), endFile(), OutputList::endTextBlock(), OutputList::endTextLink(), endTitle(), hierarchyClasses, HLI_Hierarchy, Doxygen::indexList, OutputGenerator::Latex, OutputGenerator::Man, OutputList::newParagraph(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, OutputGenerator::RTF, startFile(), OutputList::startTextBlock(), OutputList::startTextLink(), startTitle(), theTranslator, Translator::trClassHierarchy(), Translator::trClassHierarchyDescription(), VhdlDocGen::trDesignUnitHierarchy(), Translator::trGotoGraphicalHierarchy(), Translator::trHierarchicalIndex(), and writeClassHierarchy().

void writeIndex ( OutputList ol  ) 

Definition at line 2703 of file index.cpp.

References IndexList::addContentsItem(), annotatedClasses, Config_getBool, Config_getString, convertToXML(), OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), documentedDirs, documentedFiles, documentedGroups, documentedNamespaces, documentedPages, OutputList::enable(), endFile(), OutputList::endIndexSection(), OutputList::endProjectNumber(), OutputList::endQuickIndices(), OutputList::endTextBlock(), OutputList::endTitleHead(), Doxygen::exampleSDict, Definition::getDefFileName(), Definition::getDefLine(), PageDef::getGroupDef(), PageDef::getOutputFileBase(), hierarchyClasses, HLI_Main, OutputGenerator::Html, Doxygen::indexList, Doxygen::insideMainPage, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, Definition::isReference(), isTitlePageAuthor, isTitlePageStart, SDict< PageDef >::Iterator, OutputList::lastIndexPage(), OutputGenerator::Latex, Doxygen::mainPage, OutputGenerator::Man, Definition::name(), OutputList::newParagraph(), Doxygen::pageSDict, OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, OutputGenerator::RTF, OutputList::startContents(), OutputList::startFile(), startFile(), OutputList::startIndexSection(), OutputList::startProjectNumber(), OutputList::startQuickIndices(), OutputList::startTextBlock(), OutputList::startTitleHead(), substitute(), Doxygen::tagFile, theTranslator, PageDef::title(), Translator::trClassDocumentation(), Translator::trCompoundIndex(), Translator::trCompoundIndexFortran(), VhdlDocGen::trDesignUnitIndex(), Translator::trDirDocumentation(), Translator::trDirIndex(), Translator::trDocumentation(), Translator::trExampleDocumentation(), Translator::trFileDocumentation(), Translator::trFileIndex(), Translator::trGeneratedBy(), Translator::trMainPage(), Translator::trModuleDocumentation(), Translator::trModuleIndex(), Translator::trModulesIndex(), Translator::trNamespaceDocumentation(), Translator::trNamespaceIndex(), Translator::trReferenceManual(), Translator::trTypeDocumentation(), Definition::writeDocAnchorsToTagFile(), OutputList::writePageLink(), and OutputList::writeQuickLinks().

Referenced by generateOutput().

void writeNamespaceIndex ( OutputList ol  ) 

Definition at line 854 of file index.cpp.

References abbreviate(), IndexList::addContentsItem(), Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, IndexList::decContentsDepth(), OutputList::disable(), NamespaceDef::displayName(), documentedNamespaces, endFile(), OutputList::endIndexKey(), OutputList::endIndexList(), OutputList::endIndexValue(), OutputList::endTextBlock(), endTitle(), NamespaceDef::getOutputFileBase(), Definition::getReference(), HLI_Namespaces, IndexList::incContentsDepth(), Doxygen::indexList, NamespaceDef::isLinkableInProject(), SDict< NamespaceDef >::Iterator, OutputGenerator::Man, Doxygen::namespaceSDict, OutputList::parseDoc(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, startFile(), OutputList::startIndexKey(), OutputList::startIndexList(), OutputList::startIndexValue(), OutputList::startTextBlock(), startTitle(), theTranslator, Translator::trModulesIndex(), Translator::trModulesList(), Translator::trModulesListDescription(), Translator::trNamespaceIndex(), Translator::trNamespaceList(), Translator::trNamespaceListDescription(), Translator::trPackageList(), Translator::trPackageListDescription(), and OutputList::writeObjectLink().

void writeNamespaceMemberIndex ( OutputList ol  ) 

Definition at line 2091 of file index.cpp.

References IndexList::addContentsItem(), Config_getBool, documentedNamespaceMembers, Doxygen::indexList, NMHL_All, NMHL_Enums, NMHL_EnumValues, NMHL_Functions, NMHL_Typedefs, NMHL_Variables, QCString, theTranslator, Translator::trModulesMembers(), and Translator::trNamespaceMembers().

Referenced by generateOutput().

void writePageIndex ( OutputList ol  ) 

Definition at line 2206 of file index.cpp.

References IndexList::addContentsItem(), OutputList::disableAllBut(), OutputList::docify(), endFile(), OutputList::endIndexItem(), OutputList::endTextBlock(), endTitle(), OutputList::endTypewriter(), PageDef::getOutputFileBase(), Definition::getReference(), PageDef::hasSubPages(), HLI_Pages, OutputGenerator::Html, indexedPages, Doxygen::indexList, Definition::isReference(), SDict< PageDef >::Iterator, Definition::name(), Doxygen::pageSDict, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString, startFile(), OutputList::startIndexItem(), OutputList::startTextBlock(), startTitle(), OutputList::startTypewriter(), theTranslator, PageDef::title(), Translator::trPageIndex(), Translator::trRelatedPages(), Translator::trRelatedPagesDescription(), PageDef::visibleInIndex(), and OutputList::writeString().

Referenced by generateOutput().

void writeQuickMemberIndex ( OutputList ol,
MemberIndexList  charUsed[MEMBER_INDEX_ENTRIES],
int  page,
QCString  fullName,
bool  multiPage 
)

Definition at line 1681 of file index.cpp.

References Doxygen::htmlFileExtension, OutputList::newParagraph(), QCString, and OutputList::writeString().


Variable Documentation

int annotatedClasses

Definition at line 48 of file index.cpp.

Referenced by countDataStructures(), writeAlphabeticalClassList(), writeAlphabeticalIndex(), writeAnnotatedIndex(), and writeIndex().

int documentedClassMembers[CMHL_Total]

Definition at line 54 of file index.cpp.

Referenced by addClassMemberNameToIndex(), initClassMemberIndices(), and writeClassMemberIndex().

int documentedDirs

Definition at line 59 of file index.cpp.

Referenced by countDataStructures(), writeDirIndex(), and writeIndex().

int documentedFileMembers[FMHL_Total]

Definition at line 55 of file index.cpp.

Referenced by addFileMemberNameToIndex(), initFileMemberIndices(), and writeFileMemberIndex().

int documentedFiles

Definition at line 50 of file index.cpp.

Referenced by countDataStructures(), writeFileIndex(), and writeIndex().

int documentedGroups

Definition at line 51 of file index.cpp.

Referenced by countDataStructures(), writeGroupIndex(), and writeIndex().

int documentedHtmlFiles

Definition at line 57 of file index.cpp.

Referenced by countDataStructures(), and writeFileIndex().

int documentedNamespaceMembers[NMHL_Total]

Definition at line 56 of file index.cpp.

Referenced by addNamespaceMemberNameToIndex(), initNamespaceMemberIndices(), and writeNamespaceMemberIndex().

int documentedNamespaces

Definition at line 52 of file index.cpp.

Referenced by countDataStructures(), writeIndex(), and writeNamespaceIndex().

int documentedPages

Definition at line 58 of file index.cpp.

Referenced by countDataStructures(), and writeIndex().

int hierarchyClasses

Definition at line 49 of file index.cpp.

Referenced by countDataStructures(), writeGraphicalClassHierarchy(), writeHierarchicalIndex(), and writeIndex().

int indexedPages

Definition at line 53 of file index.cpp.

Referenced by countDataStructures(), and writePageIndex().

const int maxItemsBeforeQuickIndex = MAX_ITEMS_BEFORE_QUICK_INDEX

Definition at line 133 of file index.cpp.



Generated on Mon Mar 31 10:58:53 2008 by  doxygen 1.5.1