1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/******************************************************************************
*
*
*
* Copyright (C) 1997-2005 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#ifndef INDEX_H
#define INDEX_H
#include "qtbc.h"
#include <qfile.h>
enum IndexSections
{
isTitlePageStart,
isTitlePageAuthor,
isMainPage,
isModuleIndex,
isDirIndex,
isNamespaceIndex,
isClassHierarchyIndex,
isCompoundIndex,
isFileIndex,
isPageIndex,
isModuleDocumentation,
isDirDocumentation,
isNamespaceDocumentation,
isClassDocumentation,
isFileDocumentation,
isExampleDocumentation,
isPageDocumentation,
isEndIndex
};
class OutputList;
void writeIndex(OutputList &ol);
void writeHierarchicalIndex(OutputList &ol);
void writeAlphabeticalIndex(OutputList &ol);
void writeClassHierarchy(OutputList &ol);
void writeAnnotatedIndex(OutputList &ol);
void writeAnnotatedClassList(OutputList &ol);
void writeMemberList(OutputList &ol,bool useSections);
void writeSourceIndex(OutputList &ol);
void writeHeaderIndex(OutputList &ol);
void writeHeaderFileList(OutputList &ol);
void writeExampleIndex(OutputList &ol);
void writePageIndex(OutputList &ol);
void writeFileIndex(OutputList &ol);
void writeNamespaceIndex(OutputList &ol);
void writeGroupIndex(OutputList &ol);
void writeDirIndex(OutputList &ol);
void writePackageIndex(OutputList &ol);
void writeClassMemberIndex(OutputList &ol);
void writeFileMemberIndex(OutputList &ol);
void writeNamespaceMemberIndex(OutputList &ol);
void writeGraphicalClassHierarchy(OutputList &ol);
void writeGraphInfo(OutputList &ol);
void countDataStructures();
enum HighlightedItem
{
HLI_None=0,
HLI_Main,
HLI_Modules,
HLI_Directories,
HLI_Namespaces,
HLI_Hierarchy,
HLI_Classes,
HLI_Annotated,
HLI_Files,
HLI_NamespaceMembers,
HLI_Functions,
HLI_Globals,
HLI_Pages,
HLI_Examples,
HLI_Search
};
enum ClassMemberHighlight
{
CMHL_All = 0,
CMHL_Functions,
CMHL_Variables,
CMHL_Typedefs,
CMHL_Enums,
CMHL_EnumValues,
CMHL_Properties,
CMHL_Events,
CMHL_Related,
CMHL_Total = CMHL_Related+1
};
enum FileMemberHighlight
{
FMHL_All = 0,
FMHL_Functions,
FMHL_Variables,
FMHL_Typedefs,
FMHL_Enums,
FMHL_EnumValues,
FMHL_Defines,
FMHL_Total = FMHL_Defines+1
};
enum NamespaceMemberHighlight
{
NMHL_All = 0,
NMHL_Functions,
NMHL_Variables,
NMHL_Typedefs,
NMHL_Enums,
NMHL_EnumValues,
NMHL_Total = FMHL_EnumValues+1
};
enum ClassHighlight
{
CHL_All = 0,
CHL_Classes,
CHL_Structs,
CHL_Unions,
CHL_Interfaces,
CHL_Protocols,
CHL_Categories,
CHL_Exceptions,
CHL_Total = CHL_Exceptions+1
};
extern int annotatedClasses;
extern int hierarchyClasses;
extern int documentedFiles;
extern int documentedGroups;
extern int documentedNamespaces;
extern int indexedPages;
extern int documentedClassMembers[CMHL_Total];
extern int documentedFileMembers[FMHL_Total];
extern int documentedNamespaceMembers[NMHL_Total];
extern int documentedHtmlFiles;
extern int documentedPages;
extern int documentedDirs;
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=HLI_None);
void endFile(OutputList &ol,bool external=FALSE);
#endif
|
