qtcreator-api.qdocconf 7.83 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1
include(../config/qt-html-templates.qdocconf)
con's avatar
con committed
2

3
4
project                 = Qt Creator API
description             = Qt Creator API Documentation
con's avatar
con committed
5
6
7
8

language                = Cpp

headerdirs              = . \
con's avatar
con committed
9
                          ../../src/libs/aggregation \
10
                          ../../src/libs/cplusplus \
11
                          ../../src/libs/extensionsystem \
12
                          ../../src/libs/qtcreatorcdbext \
con's avatar
con committed
13
                          ../../src/plugins/coreplugin \
con's avatar
con committed
14
                          ../../src/plugins/find \
15
16
                          ../../src/plugins/locator \
                          ../../src/plugins/debugger
con's avatar
con committed
17
18

sourcedirs              = . \
con's avatar
con committed
19
                          ../../src/libs/aggregation \
20
                          ../../src/libs/cplusplus \
21
                          ../../src/libs/extensionsystem \
22
                          ../../src/libs/qtcreatorcdbext \
con's avatar
con committed
23
                          ../../src/plugins/coreplugin \
con's avatar
con committed
24
                          ../../src/plugins/find \
25
26
                          ../../src/plugins/locator \
                         ../../src/plugins/debugger
con's avatar
con committed
27

28
29
30
31
32
33
# -- Generate complete documentation. Set this to 'false'
#    to generate public API documentation only.

showinternal = true

headers.fileextensions  = "*.h"
con's avatar
con committed
34
35
sources.fileextensions  = "*.cpp *.qdoc"

con's avatar
con committed
36
imagedirs               = images ../templates/images
con's avatar
con committed
37

con's avatar
con committed
38
indexes                 = qt.index
con's avatar
con committed
39

con's avatar
con committed
40
41
outputdir               = ./html
base                    = file:./html
con's avatar
con committed
42
versionsym              = 2.0.0
con's avatar
con committed
43
44
codeindent              = 1

Leena Miettinen's avatar
Leena Miettinen committed
45
include(../config/qt-defines.qdocconf)
con's avatar
con committed
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

# macros.qdocconf

macro.aring.HTML        = "å"
macro.Auml.HTML         = "Ä"
macro.author            = "\\bold{Author:}"
macro.br.HTML           = "<br />"
macro.BR.HTML           = "<br />"
macro.aacute.HTML       = "&aacute;"
macro.eacute.HTML       = "&eacute;"
macro.iacute.HTML       = "&iacute;"
macro.gui               = "\\bold"
macro.hr.HTML           = "<hr />"
macro.key               = "\\bold"
macro.menu              = "\\bold"
macro.note              = "\\bold{Note:}"
macro.oslash.HTML       = "&oslash;"
macro.ouml.HTML         = "&ouml;"
macro.QA                = "\\e{Qt Assistant}"
macro.QD                = "\\e{Qt Designer}"
macro.QL                = "\\e{Qt Linguist}"
macro.QC		= "\\e{Qt Creator}"
macro.QMLD		= "\\e{Qt Quick Designer}"
macro.QQV               = "\\e{Qt QML Viewer}"
macro.param             = "\\e"
macro.raisedaster.HTML  = "<sup>*</sup>"
macro.reg.HTML          = "<sup>&reg;</sup>"
macro.return            = "Returns"
macro.starslash         = "\\c{*/}"
macro.uuml.HTML         = "&uuml;"
macro.mdash.HTML        = "&mdash;"

# compat.qdocconf

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
alias.i				= e
alias.include			= input

macro.0                         = "\\\\0"
macro.b                         = "\\\\b"
macro.n                         = "\\\\n"
macro.r                         = "\\\\r"
macro.i                         = "\\o"
macro.i11                       = "\\o{1,1}"
macro.i12                       = "\\o{1,2}"
macro.i13                       = "\\o{1,3}"
macro.i14                       = "\\o{1,4}"
macro.i15                       = "\\o{1,5}"
macro.i16                       = "\\o{1,6}"
macro.i17                       = "\\o{1,7}"
macro.i18                       = "\\o{1,8}"
macro.i19                       = "\\o{1,9}"
macro.i21                       = "\\o{2,1}"
macro.i31                       = "\\o{3,1}"
macro.i41                       = "\\o{4,1}"
macro.i51                       = "\\o{5,1}"
macro.i61                       = "\\o{6,1}"
macro.i71                       = "\\o{7,1}"
macro.i81                       = "\\o{8,1}"
macro.i91                       = "\\o{9,1}"
macro.img                       = "\\image"
macro.endquote                  = "\\endquotation"
spurious			= "Missing comma in .*" \
con's avatar
con committed
108
				  "Missing pattern .*"
109

con's avatar
con committed
110
111
112
113
114
115
# Doxygen compatibility commands

