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 "htmlgen.h"
#include "htmlhelp.h"
#include "ftvhelp.h"
#include "dot.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"

Classes
class	MemberIndexList
class	PrefixIgnoreClassList
	Special class list where sorting takes IGNORE_PREFIX into account. More...
class	AlphaIndexTableCell
	Class representing a cell in the alphabetical class index. More...
class	AlphaIndexTableRows
	Class representing a row in the alphabetical class index. More...
class	AlphaIndexTableRowsIterator
	Iterator for the cells in a row of the alphabetical class index. More...
class	AlphaIndexTableColumns
	Class representing the columns in the alphabetical class index. More...
class	UsedIndexLetters
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
#define	NEXT_ROW()

Functions
void	countDataStructures ()
QCString	fixSpaces (const QCString &s)
void	startTitle (OutputList &ol, const char *fileName, Definition *def)
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, const char *altSidebarName)
void	endFile (OutputList &ol, bool skipNavIndex, bool skipEndContents, const QCString &navPath)
void	endFileWithNavPath (Definition *d, OutputList &ol)
template<class T >
void	addMembersToIndex (T *def, LayoutDocManager::LayoutPart part, const QCString &name, const QCString &anchor, bool addToIndex=TRUE, bool preventSeparateIndex=FALSE)
void	writeClassTree (ClassSDict *clDict, FTVHelp *ftv, bool addToIndex, bool globalOnly)
void	initClassMemberIndices ()
void	addClassMemberNameToIndex (MemberDef *md)
void	initNamespaceMemberIndices ()
void	addNamespaceMemberNameToIndex (MemberDef *md)
void	initFileMemberIndices ()
void	addFileMemberNameToIndex (MemberDef *md)
void	writeGraphInfo (OutputList &ol)
template<class T >
void	renderMemberIndicesAsJs (FTextStream &t, int total, const int *numDocumented, const LetterToIndexMap< MemberIndexList > *memberLists, const T *(*getInfo)(int hl))
void	writeIndexHierarchy (OutputList &ol)

Variables
int	annotatedClasses
int	annotatedClassesPrinted
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.

Macro Definition Documentation

NEXT_ROW

#define NEXT_ROW

(

)

Value:

do                                         \
    {                                          \
      if (row>maxRows) maxRows=row;            \
      if (row>=rows && col<columns)            \
      {                                        \
        col++;                                 \
        row=0;                                 \
        tableRows = new AlphaIndexTableRows;   \
        tableColumns.append(tableRows);        \
      }                                        \
    }                                          \
    while(0)                                   \