#include "qtbc.h"#include <qfile.h>#include <qlist.h>Go to the source code of this file.
| enum ClassHighlight |
| enum ClassMemberHighlight |
| enum FileMemberHighlight |
| enum HighlightedItem |
| enum IndexSections |
| 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(), ClassDef::isLinkableInProject(), MemberDef::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(), MemberDef::isLinkableInProject(), FileDef::isLinkableInProject(), MemberDef::name, and QCString.
| void addNamespaceMemberNameToIndex | ( | MemberDef * | md | ) |
Definition at line 1574 of file index.cpp.
References documentedNamespaceMembers, MemberDef::getNamespaceDef(), getPrefixIndex(), MemberDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), MemberDef::name, NMHL_All, NMHL_Enums, NMHL_EnumValues, NMHL_Functions, NMHL_Typedefs, NMHL_Variables, and QCString.
| 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().
| void endFile | ( | OutputList & | ol, | |
| bool | external = FALSE | |||
| ) |
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(), ClassDef::writeDocumentation(), DirDef::writeDocumentation(), DirRelation::writeDocumentation(), FileDef::writeDocumentation(), GroupDef::writeDocumentation(), NamespaceDef::writeDocumentation(), PageDef::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(), ClassDef::writeDocumentation(), DirDef::writeDocumentation(), FileDef::writeDocumentation(), GroupDef::writeDocumentation(), NamespaceDef::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 = HLI_None, |
|||
| bool | additionalIndices = FALSE | |||
| ) |
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(), ClassDef::writeDocumentation(), DirDef::writeDocumentation(), DirRelation::writeDocumentation(), FileDef::writeDocumentation(), GroupDef::writeDocumentation(), NamespaceDef::writeDocumentation(), PageDef::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(), ClassDef::writeDocumentation(), DirDef::writeDocumentation(), FileDef::writeDocumentation(), GroupDef::writeDocumentation(), NamespaceDef::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), writePageIndex(), and FileDef::writeSource().
| 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 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 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 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 writeHeaderFileList | ( | OutputList & | ol | ) |
| void writeHeaderIndex | ( | OutputList & | ol | ) |
| 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(), startFile(), OutputList::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 writeMemberList | ( | OutputList & | ol, | |
| bool | useSections | |||
| ) |
| 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 writePackageIndex | ( | OutputList & | ol | ) |
| 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 writeSourceIndex | ( | OutputList & | ol | ) |
| 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 documentedNamespaceMembers[NMHL_Total] |
Definition at line 56 of file index.cpp.
Referenced by addNamespaceMemberNameToIndex(), initNamespaceMemberIndices(), and writeNamespaceMemberIndex().
Definition at line 52 of file index.cpp.
Referenced by countDataStructures(), writeIndex(), and writeNamespaceIndex().
| int documentedPages |
| int hierarchyClasses |
Definition at line 49 of file index.cpp.
Referenced by countDataStructures(), writeGraphicalClassHierarchy(), writeHierarchicalIndex(), and writeIndex().
| int indexedPages |
1.5.1