macro.see                       = "\\sa"
macro.function                  = "\\fn"

# qt-cpp-ignore.qdocconf
con's avatar
con committed
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

Cpp.ignoretokens        = QAXFACTORY_EXPORT \
                          QDESIGNER_COMPONENTS_LIBRARY \
                          QDESIGNER_EXTENSION_LIBRARY \
                          QDESIGNER_SDK_LIBRARY \
                          QDESIGNER_SHARED_LIBRARY \
                          QDESIGNER_UILIB_LIBRARY \
                          QM_EXPORT_CANVAS \
                          QM_EXPORT_DNS \
                          QM_EXPORT_DOM \
                          QM_EXPORT_FTP \
                          QM_EXPORT_HTTP \
                          QM_EXPORT_ICONVIEW \
                          QM_EXPORT_NETWORK \
                          QM_EXPORT_OPENGL \
                          QM_EXPORT_SQL \
                          QM_EXPORT_TABLE \
                          QM_EXPORT_WORKSPACE \
                          QM_EXPORT_XML \
                          QT_ASCII_CAST_WARN \
136
                          QT_ASCII_CAST_WARN_CONSTRUCTOR \
con's avatar
con committed
137
138
139
                          QT_BEGIN_HEADER \
                          QT_DESIGNER_STATIC \
                          QT_END_HEADER \
140
                          QT_FASTCALL \
con's avatar
con committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
                          QT_WIDGET_PLUGIN_EXPORT \
                          Q_COMPAT_EXPORT \
                          Q_CORE_EXPORT \
                          Q_EXPLICIT \
                          Q_EXPORT \
                          Q_EXPORT_CODECS_CN \
                          Q_EXPORT_CODECS_JP \
                          Q_EXPORT_CODECS_KR \
                          Q_EXPORT_PLUGIN \
                          Q_GFX_INLINE \
                          Q_GUI_EXPORT \
                          Q_GUI_EXPORT_INLINE \
                          Q_GUI_EXPORT_STYLE_CDE \
                          Q_GUI_EXPORT_STYLE_COMPACT \
                          Q_GUI_EXPORT_STYLE_MAC \
                          Q_GUI_EXPORT_STYLE_MOTIF \
                          Q_GUI_EXPORT_STYLE_MOTIFPLUS \
                          Q_GUI_EXPORT_STYLE_PLATINUM \
                          Q_GUI_EXPORT_STYLE_POCKETPC \
                          Q_GUI_EXPORT_STYLE_SGI \
                          Q_GUI_EXPORT_STYLE_WINDOWS \
                          Q_GUI_EXPORT_STYLE_WINDOWSXP \
163
                          QHELP_EXPORT \
con's avatar
con committed
164
                          Q_INLINE_TEMPLATE \
165
                          Q_INTERNAL_WIN_NO_THROW \
con's avatar
con committed
166
167
168
169
170
171
172
173
174
                          Q_NETWORK_EXPORT \
                          Q_OPENGL_EXPORT \
                          Q_OUTOFLINE_TEMPLATE \
                          Q_SQL_EXPORT \
                          Q_SVG_EXPORT \
                          Q_SCRIPT_EXPORT \
                          Q_TESTLIB_EXPORT \
                          Q_TYPENAME \
                          Q_XML_EXPORT \
175
176
177
178
179
180
181
                          Q_XMLSTREAM_EXPORT \
                          Q_XMLPATTERNS_EXPORT \
                          QDBUS_EXPORT \
                          QT_BEGIN_NAMESPACE \
                          QT_BEGIN_INCLUDE_NAMESPACE \
                          QT_END_NAMESPACE \
                          QT_END_INCLUDE_NAMESPACE \
con's avatar
con committed
182
183
                          PHONON_EXPORT \
                          EXTENSIONSYSTEM_EXPORT
con's avatar
con committed
184
185
186
187
188
189
190
191
192
193
Cpp.ignoredirectives    = Q_DECLARE_HANDLE \
                          Q_DECLARE_INTERFACE \
                          Q_DECLARE_METATYPE \
                          Q_DECLARE_OPERATORS_FOR_FLAGS \
                          Q_DECLARE_PRIVATE \
                          Q_DECLARE_PUBLIC \
                          Q_DECLARE_SHARED \
                          Q_DECLARE_TR_FUNCTIONS \
                          Q_DECLARE_TYPEINFO \
                          Q_DISABLE_COPY \
194
                          QT_FORWARD_DECLARE_CLASS \
con's avatar
con committed
195
196
197
198
                          Q_DUMMY_COMPARISON_OPERATOR \
                          Q_ENUMS \
                          Q_FLAGS \
                          Q_INTERFACES \
199
200
201
202
                          __attribute__ \
                          K_DECLARE_PRIVATE \
                          PHONON_OBJECT \
                          PHONON_HEIR