index.cpp File Reference

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

#include <cstdlib>
#include <array>
#include <assert.h>
#include "message.h"
#include "index.h"
#include "indexlist.h"
#include "doxygen.h"
#include "config.h"
#include "filedef.h"
#include "outputlist.h"
#include "util.h"
#include "groupdef.h"
#include "language.h"
#include "htmlgen.h"
#include "htmlhelp.h"
#include "ftvhelp.h"
#include "dot.h"
#include "dotgfxhierarchytable.h"
#include "dotlegendgraph.h"
#include "pagedef.h"
#include "dirdef.h"
#include "vhdldocgen.h"
#include "layout.h"
#include "memberlist.h"
#include "classlist.h"
#include "namespacedef.h"
#include "filename.h"
#include "tooltip.h"
#include "utf8.h"
#include "portable.h"

Include dependency graph for index.cpp:

Classes
struct	Index::Private
class	AlphaIndexTableCell
	Class representing a cell in the alphabetical class index. More...
struct	AnnotatedIndexContext
struct	CmhlInfo
	Helper class representing a class member in the navigation menu. More...
struct	FmhlInfo
	Helper class representing a file member in the navigation menu. More...
struct	NmhlInfo
	Helper class representing a namespace member in the navigation menu. More...

Macros
#define	MAX_ITEMS_BEFORE_MULTIPAGE_INDEX   200
#define	MAX_ITEMS_BEFORE_QUICK_INDEX   30

Typedefs
using	UsedIndexLetters = std::set< std::string >

Functions
void	startTitle (OutputList &ol, const QCString &fileName, const DefinitionMutable *def)
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, bool additionalIndices, const QCString &altSidebarName, int hierarchyLevel)
void	endFile (OutputList &ol, bool skipNavIndex, bool skipEndContents, const QCString &navPath)
void	endFileWithNavPath (OutputList &ol, const Definition *d)
template<class T >
void	addMembersToIndex (T *def, LayoutDocManager::LayoutPart part, const QCString &name, const QCString &anchor, bool addToIndex=TRUE, bool preventSeparateIndex=FALSE, const ConceptLinkedRefMap *concepts=nullptr)
template<typename Ptr >
const ClassDef *	get_pointer (const Ptr &p)
template<>
const ClassDef *	get_pointer (const ClassLinkedMap::Ptr &p)
template<>
const ClassDef *	get_pointer (const ClassLinkedRefMap::Ptr &p)
bool	isId1 (int c)
void	writeGraphInfo (OutputList &ol)
template<class T >
void	renderMemberIndicesAsJs (std::ostream &t, std::function< std::size_t(std::size_t)> numDocumented, std::function< Index::MemberIndexMap(std::size_t)> getMemberList, const T *(*getInfo)(size_t hl), std::size_t total)
void	writeIndexHierarchy (OutputList &ol)

Variables
const int	maxItemsBeforeQuickIndex = MAX_ITEMS_BEFORE_QUICK_INDEX

Detailed Description

This file contains functions for the various index pages.