30 enum class IndexSection
40 isClassHierarchyIndex,
44 isModuleDocumentation,
47 isNamespaceDocumentation,
49 isConceptDocumentation,
51 isExampleDocumentation,
57 enum class HighlightedItem
166 using MemberIndexList = std::vector<const MemberDef *>;
167 using MemberIndexMap = std::map<std::string,MemberIndexList>;
169 static Index &instance();
171 void countDataStructures();
172 void addClassMemberNameToIndex(
const MemberDef *md);
173 void addFileMemberNameToIndex(
const MemberDef *md);
174 void addNamespaceMemberNameToIndex(
const MemberDef *md);
175 void addModuleMemberNameToIndex(
const MemberDef *md);
176 void sortMemberIndexLists();
179 int numAnnotatedClasses()
const;
180 int numAnnotatedClassesPrinted()
const;
181 int numHierarchyClasses()
const;
182 int numAnnotatedInterfaces()
const;
183 int numAnnotatedInterfacesPrinted()
const;
184 int numHierarchyInterfaces()
const;
185 int numAnnotatedStructs()
const;
186 int numAnnotatedStructsPrinted()
const;
187 int numAnnotatedExceptions()
const;
188 int numAnnotatedExceptionsPrinted()
const;
189 int numHierarchyExceptions()
const;
190 int numDocumentedGroups()
const;
191 int numDocumentedNamespaces()
const;
192 int numDocumentedConcepts()
const;
193 int numDocumentedModules()
const;
194 int numIndexedPages()
const;
195 int numDocumentedFiles()
const;
196 int numDocumentedPages()
const;
197 int numDocumentedDirs()
const;
198 int numDocumentedClassMembers(ClassMemberHighlight::Enum e)
const;
199 int numDocumentedFileMembers(FileMemberHighlight::Enum e)
const;
200 int numDocumentedNamespaceMembers(NamespaceMemberHighlight::Enum e)
const;
201 int numDocumentedModuleMembers(ModuleMemberHighlight::Enum e)
const;
202 MemberIndexMap isClassIndexLetterUsed(ClassMemberHighlight::Enum e)
const;
203 MemberIndexMap isFileIndexLetterUsed(FileMemberHighlight::Enum e)
const;
204 MemberIndexMap isNamespaceIndexLetterUsed(NamespaceMemberHighlight::Enum e)
const;
205 MemberIndexMap isModuleIndexLetterUsed(ModuleMemberHighlight::Enum e)
const;
208 void resetDocumentedClassMembers(
int i);
209 void resetDocumentedFileMembers(
int i);
210 void resetDocumentedNamespaceMembers(
int i);
211 void resetDocumentedModuleMembers(
int i);
212 void incrementDocumentedClassMembers(
int i,
const std::string &letter,
const MemberDef *md);
213 void incrementDocumentedFileMembers(
int i,
const std::string &letter,
const MemberDef *md);
214 void incrementDocumentedNamespaceMembers(
int i,
const std::string &letter,
const MemberDef *md);
215 void incrementDocumentedModuleMembers(
int i,
const std::string &letter,
const MemberDef *md);
219 std::unique_ptr<Private> p;
227 const QCString &title,HighlightedItem hli=HighlightedItem::None,
228 bool additionalIndices=FALSE,
const QCString &altSidebarName=
QCString(),
int hierarchyLevel=0);
229 void endFile(
OutputList &ol,
bool skipNavIndex=FALSE,
bool skipEndContents=FALSE,
The common base class of all entity definitions found in the sources.
Definition: definition.h:74
An abstract interface of a namespace symbol.
Definition: namespacedef.h:54
A model of a class/file/namespace member symbol.
Definition: memberdef.h:47
Definition: definition.h:305
Class representing a list of output generators that are written to in parallel.
Definition: outputlist.h:530
This is an alternative implementation of QCString.
Definition: qcstring.h:93