Merge lp:~cosmos-door/ubuntu/raring/touchegg/lp1059489 into lp:ubuntu/raring/touchegg
- Raring (13.04)
- lp1059489
- Merge into raring
Proposed by
Mitsuya Shibata
Status: | Merged | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Merge reported by: | Andrew Starr-Bochicchio | ||||||||||||||||
Merged at revision: | not available | ||||||||||||||||
Proposed branch: | lp:~cosmos-door/ubuntu/raring/touchegg/lp1059489 | ||||||||||||||||
Merge into: | lp:ubuntu/raring/touchegg | ||||||||||||||||
Diff against target: |
11364 lines (+3393/-5599) 69 files modified
.pc/0001-geis_rename.patch/touchegg.pro (+0/-23) .pc/applied-patches (+0/-1) CHANGELOG (+3/-0) COMMENT_TAGS.txt (+44/-0) COPYRIGHT (+1/-1) HACKING (+69/-0) debian/changelog (+10/-0) debian/patches/0001-geis_rename.patch (+0/-13) debian/patches/series (+0/-1) documentation/.directory (+2/-0) documentation/doxyfile (+1718/-0) documentation/doxyfile_en (+0/-1661) documentation/doxyfile_es (+0/-1661) installation/.directory (+2/-0) src/.directory (+2/-0) src/touchegg/Main.cpp (+2/-9) src/touchegg/Touchegg.cpp (+50/-116) src/touchegg/Touchegg.h (+41/-142) src/touchegg/actions/factory/ActionFactory.cpp (+15/-15) src/touchegg/actions/factory/ActionFactory.h (+15/-39) src/touchegg/actions/implementation/Action.h (+25/-69) src/touchegg/actions/implementation/ChangeDesktop.cpp (+23/-29) src/touchegg/actions/implementation/ChangeDesktop.h (+11/-19) src/touchegg/actions/implementation/ChangeViewport.cpp (+29/-33) src/touchegg/actions/implementation/ChangeViewport.h (+11/-18) src/touchegg/actions/implementation/CloseWindow.cpp (+16/-19) src/touchegg/actions/implementation/CloseWindow.h (+3/-7) src/touchegg/actions/implementation/DragAndDrop.cpp (+18/-22) src/touchegg/actions/implementation/DragAndDrop.h (+13/-19) src/touchegg/actions/implementation/MaximizeRestoreWindow.cpp (+26/-35) src/touchegg/actions/implementation/MaximizeRestoreWindow.h (+2/-6) src/touchegg/actions/implementation/MinimizeWindow.cpp (+16/-19) src/touchegg/actions/implementation/MinimizeWindow.h (+2/-6) src/touchegg/actions/implementation/MouseClick.cpp (+13/-15) src/touchegg/actions/implementation/MouseClick.h (+11/-19) src/touchegg/actions/implementation/MoveWindow.cpp (+17/-20) src/touchegg/actions/implementation/MoveWindow.h (+3/-7) src/touchegg/actions/implementation/ResizeWindow.cpp (+31/-35) src/touchegg/actions/implementation/ResizeWindow.h (+2/-6) src/touchegg/actions/implementation/RunCommand.cpp (+11/-11) src/touchegg/actions/implementation/RunCommand.h (+11/-18) src/touchegg/actions/implementation/Scroll.cpp (+40/-46) src/touchegg/actions/implementation/Scroll.h (+13/-56) src/touchegg/actions/implementation/SendKeys.cpp (+27/-35) src/touchegg/actions/implementation/SendKeys.h (+11/-22) src/touchegg/actions/implementation/ShowDesktop.cpp (+28/-28) src/touchegg/actions/implementation/ShowDesktop.h (+2/-6) src/touchegg/actions/types/ActionTypeEnum.cpp (+6/-7) src/touchegg/actions/types/ActionTypeEnum.h (+3/-21) src/touchegg/config/Config.cpp (+65/-78) src/touchegg/config/Config.h (+64/-153) src/touchegg/gestures/collector/GestureCollector.cpp (+167/-97) src/touchegg/gestures/collector/GestureCollector.h (+94/-153) src/touchegg/gestures/factory/GestureFactory.cpp (+54/-99) src/touchegg/gestures/factory/GestureFactory.h (+21/-60) src/touchegg/gestures/handler/GestureHandler.cpp (+171/-195) src/touchegg/gestures/handler/GestureHandler.h (+69/-159) src/touchegg/gestures/implementation/Gesture.cpp (+24/-25) src/touchegg/gestures/implementation/Gesture.h (+44/-164) src/touchegg/gestures/types/GestureDirectionEnum.cpp (+8/-11) src/touchegg/gestures/types/GestureDirectionEnum.h (+3/-21) src/touchegg/gestures/types/GestureTypeEnum.cpp (+7/-8) src/touchegg/gestures/types/GestureTypeEnum.h (+6/-37) src/touchegg/touchegg.pri (+2/-0) src/touchegg/util/Include.h (+1/-1) src/touchegg/windows/WindowListener.cpp (+106/-0) src/touchegg/windows/WindowListener.h (+87/-0) src/touchegg/windows/windows.pri (+2/-0) touchegg.pro (+0/-3) |
||||||||||||||||
To merge this branch: | bzr merge lp:~cosmos-door/ubuntu/raring/touchegg/lp1059489 | ||||||||||||||||
Related bugs: |
|
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Andrew Starr-Bochicchio (community) | Approve | ||
Ubuntu branches | Pending | ||
Review via email:
|
Commit message
To post a comment you must log in.
Revision history for this message
![](/+icing/build/overlay/assets/skins/sam/images/close.gif)
Andrew Starr-Bochicchio (andrewsomething) wrote : | # |
review:
Approve
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === removed directory '.pc/0001-geis_rename.patch' |
2 | === removed file '.pc/0001-geis_rename.patch/touchegg.pro' |
3 | --- .pc/0001-geis_rename.patch/touchegg.pro 2012-07-30 15:05:54 +0000 |
4 | +++ .pc/0001-geis_rename.patch/touchegg.pro 1970-01-01 00:00:00 +0000 |
5 | @@ -1,23 +0,0 @@ |
6 | -TEMPLATE = app |
7 | -TARGET = touchegg |
8 | -QT += gui core xml |
9 | -OBJECTS_DIR += build |
10 | -MOC_DIR += build |
11 | -LIBS += -lutouch-geis -lX11 -lXtst -lXext |
12 | -//DEFINES = QT_NO_DEBUG_OUTPUT |
13 | - |
14 | -target.path = /usr/bin |
15 | -config.path = /usr/share/touchegg |
16 | -config.files = installation/touchegg.conf |
17 | -INSTALLS += target config |
18 | - |
19 | - |
20 | -include(src/touchegg/touchegg.pri) |
21 | - |
22 | -OTHER_FILES += \ |
23 | - documentation/doxyfile_es \ |
24 | - documentation/doxyfile_en \ |
25 | - README \ |
26 | - COPYING \ |
27 | - CHANGELOG \ |
28 | - COPYRIGHT |
29 | |
30 | === removed file '.pc/applied-patches' |
31 | --- .pc/applied-patches 2012-07-30 15:05:54 +0000 |
32 | +++ .pc/applied-patches 1970-01-01 00:00:00 +0000 |
33 | @@ -1,1 +0,0 @@ |
34 | -0001-geis_rename.patch |
35 | |
36 | === modified file 'CHANGELOG' |
37 | --- CHANGELOG 2011-09-21 15:44:04 +0000 |
38 | +++ CHANGELOG 2012-12-17 15:14:32 +0000 |
39 | @@ -1,3 +1,6 @@ |
40 | +[+] Touchégg v1.1 (2012/07/22) |
41 | + - Added Ubuntu Precise compatibility |
42 | + |
43 | [+] Touchégg v1.0 (2011/09/02) |
44 | - Now Touchégg subscribe to gestures in their own window, to not conflict with |
45 | applications that uses their own gestures |
46 | |
47 | === added file 'COMMENT_TAGS.txt' |
48 | --- COMMENT_TAGS.txt 1970-01-01 00:00:00 +0000 |
49 | +++ COMMENT_TAGS.txt 2012-12-17 15:14:32 +0000 |
50 | @@ -0,0 +1,44 @@ |
51 | +// ****************************************************************************************************************** // |
52 | +// ********** ANONYMOUS NAMESPACE ********** // |
53 | +// ****************************************************************************************************************** // |
54 | + |
55 | +// ****************************************************************************************************************** // |
56 | +// ********** STATIC METHODS AND VARIABLES ********** // |
57 | +// ****************************************************************************************************************** // |
58 | + |
59 | +// ****************************************************************************************************************** // |
60 | +// ********** CONSTRUCTORS AND DESTRUCTOR ********** // |
61 | +// ****************************************************************************************************************** // |
62 | + |
63 | +// ****************************************************************************************************************** // |
64 | +// ********** PUBLIC METHODS ********** // |
65 | +// ****************************************************************************************************************** // |
66 | + |
67 | +// ****************************************************************************************************************** // |
68 | +// ********** PUBLIC SLOTS ********** // |
69 | +// ****************************************************************************************************************** // |
70 | + |
71 | +// ****************************************************************************************************************** // |
72 | +// ********** PROTECTED METHODS ********** // |
73 | +// ****************************************************************************************************************** // |
74 | + |
75 | +// ****************************************************************************************************************** // |
76 | +// ********** OVERLOAD OPERATORS ********** // |
77 | +// ****************************************************************************************************************** // |
78 | + |
79 | +// ****************************************************************************************************************** // |
80 | +// ********** PRIVATE SLOTS ********** // |
81 | +// ****************************************************************************************************************** // |
82 | + |
83 | +// ****************************************************************************************************************** // |
84 | +// ********** PRIVATE METHODS ********** // |
85 | +// ****************************************************************************************************************** // |
86 | + |
87 | +// ****************************************************************************************************************** // |
88 | +// ********** GET/SET/IS ********** // |
89 | +// ****************************************************************************************************************** // |
90 | + |
91 | + |
92 | + |
93 | +//---------------------------------------------------------------------------------------------------------------------- |
94 | + //------------------------------------------------------------------------------------------------------------------ |
95 | \ No newline at end of file |
96 | |
97 | === modified file 'COPYRIGHT' |
98 | --- COPYRIGHT 2011-09-21 15:44:04 +0000 |
99 | +++ COPYRIGHT 2012-12-17 15:14:32 +0000 |
100 | @@ -1,1 +1,1 @@ |
101 | -Copyright (C) 2011 José Expósito <jose.exposito89@gmail.com> |
102 | +Copyright (C) 2011 - 2012 José Expósito <jose.exposito89@gmail.com> |
103 | |
104 | === added file 'HACKING' |
105 | --- HACKING 1970-01-01 00:00:00 +0000 |
106 | +++ HACKING 2012-12-17 15:14:32 +0000 |
107 | @@ -0,0 +1,69 @@ |
108 | + |
109 | +[+] Coding Style: |
110 | + |
111 | + Please, if you want to send a patch, follow the Qt/KDE coding style: |
112 | + |
113 | + http://developer.qt.nokia.com/wiki/Qt_Coding_Style |
114 | + http://techbase.kde.org/Policies/Kdelibs_Coding_Style |
115 | + |
116 | + In addition: |
117 | + |
118 | + - Limit the number of characters per line to 120 |
119 | + - If is neccessary, make Doxygen documentation |
120 | + - Maintain this order in the methods of the header files: |
121 | + |
122 | + public (Constructors, destructor, public methods, getters/setters) |
123 | + protected |
124 | + public slots |
125 | + signals |
126 | + private slots |
127 | + private (Private methods, private variables) |
128 | + |
129 | + - Use "comment tags" (check COMMENT_TAGS.txt) in the source files to make |
130 | + easy find the implementation of the methods in this order: |
131 | + |
132 | + ANONYMOUS NAMESPACE |
133 | + STATIC METHODS AND VARIABLES |
134 | + CONSTRUCTORS AND DESTRUCTOR |
135 | + PUBLIC METHODS |
136 | + PUBLIC SLOTS |
137 | + PROTECTED METHODS |
138 | + OVERLOAD OPERATORS |
139 | + PRIVATE SLOTS |
140 | + PRIVATE METHODS |
141 | + GET/SET/IS |
142 | + |
143 | + Remember that you can use astyle to indent the code automatically: |
144 | + |
145 | + astyle --style=k/r --indent=spaces=4 --convert-tabs \ |
146 | + --pad-header --unpad-paren \ |
147 | + --indent-namespaces --keep-one-line-blocks --align-pointer=name \ |
148 | + --max-instatement-indent=8 --indent-col1-comments \ |
149 | + --suffix=none \ |
150 | + `find -type f -name '*.cpp'` `find -type f -name '*.h'` |
151 | + |
152 | + |
153 | +[+] Understanding the Code: |
154 | + |
155 | + All the code is documented with Doxygen. If want to see this documentation |
156 | + in html format, go to the ./documentation folder and run: |
157 | + |
158 | + $ doxygen doxyfile |
159 | + |
160 | + Open the ./documentation/html/index.html file is a good place to begin. |
161 | + |
162 | + Touchégg makes an intensive use of Qt and uTouch. Reading this can help: |
163 | + |
164 | + http://doc.qt.nokia.com/ |
165 | + http://people.canonical.com/~stephenwebb/geis-v2-api/ |
166 | + |
167 | + |
168 | + |
169 | +[+] Contact the developer: |
170 | + |
171 | + If you want to report a bug, you can do it in the official bug tracker: |
172 | + |
173 | + https://code.google.com/p/touchegg/issues/list |
174 | + |
175 | + For other questions, talk about the weather or invite me to a beer you can |
176 | + send me an email to jose.exposito89@gmail.com |
177 | |
178 | === modified file 'debian/changelog' |
179 | --- debian/changelog 2012-07-30 15:05:54 +0000 |
180 | +++ debian/changelog 2012-12-17 15:14:32 +0000 |
181 | @@ -1,3 +1,13 @@ |
182 | +touchegg (1.1.1-0ubuntu1) raring; urgency=low |
183 | + |
184 | + * New upstream release (LP: #1059489) |
185 | + - fixed several segv problems. |
186 | + LP: #1065673, LP: #856022, LP: #918551 |
187 | + - applied geis rename patch. |
188 | + * Removed 0001-geis_rename.patch no needs anymore. |
189 | + |
190 | + -- Mitsuya Shibata <mty.shibata@gmail.com> Mon, 17 Dec 2012 23:16:27 +0900 |
191 | + |
192 | touchegg (1.0-0ubuntu2) quantal; urgency=low |
193 | |
194 | * Depend on renamed geis package |
195 | |
196 | === removed file 'debian/patches/0001-geis_rename.patch' |
197 | --- debian/patches/0001-geis_rename.patch 2012-07-30 15:05:54 +0000 |
198 | +++ debian/patches/0001-geis_rename.patch 1970-01-01 00:00:00 +0000 |
199 | @@ -1,13 +0,0 @@ |
200 | -Index: touchegg/touchegg.pro |
201 | -=================================================================== |
202 | ---- touchegg.orig/touchegg.pro 2012-07-30 14:49:39.595064774 -0700 |
203 | -+++ touchegg/touchegg.pro 2012-07-30 14:49:50.581568509 -0700 |
204 | -@@ -3,7 +3,7 @@ |
205 | - QT += gui core xml |
206 | - OBJECTS_DIR += build |
207 | - MOC_DIR += build |
208 | --LIBS += -lutouch-geis -lX11 -lXtst -lXext |
209 | -+LIBS += -lgeis -lX11 -lXtst -lXext |
210 | - //DEFINES = QT_NO_DEBUG_OUTPUT |
211 | - |
212 | - target.path = /usr/bin |
213 | |
214 | === modified file 'debian/patches/series' |
215 | --- debian/patches/series 2012-07-30 15:05:54 +0000 |
216 | +++ debian/patches/series 2012-12-17 15:14:32 +0000 |
217 | @@ -1,1 +0,0 @@ |
218 | -0001-geis_rename.patch |
219 | |
220 | === added file 'documentation/.directory' |
221 | --- documentation/.directory 1970-01-01 00:00:00 +0000 |
222 | +++ documentation/.directory 2012-12-17 15:14:32 +0000 |
223 | @@ -0,0 +1,2 @@ |
224 | +[Desktop Entry] |
225 | +Icon=folder-documents |
226 | |
227 | === added file 'documentation/doxyfile' |
228 | --- documentation/doxyfile 1970-01-01 00:00:00 +0000 |
229 | +++ documentation/doxyfile 2012-12-17 15:14:32 +0000 |
230 | @@ -0,0 +1,1718 @@ |
231 | +# Doxyfile 1.7.3 |
232 | + |
233 | +# This file describes the settings to be used by the documentation system |
234 | +# doxygen (www.doxygen.org) for a project |
235 | +# |
236 | +# All text after a hash (#) is considered a comment and will be ignored |
237 | +# The format is: |
238 | +# TAG = value [value, ...] |
239 | +# For lists items can also be appended using: |
240 | +# TAG += value [value, ...] |
241 | +# Values that contain spaces should be placed between quotes (" ") |
242 | + |
243 | +#--------------------------------------------------------------------------- |
244 | +# Project related configuration options |
245 | +#--------------------------------------------------------------------------- |
246 | + |
247 | +# This tag specifies the encoding used for all characters in the config file |
248 | +# that follow. The default is UTF-8 which is also the encoding used for all |
249 | +# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
250 | +# iconv built into libc) for the transcoding. See |
251 | +# http://www.gnu.org/software/libiconv for the list of possible encodings. |
252 | + |
253 | +DOXYFILE_ENCODING = UTF-8 |
254 | + |
255 | +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
256 | +# by quotes) that should identify the project. |
257 | + |
258 | +PROJECT_NAME = Touchégg |
259 | + |
260 | +# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
261 | +# This could be handy for archiving the generated documentation or |
262 | +# if some version control system is used. |
263 | + |
264 | +PROJECT_NUMBER = 1.0 |
265 | + |
266 | +# Using the PROJECT_BRIEF tag one can provide an optional one line description |
267 | +# for a project that appears at the top of each page and should give viewer |
268 | +# a quick idea about the purpose of the project. Keep the description short. |
269 | + |
270 | +PROJECT_BRIEF = |
271 | + |
272 | +# With the PROJECT_LOGO tag one can specify an logo or icon that is |
273 | +# included in the documentation. The maximum height of the logo should not |
274 | +# exceed 55 pixels and the maximum width should not exceed 200 pixels. |
275 | +# Doxygen will copy the logo to the output directory. |
276 | + |
277 | +PROJECT_LOGO = |
278 | + |
279 | +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
280 | +# base path where the generated documentation will be put. |
281 | +# If a relative path is entered, it will be relative to the location |
282 | +# where doxygen was started. If left blank the current directory will be used. |
283 | + |
284 | +OUTPUT_DIRECTORY = . |
285 | + |
286 | +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
287 | +# 4096 sub-directories (in 2 levels) under the output directory of each output |
288 | +# format and will distribute the generated files over these directories. |
289 | +# Enabling this option can be useful when feeding doxygen a huge amount of |
290 | +# source files, where putting all generated files in the same directory would |
291 | +# otherwise cause performance problems for the file system. |
292 | + |
293 | +CREATE_SUBDIRS = NO |
294 | + |
295 | +# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
296 | +# documentation generated by doxygen is written. Doxygen will use this |
297 | +# information to generate all constant output in the proper language. |
298 | +# The default language is English, other supported languages are: |
299 | +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
300 | +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
301 | +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
302 | +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
303 | +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, |
304 | +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
305 | + |
306 | +OUTPUT_LANGUAGE = English |
307 | + |
308 | +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
309 | +# include brief member descriptions after the members that are listed in |
310 | +# the file and class documentation (similar to JavaDoc). |
311 | +# Set to NO to disable this. |
312 | + |
313 | +BRIEF_MEMBER_DESC = YES |
314 | + |
315 | +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
316 | +# the brief description of a member or function before the detailed description. |
317 | +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
318 | +# brief descriptions will be completely suppressed. |
319 | + |
320 | +REPEAT_BRIEF = YES |
321 | + |
322 | +# This tag implements a quasi-intelligent brief description abbreviator |
323 | +# that is used to form the text in various listings. Each string |
324 | +# in this list, if found as the leading text of the brief description, will be |
325 | +# stripped from the text and the result after processing the whole list, is |
326 | +# used as the annotated text. Otherwise, the brief description is used as-is. |
327 | +# If left blank, the following values are used ("$name" is automatically |
328 | +# replaced with the name of the entity): "The $name class" "The $name widget" |
329 | +# "The $name file" "is" "provides" "specifies" "contains" |
330 | +# "represents" "a" "an" "the" |
331 | + |
332 | +ABBREVIATE_BRIEF = "The $name class" \ |
333 | + "The $name widget" \ |
334 | + "The $name file" \ |
335 | + is \ |
336 | + provides \ |
337 | + specifies \ |
338 | + contains \ |
339 | + represents \ |
340 | + a \ |
341 | + an \ |
342 | + the |
343 | + |
344 | +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
345 | +# Doxygen will generate a detailed section even if there is only a brief |
346 | +# description. |
347 | + |
348 | +ALWAYS_DETAILED_SEC = NO |
349 | + |
350 | +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
351 | +# inherited members of a class in the documentation of that class as if those |
352 | +# members were ordinary class members. Constructors, destructors and assignment |
353 | +# operators of the base classes will not be shown. |
354 | + |
355 | +INLINE_INHERITED_MEMB = NO |
356 | + |
357 | +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
358 | +# path before files name in the file list and in the header files. If set |
359 | +# to NO the shortest path that makes the file name unique will be used. |
360 | + |
361 | +FULL_PATH_NAMES = NO |
362 | + |
363 | +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
364 | +# can be used to strip a user-defined part of the path. Stripping is |
365 | +# only done if one of the specified strings matches the left-hand part of |
366 | +# the path. The tag can be used to show relative paths in the file list. |
367 | +# If left blank the directory from which doxygen is run is used as the |
368 | +# path to strip. |
369 | + |
370 | +STRIP_FROM_PATH = |
371 | + |
372 | +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
373 | +# the path mentioned in the documentation of a class, which tells |
374 | +# the reader which header file to include in order to use a class. |
375 | +# If left blank only the name of the header file containing the class |
376 | +# definition is used. Otherwise one should specify the include paths that |
377 | +# are normally passed to the compiler using the -I flag. |
378 | + |
379 | +STRIP_FROM_INC_PATH = |
380 | + |
381 | +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
382 | +# (but less readable) file names. This can be useful if your file system |
383 | +# doesn't support long names like on DOS, Mac, or CD-ROM. |
384 | + |
385 | +SHORT_NAMES = NO |
386 | + |
387 | +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
388 | +# will interpret the first line (until the first dot) of a JavaDoc-style |
389 | +# comment as the brief description. If set to NO, the JavaDoc |
390 | +# comments will behave just like regular Qt-style comments |
391 | +# (thus requiring an explicit @brief command for a brief description.) |
392 | + |
393 | +JAVADOC_AUTOBRIEF = YES |
394 | + |
395 | +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
396 | +# interpret the first line (until the first dot) of a Qt-style |
397 | +# comment as the brief description. If set to NO, the comments |
398 | +# will behave just like regular Qt-style comments (thus requiring |
399 | +# an explicit \brief command for a brief description.) |
400 | + |
401 | +QT_AUTOBRIEF = NO |
402 | + |
403 | +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
404 | +# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
405 | +# comments) as a brief description. This used to be the default behaviour. |
406 | +# The new default is to treat a multi-line C++ comment block as a detailed |
407 | +# description. Set this tag to YES if you prefer the old behaviour instead. |
408 | + |
409 | +MULTILINE_CPP_IS_BRIEF = NO |
410 | + |
411 | +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
412 | +# member inherits the documentation from any documented member that it |
413 | +# re-implements. |
414 | + |
415 | +INHERIT_DOCS = YES |
416 | + |
417 | +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
418 | +# a new page for each member. If set to NO, the documentation of a member will |
419 | +# be part of the file/class/namespace that contains it. |
420 | + |
421 | +SEPARATE_MEMBER_PAGES = NO |
422 | + |
423 | +# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
424 | +# Doxygen uses this value to replace tabs by spaces in code fragments. |
425 | + |
426 | +TAB_SIZE = 8 |
427 | + |
428 | +# This tag can be used to specify a number of aliases that acts |
429 | +# as commands in the documentation. An alias has the form "name=value". |
430 | +# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
431 | +# put the command \sideeffect (or @sideeffect) in the documentation, which |
432 | +# will result in a user-defined paragraph with heading "Side Effects:". |
433 | +# You can put \n's in the value part of an alias to insert newlines. |
434 | + |
435 | +ALIASES = |
436 | + |
437 | +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
438 | +# sources only. Doxygen will then generate output that is more tailored for C. |
439 | +# For instance, some of the names that are used will be different. The list |
440 | +# of all members will be omitted, etc. |
441 | + |
442 | +OPTIMIZE_OUTPUT_FOR_C = NO |
443 | + |
444 | +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
445 | +# sources only. Doxygen will then generate output that is more tailored for |
446 | +# Java. For instance, namespaces will be presented as packages, qualified |
447 | +# scopes will look different, etc. |
448 | + |
449 | +OPTIMIZE_OUTPUT_JAVA = NO |
450 | + |
451 | +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
452 | +# sources only. Doxygen will then generate output that is more tailored for |
453 | +# Fortran. |
454 | + |
455 | +OPTIMIZE_FOR_FORTRAN = NO |
456 | + |
457 | +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
458 | +# sources. Doxygen will then generate output that is tailored for |
459 | +# VHDL. |
460 | + |
461 | +OPTIMIZE_OUTPUT_VHDL = NO |
462 | + |
463 | +# Doxygen selects the parser to use depending on the extension of the files it |
464 | +# parses. With this tag you can assign which parser to use for a given extension. |
465 | +# Doxygen has a built-in mapping, but you can override or extend it using this |
466 | +# tag. The format is ext=language, where ext is a file extension, and language |
467 | +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
468 | +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
469 | +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
470 | +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
471 | +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
472 | + |
473 | +EXTENSION_MAPPING = |
474 | + |
475 | +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
476 | +# to include (a tag file for) the STL sources as input, then you should |
477 | +# set this tag to YES in order to let doxygen match functions declarations and |
478 | +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
479 | +# func(std::string) {}). This also makes the inheritance and collaboration |
480 | +# diagrams that involve STL classes more complete and accurate. |
481 | + |
482 | +BUILTIN_STL_SUPPORT = NO |
483 | + |
484 | +# If you use Microsoft's C++/CLI language, you should set this option to YES to |
485 | +# enable parsing support. |
486 | + |
487 | +CPP_CLI_SUPPORT = NO |
488 | + |
489 | +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
490 | +# Doxygen will parse them like normal C++ but will assume all classes use public |
491 | +# instead of private inheritance when no explicit protection keyword is present. |
492 | + |
493 | +SIP_SUPPORT = NO |
494 | + |
495 | +# For Microsoft's IDL there are propget and propput attributes to indicate getter |
496 | +# and setter methods for a property. Setting this option to YES (the default) |
497 | +# will make doxygen replace the get and set methods by a property in the |
498 | +# documentation. This will only work if the methods are indeed getting or |
499 | +# setting a simple type. If this is not the case, or you want to show the |
500 | +# methods anyway, you should set this option to NO. |
501 | + |
502 | +IDL_PROPERTY_SUPPORT = YES |
503 | + |
504 | +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
505 | +# tag is set to YES, then doxygen will reuse the documentation of the first |
506 | +# member in the group (if any) for the other members of the group. By default |
507 | +# all members of a group must be documented explicitly. |
508 | + |
509 | +DISTRIBUTE_GROUP_DOC = NO |
510 | + |
511 | +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
512 | +# the same type (for instance a group of public functions) to be put as a |
513 | +# subgroup of that type (e.g. under the Public Functions section). Set it to |
514 | +# NO to prevent subgrouping. Alternatively, this can be done per class using |
515 | +# the \nosubgrouping command. |
516 | + |
517 | +SUBGROUPING = YES |
518 | + |
519 | +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
520 | +# is documented as struct, union, or enum with the name of the typedef. So |
521 | +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
522 | +# with name TypeT. When disabled the typedef will appear as a member of a file, |
523 | +# namespace, or class. And the struct will be named TypeS. This can typically |
524 | +# be useful for C code in case the coding convention dictates that all compound |
525 | +# types are typedef'ed and only the typedef is referenced, never the tag name. |
526 | + |
527 | +TYPEDEF_HIDES_STRUCT = NO |
528 | + |
529 | +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
530 | +# determine which symbols to keep in memory and which to flush to disk. |
531 | +# When the cache is full, less often used symbols will be written to disk. |
532 | +# For small to medium size projects (<1000 input files) the default value is |
533 | +# probably good enough. For larger projects a too small cache size can cause |
534 | +# doxygen to be busy swapping symbols to and from disk most of the time |
535 | +# causing a significant performance penalty. |
536 | +# If the system has enough physical memory increasing the cache will improve the |
537 | +# performance by keeping more symbols in memory. Note that the value works on |
538 | +# a logarithmic scale so increasing the size by one will roughly double the |
539 | +# memory usage. The cache size is given by this formula: |
540 | +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
541 | +# corresponding to a cache size of 2^16 = 65536 symbols |
542 | + |
543 | +SYMBOL_CACHE_SIZE = 0 |
544 | + |
545 | +#--------------------------------------------------------------------------- |
546 | +# Build related configuration options |
547 | +#--------------------------------------------------------------------------- |
548 | + |
549 | +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
550 | +# documentation are documented, even if no documentation was available. |
551 | +# Private class members and static file members will be hidden unless |
552 | +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
553 | + |
554 | +EXTRACT_ALL = YES |
555 | + |
556 | +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
557 | +# will be included in the documentation. |
558 | + |
559 | +EXTRACT_PRIVATE = YES |
560 | + |
561 | +# If the EXTRACT_STATIC tag is set to YES all static members of a file |
562 | +# will be included in the documentation. |
563 | + |
564 | +EXTRACT_STATIC = YES |
565 | + |
566 | +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
567 | +# defined locally in source files will be included in the documentation. |
568 | +# If set to NO only classes defined in header files are included. |
569 | + |
570 | +EXTRACT_LOCAL_CLASSES = YES |
571 | + |
572 | +# This flag is only useful for Objective-C code. When set to YES local |
573 | +# methods, which are defined in the implementation section but not in |
574 | +# the interface are included in the documentation. |
575 | +# If set to NO (the default) only methods in the interface are included. |
576 | + |
577 | +EXTRACT_LOCAL_METHODS = YES |
578 | + |
579 | +# If this flag is set to YES, the members of anonymous namespaces will be |
580 | +# extracted and appear in the documentation as a namespace called |
581 | +# 'anonymous_namespace{file}', where file will be replaced with the base |
582 | +# name of the file that contains the anonymous namespace. By default |
583 | +# anonymous namespaces are hidden. |
584 | + |
585 | +EXTRACT_ANON_NSPACES = NO |
586 | + |
587 | +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
588 | +# undocumented members of documented classes, files or namespaces. |
589 | +# If set to NO (the default) these members will be included in the |
590 | +# various overviews, but no documentation section is generated. |
591 | +# This option has no effect if EXTRACT_ALL is enabled. |
592 | + |
593 | +HIDE_UNDOC_MEMBERS = NO |
594 | + |
595 | +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
596 | +# undocumented classes that are normally visible in the class hierarchy. |
597 | +# If set to NO (the default) these classes will be included in the various |
598 | +# overviews. This option has no effect if EXTRACT_ALL is enabled. |
599 | + |
600 | +HIDE_UNDOC_CLASSES = NO |
601 | + |
602 | +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
603 | +# friend (class|struct|union) declarations. |
604 | +# If set to NO (the default) these declarations will be included in the |
605 | +# documentation. |
606 | + |
607 | +HIDE_FRIEND_COMPOUNDS = NO |
608 | + |
609 | +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
610 | +# documentation blocks found inside the body of a function. |
611 | +# If set to NO (the default) these blocks will be appended to the |
612 | +# function's detailed documentation block. |
613 | + |
614 | +HIDE_IN_BODY_DOCS = NO |
615 | + |
616 | +# The INTERNAL_DOCS tag determines if documentation |
617 | +# that is typed after a \internal command is included. If the tag is set |
618 | +# to NO (the default) then the documentation will be excluded. |
619 | +# Set it to YES to include the internal documentation. |
620 | + |
621 | +INTERNAL_DOCS = NO |
622 | + |
623 | +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
624 | +# file names in lower-case letters. If set to YES upper-case letters are also |
625 | +# allowed. This is useful if you have classes or files whose names only differ |
626 | +# in case and if your file system supports case sensitive file names. Windows |
627 | +# and Mac users are advised to set this option to NO. |
628 | + |
629 | +CASE_SENSE_NAMES = NO |
630 | + |
631 | +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
632 | +# will show members with their full class and namespace scopes in the |
633 | +# documentation. If set to YES the scope will be hidden. |
634 | + |
635 | +HIDE_SCOPE_NAMES = NO |
636 | + |
637 | +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
638 | +# will put a list of the files that are included by a file in the documentation |
639 | +# of that file. |
640 | + |
641 | +SHOW_INCLUDE_FILES = NO |
642 | + |
643 | +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen |
644 | +# will list include files with double quotes in the documentation |
645 | +# rather than with sharp brackets. |
646 | + |
647 | +FORCE_LOCAL_INCLUDES = NO |
648 | + |
649 | +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
650 | +# is inserted in the documentation for inline members. |
651 | + |
652 | +INLINE_INFO = NO |
653 | + |
654 | +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
655 | +# will sort the (detailed) documentation of file and class members |
656 | +# alphabetically by member name. If set to NO the members will appear in |
657 | +# declaration order. |
658 | + |
659 | +SORT_MEMBER_DOCS = YES |
660 | + |
661 | +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
662 | +# brief documentation of file, namespace and class members alphabetically |
663 | +# by member name. If set to NO (the default) the members will appear in |
664 | +# declaration order. |
665 | + |
666 | +SORT_BRIEF_DOCS = NO |
667 | + |
668 | +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
669 | +# will sort the (brief and detailed) documentation of class members so that |
670 | +# constructors and destructors are listed first. If set to NO (the default) |
671 | +# the constructors will appear in the respective orders defined by |
672 | +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
673 | +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
674 | +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
675 | + |
676 | +SORT_MEMBERS_CTORS_1ST = NO |
677 | + |
678 | +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
679 | +# hierarchy of group names into alphabetical order. If set to NO (the default) |
680 | +# the group names will appear in their defined order. |
681 | + |
682 | +SORT_GROUP_NAMES = NO |
683 | + |
684 | +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
685 | +# sorted by fully-qualified names, including namespaces. If set to |
686 | +# NO (the default), the class list will be sorted only by class name, |
687 | +# not including the namespace part. |
688 | +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
689 | +# Note: This option applies only to the class list, not to the |
690 | +# alphabetical list. |
691 | + |
692 | +SORT_BY_SCOPE_NAME = NO |
693 | + |
694 | +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to |
695 | +# do proper type resolution of all parameters of a function it will reject a |
696 | +# match between the prototype and the implementation of a member function even |
697 | +# if there is only one candidate or it is obvious which candidate to choose |
698 | +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen |
699 | +# will still accept a match between prototype and implementation in such cases. |
700 | + |
701 | +STRICT_PROTO_MATCHING = NO |
702 | + |
703 | +# The GENERATE_TODOLIST tag can be used to enable (YES) or |
704 | +# disable (NO) the todo list. This list is created by putting \todo |
705 | +# commands in the documentation. |
706 | + |
707 | +GENERATE_TODOLIST = NO |
708 | + |
709 | +# The GENERATE_TESTLIST tag can be used to enable (YES) or |
710 | +# disable (NO) the test list. This list is created by putting \test |
711 | +# commands in the documentation. |
712 | + |
713 | +GENERATE_TESTLIST = NO |
714 | + |
715 | +# The GENERATE_BUGLIST tag can be used to enable (YES) or |
716 | +# disable (NO) the bug list. This list is created by putting \bug |
717 | +# commands in the documentation. |
718 | + |
719 | +GENERATE_BUGLIST = NO |
720 | + |
721 | +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
722 | +# disable (NO) the deprecated list. This list is created by putting |
723 | +# \deprecated commands in the documentation. |
724 | + |
725 | +GENERATE_DEPRECATEDLIST= NO |
726 | + |
727 | +# The ENABLED_SECTIONS tag can be used to enable conditional |
728 | +# documentation sections, marked by \if sectionname ... \endif. |
729 | + |
730 | +ENABLED_SECTIONS = |
731 | + |
732 | +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
733 | +# the initial value of a variable or macro consists of for it to appear in |
734 | +# the documentation. If the initializer consists of more lines than specified |
735 | +# here it will be hidden. Use a value of 0 to hide initializers completely. |
736 | +# The appearance of the initializer of individual variables and macros in the |
737 | +# documentation can be controlled using \showinitializer or \hideinitializer |
738 | +# command in the documentation regardless of this setting. |
739 | + |
740 | +MAX_INITIALIZER_LINES = 30 |
741 | + |
742 | +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
743 | +# at the bottom of the documentation of classes and structs. If set to YES the |
744 | +# list will mention the files that were used to generate the documentation. |
745 | + |
746 | +SHOW_USED_FILES = NO |
747 | + |
748 | +# If the sources in your project are distributed over multiple directories |
749 | +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
750 | +# in the documentation. The default is NO. |
751 | + |
752 | +SHOW_DIRECTORIES = NO |
753 | + |
754 | +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
755 | +# This will remove the Files entry from the Quick Index and from the |
756 | +# Folder Tree View (if specified). The default is YES. |
757 | + |
758 | +SHOW_FILES = NO |
759 | + |
760 | +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
761 | +# Namespaces page. This will remove the Namespaces entry from the Quick Index |
762 | +# and from the Folder Tree View (if specified). The default is YES. |
763 | + |
764 | +SHOW_NAMESPACES = YES |
765 | + |
766 | +# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
767 | +# doxygen should invoke to get the current version for each file (typically from |
768 | +# the version control system). Doxygen will invoke the program by executing (via |
769 | +# popen()) the command <command> <input-file>, where <command> is the value of |
770 | +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
771 | +# provided by doxygen. Whatever the program writes to standard output |
772 | +# is used as the file version. See the manual for examples. |
773 | + |
774 | +FILE_VERSION_FILTER = |
775 | + |
776 | +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
777 | +# by doxygen. The layout file controls the global structure of the generated |
778 | +# output files in an output format independent way. The create the layout file |
779 | +# that represents doxygen's defaults, run doxygen with the -l option. |
780 | +# You can optionally specify a file name after the option, if omitted |
781 | +# DoxygenLayout.xml will be used as the name of the layout file. |
782 | + |
783 | +LAYOUT_FILE = |
784 | + |
785 | +#--------------------------------------------------------------------------- |
786 | +# configuration options related to warning and progress messages |
787 | +#--------------------------------------------------------------------------- |
788 | + |
789 | +# The QUIET tag can be used to turn on/off the messages that are generated |
790 | +# by doxygen. Possible values are YES and NO. If left blank NO is used. |
791 | + |
792 | +QUIET = NO |
793 | + |
794 | +# The WARNINGS tag can be used to turn on/off the warning messages that are |
795 | +# generated by doxygen. Possible values are YES and NO. If left blank |
796 | +# NO is used. |
797 | + |
798 | +WARNINGS = YES |
799 | + |
800 | +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
801 | +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
802 | +# automatically be disabled. |
803 | + |
804 | +WARN_IF_UNDOCUMENTED = YES |
805 | + |
806 | +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
807 | +# potential errors in the documentation, such as not documenting some |
808 | +# parameters in a documented function, or documenting parameters that |
809 | +# don't exist or using markup commands wrongly. |
810 | + |
811 | +WARN_IF_DOC_ERROR = YES |
812 | + |
813 | +# The WARN_NO_PARAMDOC option can be enabled to get warnings for |
814 | +# functions that are documented, but have no documentation for their parameters |
815 | +# or return value. If set to NO (the default) doxygen will only warn about |
816 | +# wrong or incomplete parameter documentation, but not about the absence of |
817 | +# documentation. |
818 | + |
819 | +WARN_NO_PARAMDOC = YES |
820 | + |
821 | +# The WARN_FORMAT tag determines the format of the warning messages that |
822 | +# doxygen can produce. The string should contain the $file, $line, and $text |
823 | +# tags, which will be replaced by the file and line number from which the |
824 | +# warning originated and the warning text. Optionally the format may contain |
825 | +# $version, which will be replaced by the version of the file (if it could |
826 | +# be obtained via FILE_VERSION_FILTER) |
827 | + |
828 | +WARN_FORMAT = "$file:$line: $text" |
829 | + |
830 | +# The WARN_LOGFILE tag can be used to specify a file to which warning |
831 | +# and error messages should be written. If left blank the output is written |
832 | +# to stderr. |
833 | + |
834 | +WARN_LOGFILE = log |
835 | + |
836 | +#--------------------------------------------------------------------------- |
837 | +# configuration options related to the input files |
838 | +#--------------------------------------------------------------------------- |
839 | + |
840 | +# The INPUT tag can be used to specify the files and/or directories that contain |
841 | +# documented source files. You may enter file names like "myfile.cpp" or |
842 | +# directories like "/usr/src/myproject". Separate the files or directories |
843 | +# with spaces. |
844 | + |
845 | +INPUT = ../src |
846 | + |
847 | +# This tag can be used to specify the character encoding of the source files |
848 | +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
849 | +# also the default input encoding. Doxygen uses libiconv (or the iconv built |
850 | +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
851 | +# the list of possible encodings. |
852 | + |
853 | +INPUT_ENCODING = UTF-8 |
854 | + |
855 | +# If the value of the INPUT tag contains directories, you can use the |
856 | +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
857 | +# and *.h) to filter out the source-files in the directories. If left |
858 | +# blank the following patterns are tested: |
859 | +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
860 | +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
861 | +# *.f90 *.f *.for *.vhd *.vhdl |
862 | + |
863 | +FILE_PATTERNS = *.c \ |
864 | + *.cc \ |
865 | + *.cxx \ |
866 | + *.cpp \ |
867 | + *.c++ \ |
868 | + *.d \ |
869 | + *.java \ |
870 | + *.ii \ |
871 | + *.ixx \ |
872 | + *.ipp \ |
873 | + *.i++ \ |
874 | + *.inl \ |
875 | + *.h \ |
876 | + *.hh \ |
877 | + *.hxx \ |
878 | + *.hpp \ |
879 | + *.h++ \ |
880 | + *.idl \ |
881 | + *.odl \ |
882 | + *.cs \ |
883 | + *.php \ |
884 | + *.php3 \ |
885 | + *.inc \ |
886 | + *.m \ |
887 | + *.mm \ |
888 | + *.dox \ |
889 | + *.py \ |
890 | + *.f90 \ |
891 | + *.f \ |
892 | + *.vhd \ |
893 | + *.vhdl |
894 | + |
895 | +# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
896 | +# should be searched for input files as well. Possible values are YES and NO. |
897 | +# If left blank NO is used. |
898 | + |
899 | +RECURSIVE = YES |
900 | + |
901 | +# The EXCLUDE tag can be used to specify files and/or directories that should |
902 | +# excluded from the INPUT source files. This way you can easily exclude a |
903 | +# subdirectory from a directory tree whose root is specified with the INPUT tag. |
904 | + |
905 | +EXCLUDE = |
906 | + |
907 | +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
908 | +# directories that are symbolic links (a Unix file system feature) are excluded |
909 | +# from the input. |
910 | + |
911 | +EXCLUDE_SYMLINKS = NO |
912 | + |
913 | +# If the value of the INPUT tag contains directories, you can use the |
914 | +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
915 | +# certain files from those directories. Note that the wildcards are matched |
916 | +# against the file with absolute path, so to exclude all test directories |
917 | +# for example use the pattern */test/* |
918 | + |
919 | +EXCLUDE_PATTERNS = |
920 | + |
921 | +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
922 | +# (namespaces, classes, functions, etc.) that should be excluded from the |
923 | +# output. The symbol name can be a fully qualified name, a word, or if the |
924 | +# wildcard * is used, a substring. Examples: ANamespace, AClass, |
925 | +# AClass::ANamespace, ANamespace::*Test |
926 | + |
927 | +EXCLUDE_SYMBOLS = |
928 | + |
929 | +# The EXAMPLE_PATH tag can be used to specify one or more files or |
930 | +# directories that contain example code fragments that are included (see |
931 | +# the \include command). |
932 | + |
933 | +EXAMPLE_PATH = |
934 | + |
935 | +# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
936 | +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
937 | +# and *.h) to filter out the source-files in the directories. If left |
938 | +# blank all files are included. |
939 | + |
940 | +EXAMPLE_PATTERNS = * |
941 | + |
942 | +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
943 | +# searched for input files to be used with the \include or \dontinclude |
944 | +# commands irrespective of the value of the RECURSIVE tag. |
945 | +# Possible values are YES and NO. If left blank NO is used. |
946 | + |
947 | +EXAMPLE_RECURSIVE = NO |
948 | + |
949 | +# The IMAGE_PATH tag can be used to specify one or more files or |
950 | +# directories that contain image that are included in the documentation (see |
951 | +# the \image command). |
952 | + |
953 | +IMAGE_PATH = |
954 | + |
955 | +# The INPUT_FILTER tag can be used to specify a program that doxygen should |
956 | +# invoke to filter for each input file. Doxygen will invoke the filter program |
957 | +# by executing (via popen()) the command <filter> <input-file>, where <filter> |
958 | +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
959 | +# input file. Doxygen will then use the output that the filter program writes |
960 | +# to standard output. If FILTER_PATTERNS is specified, this tag will be |
961 | +# ignored. |
962 | + |
963 | +INPUT_FILTER = |
964 | + |
965 | +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
966 | +# basis. Doxygen will compare the file name with each pattern and apply the |
967 | +# filter if there is a match. The filters are a list of the form: |
968 | +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
969 | +# info on how filters are used. If FILTER_PATTERNS is empty or if |
970 | +# non of the patterns match the file name, INPUT_FILTER is applied. |
971 | + |
972 | +FILTER_PATTERNS = |
973 | + |
974 | +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
975 | +# INPUT_FILTER) will be used to filter the input files when producing source |
976 | +# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
977 | + |
978 | +FILTER_SOURCE_FILES = NO |
979 | + |
980 | +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
981 | +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) |
982 | +# and it is also possible to disable source filtering for a specific pattern |
983 | +# using *.ext= (so without naming a filter). This option only has effect when |
984 | +# FILTER_SOURCE_FILES is enabled. |
985 | + |
986 | +FILTER_SOURCE_PATTERNS = |
987 | + |
988 | +#--------------------------------------------------------------------------- |
989 | +# configuration options related to source browsing |
990 | +#--------------------------------------------------------------------------- |
991 | + |
992 | +# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
993 | +# be generated. Documented entities will be cross-referenced with these sources. |
994 | +# Note: To get rid of all source code in the generated output, make sure also |
995 | +# VERBATIM_HEADERS is set to NO. |
996 | + |
997 | +SOURCE_BROWSER = YES |
998 | + |
999 | +# Setting the INLINE_SOURCES tag to YES will include the body |
1000 | +# of functions and classes directly in the documentation. |
1001 | + |
1002 | +INLINE_SOURCES = NO |
1003 | + |
1004 | +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
1005 | +# doxygen to hide any special comment blocks from generated source code |
1006 | +# fragments. Normal C and C++ comments will always remain visible. |
1007 | + |
1008 | +STRIP_CODE_COMMENTS = NO |
1009 | + |
1010 | +# If the REFERENCED_BY_RELATION tag is set to YES |
1011 | +# then for each documented function all documented |
1012 | +# functions referencing it will be listed. |
1013 | + |
1014 | +REFERENCED_BY_RELATION = NO |
1015 | + |
1016 | +# If the REFERENCES_RELATION tag is set to YES |
1017 | +# then for each documented function all documented entities |
1018 | +# called/used by that function will be listed. |
1019 | + |
1020 | +REFERENCES_RELATION = NO |
1021 | + |
1022 | +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
1023 | +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
1024 | +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
1025 | +# link to the source code. Otherwise they will link to the documentation. |
1026 | + |
1027 | +REFERENCES_LINK_SOURCE = YES |
1028 | + |
1029 | +# If the USE_HTAGS tag is set to YES then the references to source code |
1030 | +# will point to the HTML generated by the htags(1) tool instead of doxygen |
1031 | +# built-in source browser. The htags tool is part of GNU's global source |
1032 | +# tagging system (see http://www.gnu.org/software/global/global.html). You |
1033 | +# will need version 4.8.6 or higher. |
1034 | + |
1035 | +USE_HTAGS = NO |
1036 | + |
1037 | +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
1038 | +# will generate a verbatim copy of the header file for each class for |
1039 | +# which an include is specified. Set to NO to disable this. |
1040 | + |
1041 | +VERBATIM_HEADERS = YES |
1042 | + |
1043 | +#--------------------------------------------------------------------------- |
1044 | +# configuration options related to the alphabetical class index |
1045 | +#--------------------------------------------------------------------------- |
1046 | + |
1047 | +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
1048 | +# of all compounds will be generated. Enable this if the project |
1049 | +# contains a lot of classes, structs, unions or interfaces. |
1050 | + |
1051 | +ALPHABETICAL_INDEX = NO |
1052 | + |
1053 | +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
1054 | +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
1055 | +# in which this list will be split (can be a number in the range [1..20]) |
1056 | + |
1057 | +COLS_IN_ALPHA_INDEX = 5 |
1058 | + |
1059 | +# In case all classes in a project start with a common prefix, all |
1060 | +# classes will be put under the same header in the alphabetical index. |
1061 | +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
1062 | +# should be ignored while generating the index headers. |
1063 | + |
1064 | +IGNORE_PREFIX = |
1065 | + |
1066 | +#--------------------------------------------------------------------------- |
1067 | +# configuration options related to the HTML output |
1068 | +#--------------------------------------------------------------------------- |
1069 | + |
1070 | +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
1071 | +# generate HTML output. |
1072 | + |
1073 | +GENERATE_HTML = YES |
1074 | + |
1075 | +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
1076 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1077 | +# put in front of it. If left blank `html' will be used as the default path. |
1078 | + |
1079 | +HTML_OUTPUT = html |
1080 | + |
1081 | +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
1082 | +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
1083 | +# doxygen will generate files with .html extension. |
1084 | + |
1085 | +HTML_FILE_EXTENSION = .html |
1086 | + |
1087 | +# The HTML_HEADER tag can be used to specify a personal HTML header for |
1088 | +# each generated HTML page. If it is left blank doxygen will generate a |
1089 | +# standard header. |
1090 | + |
1091 | +HTML_HEADER = |
1092 | + |
1093 | +# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
1094 | +# each generated HTML page. If it is left blank doxygen will generate a |
1095 | +# standard footer. |
1096 | + |
1097 | +HTML_FOOTER = |
1098 | + |
1099 | +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
1100 | +# style sheet that is used by each HTML page. It can be used to |
1101 | +# fine-tune the look of the HTML output. If the tag is left blank doxygen |
1102 | +# will generate a default style sheet. Note that doxygen will try to copy |
1103 | +# the style sheet file to the HTML output directory, so don't put your own |
1104 | +# stylesheet in the HTML output directory as well, or it will be erased! |
1105 | + |
1106 | +HTML_STYLESHEET = |
1107 | + |
1108 | +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
1109 | +# Doxygen will adjust the colors in the stylesheet and background images |
1110 | +# according to this color. Hue is specified as an angle on a colorwheel, |
1111 | +# see http://en.wikipedia.org/wiki/Hue for more information. |
1112 | +# For instance the value 0 represents red, 60 is yellow, 120 is green, |
1113 | +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. |
1114 | +# The allowed range is 0 to 359. |
1115 | + |
1116 | +HTML_COLORSTYLE_HUE = 220 |
1117 | + |
1118 | +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of |
1119 | +# the colors in the HTML output. For a value of 0 the output will use |
1120 | +# grayscales only. A value of 255 will produce the most vivid colors. |
1121 | + |
1122 | +HTML_COLORSTYLE_SAT = 100 |
1123 | + |
1124 | +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to |
1125 | +# the luminance component of the colors in the HTML output. Values below |
1126 | +# 100 gradually make the output lighter, whereas values above 100 make |
1127 | +# the output darker. The value divided by 100 is the actual gamma applied, |
1128 | +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, |
1129 | +# and 100 does not change the gamma. |
1130 | + |
1131 | +HTML_COLORSTYLE_GAMMA = 80 |
1132 | + |
1133 | +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
1134 | +# page will contain the date and time when the page was generated. Setting |
1135 | +# this to NO can help when comparing the output of multiple runs. |
1136 | + |
1137 | +HTML_TIMESTAMP = NO |
1138 | + |
1139 | +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
1140 | +# files or namespaces will be aligned in HTML using tables. If set to |
1141 | +# NO a bullet list will be used. |
1142 | + |
1143 | +HTML_ALIGN_MEMBERS = YES |
1144 | + |
1145 | +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
1146 | +# documentation will contain sections that can be hidden and shown after the |
1147 | +# page has loaded. For this to work a browser that supports |
1148 | +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
1149 | +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
1150 | + |
1151 | +HTML_DYNAMIC_SECTIONS = NO |
1152 | + |
1153 | +# If the GENERATE_DOCSET tag is set to YES, additional index files |
1154 | +# will be generated that can be used as input for Apple's Xcode 3 |
1155 | +# integrated development environment, introduced with OSX 10.5 (Leopard). |
1156 | +# To create a documentation set, doxygen will generate a Makefile in the |
1157 | +# HTML output directory. Running make will produce the docset in that |
1158 | +# directory and running "make install" will install the docset in |
1159 | +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
1160 | +# it at startup. |
1161 | +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
1162 | +# for more information. |
1163 | + |
1164 | +GENERATE_DOCSET = NO |
1165 | + |
1166 | +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
1167 | +# feed. A documentation feed provides an umbrella under which multiple |
1168 | +# documentation sets from a single provider (such as a company or product suite) |
1169 | +# can be grouped. |
1170 | + |
1171 | +DOCSET_FEEDNAME = "Doxygen generated docs" |
1172 | + |
1173 | +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
1174 | +# should uniquely identify the documentation set bundle. This should be a |
1175 | +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
1176 | +# will append .docset to the name. |
1177 | + |
1178 | +DOCSET_BUNDLE_ID = org.doxygen.Project |
1179 | + |
1180 | +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify |
1181 | +# the documentation publisher. This should be a reverse domain-name style |
1182 | +# string, e.g. com.mycompany.MyDocSet.documentation. |
1183 | + |
1184 | +DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
1185 | + |
1186 | +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. |
1187 | + |
1188 | +DOCSET_PUBLISHER_NAME = Publisher |
1189 | + |
1190 | +# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
1191 | +# will be generated that can be used as input for tools like the |
1192 | +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
1193 | +# of the generated HTML documentation. |
1194 | + |
1195 | +GENERATE_HTMLHELP = NO |
1196 | + |
1197 | +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
1198 | +# be used to specify the file name of the resulting .chm file. You |
1199 | +# can add a path in front of the file if the result should not be |
1200 | +# written to the html output directory. |
1201 | + |
1202 | +CHM_FILE = |
1203 | + |
1204 | +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
1205 | +# be used to specify the location (absolute path including file name) of |
1206 | +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
1207 | +# the HTML help compiler on the generated index.hhp. |
1208 | + |
1209 | +HHC_LOCATION = |
1210 | + |
1211 | +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
1212 | +# controls if a separate .chi index file is generated (YES) or that |
1213 | +# it should be included in the master .chm file (NO). |
1214 | + |
1215 | +GENERATE_CHI = NO |
1216 | + |
1217 | +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
1218 | +# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
1219 | +# content. |
1220 | + |
1221 | +CHM_INDEX_ENCODING = |
1222 | + |
1223 | +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
1224 | +# controls whether a binary table of contents is generated (YES) or a |
1225 | +# normal table of contents (NO) in the .chm file. |
1226 | + |
1227 | +BINARY_TOC = NO |
1228 | + |
1229 | +# The TOC_EXPAND flag can be set to YES to add extra items for group members |
1230 | +# to the contents of the HTML help documentation and to the tree view. |
1231 | + |
1232 | +TOC_EXPAND = NO |
1233 | + |
1234 | +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
1235 | +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
1236 | +# that can be used as input for Qt's qhelpgenerator to generate a |
1237 | +# Qt Compressed Help (.qch) of the generated HTML documentation. |
1238 | + |
1239 | +GENERATE_QHP = NO |
1240 | + |
1241 | +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
1242 | +# be used to specify the file name of the resulting .qch file. |
1243 | +# The path specified is relative to the HTML output folder. |
1244 | + |
1245 | +QCH_FILE = |
1246 | + |
1247 | +# The QHP_NAMESPACE tag specifies the namespace to use when generating |
1248 | +# Qt Help Project output. For more information please see |
1249 | +# http://doc.trolltech.com/qthelpproject.html#namespace |
1250 | + |
1251 | +QHP_NAMESPACE = org.doxygen.Project |
1252 | + |
1253 | +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
1254 | +# Qt Help Project output. For more information please see |
1255 | +# http://doc.trolltech.com/qthelpproject.html#virtual-folders |
1256 | + |
1257 | +QHP_VIRTUAL_FOLDER = doc |
1258 | + |
1259 | +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
1260 | +# add. For more information please see |
1261 | +# http://doc.trolltech.com/qthelpproject.html#custom-filters |
1262 | + |
1263 | +QHP_CUST_FILTER_NAME = |
1264 | + |
1265 | +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
1266 | +# custom filter to add. For more information please see |
1267 | +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
1268 | +# Qt Help Project / Custom Filters</a>. |
1269 | + |
1270 | +QHP_CUST_FILTER_ATTRS = |
1271 | + |
1272 | +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1273 | +# project's |
1274 | +# filter section matches. |
1275 | +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
1276 | +# Qt Help Project / Filter Attributes</a>. |
1277 | + |
1278 | +QHP_SECT_FILTER_ATTRS = |
1279 | + |
1280 | +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
1281 | +# be used to specify the location of Qt's qhelpgenerator. |
1282 | +# If non-empty doxygen will try to run qhelpgenerator on the generated |
1283 | +# .qhp file. |
1284 | + |
1285 | +QHG_LOCATION = |
1286 | + |
1287 | +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files |
1288 | +# will be generated, which together with the HTML files, form an Eclipse help |
1289 | +# plugin. To install this plugin and make it available under the help contents |
1290 | +# menu in Eclipse, the contents of the directory containing the HTML and XML |
1291 | +# files needs to be copied into the plugins directory of eclipse. The name of |
1292 | +# the directory within the plugins directory should be the same as |
1293 | +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
1294 | +# the help appears. |
1295 | + |
1296 | +GENERATE_ECLIPSEHELP = NO |
1297 | + |
1298 | +# A unique identifier for the eclipse help plugin. When installing the plugin |
1299 | +# the directory name containing the HTML and XML files should also have |
1300 | +# this name. |
1301 | + |
1302 | +ECLIPSE_DOC_ID = org.doxygen.Project |
1303 | + |
1304 | +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
1305 | +# top of each HTML page. The value NO (the default) enables the index and |
1306 | +# the value YES disables it. |
1307 | + |
1308 | +DISABLE_INDEX = NO |
1309 | + |
1310 | +# This tag can be used to set the number of enum values (range [0,1..20]) |
1311 | +# that doxygen will group on one line in the generated HTML documentation. |
1312 | +# Note that a value of 0 will completely suppress the enum values from |
1313 | +# appearing in the overview section. |
1314 | + |
1315 | +ENUM_VALUES_PER_LINE = 4 |
1316 | + |
1317 | +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
1318 | +# structure should be generated to display hierarchical information. |
1319 | +# If the tag value is set to YES, a side panel will be generated |
1320 | +# containing a tree-like index structure (just like the one that |
1321 | +# is generated for HTML Help). For this to work a browser that supports |
1322 | +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
1323 | +# Windows users are probably better off using the HTML help feature. |
1324 | + |
1325 | +GENERATE_TREEVIEW = NO |
1326 | + |
1327 | +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
1328 | +# and Class Hierarchy pages using a tree view instead of an ordered list. |
1329 | + |
1330 | +USE_INLINE_TREES = NO |
1331 | + |
1332 | +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
1333 | +# used to set the initial width (in pixels) of the frame in which the tree |
1334 | +# is shown. |
1335 | + |
1336 | +TREEVIEW_WIDTH = 250 |
1337 | + |
1338 | +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open |
1339 | +# links to external symbols imported via tag files in a separate window. |
1340 | + |
1341 | +EXT_LINKS_IN_WINDOW = NO |
1342 | + |
1343 | +# Use this tag to change the font size of Latex formulas included |
1344 | +# as images in the HTML documentation. The default is 10. Note that |
1345 | +# when you change the font size after a successful doxygen run you need |
1346 | +# to manually remove any form_*.png images from the HTML output directory |
1347 | +# to force them to be regenerated. |
1348 | + |
1349 | +FORMULA_FONTSIZE = 10 |
1350 | + |
1351 | +# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
1352 | +# generated for formulas are transparent PNGs. Transparent PNGs are |
1353 | +# not supported properly for IE 6.0, but are supported on all modern browsers. |
1354 | +# Note that when changing this option you need to delete any form_*.png files |
1355 | +# in the HTML output before the changes have effect. |
1356 | + |
1357 | +FORMULA_TRANSPARENT = YES |
1358 | + |
1359 | +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax |
1360 | +# (see http://www.mathjax.org) which uses client side Javascript for the |
1361 | +# rendering instead of using prerendered bitmaps. Use this if you do not |
1362 | +# have LaTeX installed or if you want to formulas look prettier in the HTML |
1363 | +# output. When enabled you also need to install MathJax separately and |
1364 | +# configure the path to it using the MATHJAX_RELPATH option. |
1365 | + |
1366 | +USE_MATHJAX = NO |
1367 | + |
1368 | +# When MathJax is enabled you need to specify the location relative to the |
1369 | +# HTML output directory using the MATHJAX_RELPATH option. The destination |
1370 | +# directory should contain the MathJax.js script. For instance, if the mathjax |
1371 | +# directory is located at the same level as the HTML output directory, then |
1372 | +# MATHJAX_RELPATH should be ../mathjax. The default value points to the |
1373 | +# mathjax.org site, so you can quickly see the result without installing |
1374 | +# MathJax, but it is strongly recommended to install a local copy of MathJax |
1375 | +# before deployment. |
1376 | + |
1377 | +MATHJAX_RELPATH = http://www.mathjax.org/mathjax |
1378 | + |
1379 | +# When the SEARCHENGINE tag is enabled doxygen will generate a search box |
1380 | +# for the HTML output. The underlying search engine uses javascript |
1381 | +# and DHTML and should work on any modern browser. Note that when using |
1382 | +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
1383 | +# (GENERATE_DOCSET) there is already a search function so this one should |
1384 | +# typically be disabled. For large projects the javascript based search engine |
1385 | +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
1386 | + |
1387 | +SEARCHENGINE = NO |
1388 | + |
1389 | +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
1390 | +# implemented using a PHP enabled web server instead of at the web client |
1391 | +# using Javascript. Doxygen will generate the search PHP script and index |
1392 | +# file to put on the web server. The advantage of the server |
1393 | +# based approach is that it scales better to large projects and allows |
1394 | +# full text search. The disadvantages are that it is more difficult to setup |
1395 | +# and does not have live searching capabilities. |
1396 | + |
1397 | +SERVER_BASED_SEARCH = NO |
1398 | + |
1399 | +#--------------------------------------------------------------------------- |
1400 | +# configuration options related to the LaTeX output |
1401 | +#--------------------------------------------------------------------------- |
1402 | + |
1403 | +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
1404 | +# generate Latex output. |
1405 | + |
1406 | +GENERATE_LATEX = NO |
1407 | + |
1408 | +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
1409 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1410 | +# put in front of it. If left blank `latex' will be used as the default path. |
1411 | + |
1412 | +LATEX_OUTPUT = latex |
1413 | + |
1414 | +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
1415 | +# invoked. If left blank `latex' will be used as the default command name. |
1416 | +# Note that when enabling USE_PDFLATEX this option is only used for |
1417 | +# generating bitmaps for formulas in the HTML output, but not in the |
1418 | +# Makefile that is written to the output directory. |
1419 | + |
1420 | +LATEX_CMD_NAME = latex |
1421 | + |
1422 | +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
1423 | +# generate index for LaTeX. If left blank `makeindex' will be used as the |
1424 | +# default command name. |
1425 | + |
1426 | +MAKEINDEX_CMD_NAME = makeindex |
1427 | + |
1428 | +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
1429 | +# LaTeX documents. This may be useful for small projects and may help to |
1430 | +# save some trees in general. |
1431 | + |
1432 | +COMPACT_LATEX = NO |
1433 | + |
1434 | +# The PAPER_TYPE tag can be used to set the paper type that is used |
1435 | +# by the printer. Possible values are: a4, letter, legal and |
1436 | +# executive. If left blank a4wide will be used. |
1437 | + |
1438 | +PAPER_TYPE = a4wide |
1439 | + |
1440 | +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
1441 | +# packages that should be included in the LaTeX output. |
1442 | + |
1443 | +EXTRA_PACKAGES = |
1444 | + |
1445 | +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
1446 | +# the generated latex document. The header should contain everything until |
1447 | +# the first chapter. If it is left blank doxygen will generate a |
1448 | +# standard header. Notice: only use this tag if you know what you are doing! |
1449 | + |
1450 | +LATEX_HEADER = |
1451 | + |
1452 | +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
1453 | +# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
1454 | +# contain links (just like the HTML output) instead of page references |
1455 | +# This makes the output suitable for online browsing using a pdf viewer. |
1456 | + |
1457 | +PDF_HYPERLINKS = YES |
1458 | + |
1459 | +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
1460 | +# plain latex in the generated Makefile. Set this option to YES to get a |
1461 | +# higher quality PDF documentation. |
1462 | + |
1463 | +USE_PDFLATEX = YES |
1464 | + |
1465 | +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
1466 | +# command to the generated LaTeX files. This will instruct LaTeX to keep |
1467 | +# running if errors occur, instead of asking the user for help. |
1468 | +# This option is also used when generating formulas in HTML. |
1469 | + |
1470 | +LATEX_BATCHMODE = NO |
1471 | + |
1472 | +# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
1473 | +# include the index chapters (such as File Index, Compound Index, etc.) |
1474 | +# in the output. |
1475 | + |
1476 | +LATEX_HIDE_INDICES = NO |
1477 | + |
1478 | +# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
1479 | +# source code with syntax highlighting in the LaTeX output. |
1480 | +# Note that which sources are shown also depends on other settings |
1481 | +# such as SOURCE_BROWSER. |
1482 | + |
1483 | +LATEX_SOURCE_CODE = NO |
1484 | + |
1485 | +#--------------------------------------------------------------------------- |
1486 | +# configuration options related to the RTF output |
1487 | +#--------------------------------------------------------------------------- |
1488 | + |
1489 | +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
1490 | +# The RTF output is optimized for Word 97 and may not look very pretty with |
1491 | +# other RTF readers or editors. |
1492 | + |
1493 | +GENERATE_RTF = NO |
1494 | + |
1495 | +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
1496 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1497 | +# put in front of it. If left blank `rtf' will be used as the default path. |
1498 | + |
1499 | +RTF_OUTPUT = rtf |
1500 | + |
1501 | +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
1502 | +# RTF documents. This may be useful for small projects and may help to |
1503 | +# save some trees in general. |
1504 | + |
1505 | +COMPACT_RTF = NO |
1506 | + |
1507 | +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
1508 | +# will contain hyperlink fields. The RTF file will |
1509 | +# contain links (just like the HTML output) instead of page references. |
1510 | +# This makes the output suitable for online browsing using WORD or other |
1511 | +# programs which support those fields. |
1512 | +# Note: wordpad (write) and others do not support links. |
1513 | + |
1514 | +RTF_HYPERLINKS = NO |
1515 | + |
1516 | +# Load stylesheet definitions from file. Syntax is similar to doxygen's |
1517 | +# config file, i.e. a series of assignments. You only have to provide |
1518 | +# replacements, missing definitions are set to their default value. |
1519 | + |
1520 | +RTF_STYLESHEET_FILE = |
1521 | + |
1522 | +# Set optional variables used in the generation of an rtf document. |
1523 | +# Syntax is similar to doxygen's config file. |
1524 | + |
1525 | +RTF_EXTENSIONS_FILE = |
1526 | + |
1527 | +#--------------------------------------------------------------------------- |
1528 | +# configuration options related to the man page output |
1529 | +#--------------------------------------------------------------------------- |
1530 | + |
1531 | +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
1532 | +# generate man pages |
1533 | + |
1534 | +GENERATE_MAN = NO |
1535 | + |
1536 | +# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
1537 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1538 | +# put in front of it. If left blank `man' will be used as the default path. |
1539 | + |
1540 | +MAN_OUTPUT = man |
1541 | + |
1542 | +# The MAN_EXTENSION tag determines the extension that is added to |
1543 | +# the generated man pages (default is the subroutine's section .3) |
1544 | + |
1545 | +MAN_EXTENSION = .3 |
1546 | + |
1547 | +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
1548 | +# then it will generate one additional man file for each entity |
1549 | +# documented in the real man page(s). These additional files |
1550 | +# only source the real man page, but without them the man command |
1551 | +# would be unable to find the correct page. The default is NO. |
1552 | + |
1553 | +MAN_LINKS = NO |
1554 | + |
1555 | +#--------------------------------------------------------------------------- |
1556 | +# configuration options related to the XML output |
1557 | +#--------------------------------------------------------------------------- |
1558 | + |
1559 | +# If the GENERATE_XML tag is set to YES Doxygen will |
1560 | +# generate an XML file that captures the structure of |
1561 | +# the code including all documentation. |
1562 | + |
1563 | +GENERATE_XML = NO |
1564 | + |
1565 | +# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
1566 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1567 | +# put in front of it. If left blank `xml' will be used as the default path. |
1568 | + |
1569 | +XML_OUTPUT = xml |
1570 | + |
1571 | +# The XML_SCHEMA tag can be used to specify an XML schema, |
1572 | +# which can be used by a validating XML parser to check the |
1573 | +# syntax of the XML files. |
1574 | + |
1575 | +XML_SCHEMA = |
1576 | + |
1577 | +# The XML_DTD tag can be used to specify an XML DTD, |
1578 | +# which can be used by a validating XML parser to check the |
1579 | +# syntax of the XML files. |
1580 | + |
1581 | +XML_DTD = |
1582 | + |
1583 | +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
1584 | +# dump the program listings (including syntax highlighting |
1585 | +# and cross-referencing information) to the XML output. Note that |
1586 | +# enabling this will significantly increase the size of the XML output. |
1587 | + |
1588 | +XML_PROGRAMLISTING = YES |
1589 | + |
1590 | +#--------------------------------------------------------------------------- |
1591 | +# configuration options for the AutoGen Definitions output |
1592 | +#--------------------------------------------------------------------------- |
1593 | + |
1594 | +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1595 | +# generate an AutoGen Definitions (see autogen.sf.net) file |
1596 | +# that captures the structure of the code including all |
1597 | +# documentation. Note that this feature is still experimental |
1598 | +# and incomplete at the moment. |
1599 | + |
1600 | +GENERATE_AUTOGEN_DEF = NO |
1601 | + |
1602 | +#--------------------------------------------------------------------------- |
1603 | +# configuration options related to the Perl module output |
1604 | +#--------------------------------------------------------------------------- |
1605 | + |
1606 | +# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
1607 | +# generate a Perl module file that captures the structure of |
1608 | +# the code including all documentation. Note that this |
1609 | +# feature is still experimental and incomplete at the |
1610 | +# moment. |
1611 | + |
1612 | +GENERATE_PERLMOD = NO |
1613 | + |
1614 | +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
1615 | +# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
1616 | +# to generate PDF and DVI output from the Perl module output. |
1617 | + |
1618 | +PERLMOD_LATEX = NO |
1619 | + |
1620 | +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
1621 | +# nicely formatted so it can be parsed by a human reader. This is useful |
1622 | +# if you want to understand what is going on. On the other hand, if this |
1623 | +# tag is set to NO the size of the Perl module output will be much smaller |
1624 | +# and Perl will parse it just the same. |
1625 | + |
1626 | +PERLMOD_PRETTY = YES |
1627 | + |
1628 | +# The names of the make variables in the generated doxyrules.make file |
1629 | +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
1630 | +# This is useful so different doxyrules.make files included by the same |
1631 | +# Makefile don't overwrite each other's variables. |
1632 | + |
1633 | +PERLMOD_MAKEVAR_PREFIX = |
1634 | + |
1635 | +#--------------------------------------------------------------------------- |
1636 | +# Configuration options related to the preprocessor |
1637 | +#--------------------------------------------------------------------------- |
1638 | + |
1639 | +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
1640 | +# evaluate all C-preprocessor directives found in the sources and include |
1641 | +# files. |
1642 | + |
1643 | +ENABLE_PREPROCESSING = YES |
1644 | + |
1645 | +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1646 | +# names in the source code. If set to NO (the default) only conditional |
1647 | +# compilation will be performed. Macro expansion can be done in a controlled |
1648 | +# way by setting EXPAND_ONLY_PREDEF to YES. |
1649 | + |
1650 | +MACRO_EXPANSION = NO |
1651 | + |
1652 | +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
1653 | +# then the macro expansion is limited to the macros specified with the |
1654 | +# PREDEFINED and EXPAND_AS_DEFINED tags. |
1655 | + |
1656 | +EXPAND_ONLY_PREDEF = NO |
1657 | + |
1658 | +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
1659 | +# in the INCLUDE_PATH (see below) will be search if a #include is found. |
1660 | + |
1661 | +SEARCH_INCLUDES = YES |
1662 | + |
1663 | +# The INCLUDE_PATH tag can be used to specify one or more directories that |
1664 | +# contain include files that are not input files but should be processed by |
1665 | +# the preprocessor. |
1666 | + |
1667 | +INCLUDE_PATH = |
1668 | + |
1669 | +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
1670 | +# patterns (like *.h and *.hpp) to filter out the header-files in the |
1671 | +# directories. If left blank, the patterns specified with FILE_PATTERNS will |
1672 | +# be used. |
1673 | + |
1674 | +INCLUDE_FILE_PATTERNS = |
1675 | + |
1676 | +# The PREDEFINED tag can be used to specify one or more macro names that |
1677 | +# are defined before the preprocessor is started (similar to the -D option of |
1678 | +# gcc). The argument of the tag is a list of macros of the form: name |
1679 | +# or name=definition (no spaces). If the definition and the = are |
1680 | +# omitted =1 is assumed. To prevent a macro definition from being |
1681 | +# undefined via #undef or recursively expanded use the := operator |
1682 | +# instead of the = operator. |
1683 | + |
1684 | +PREDEFINED = |
1685 | + |
1686 | +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
1687 | +# this tag can be used to specify a list of macro names that should be expanded. |
1688 | +# The macro definition that is found in the sources will be used. |
1689 | +# Use the PREDEFINED tag if you want to use a different macro definition that |
1690 | +# overrules the definition found in the source code. |
1691 | + |
1692 | +EXPAND_AS_DEFINED = |
1693 | + |
1694 | +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
1695 | +# doxygen's preprocessor will remove all references to function-like macros |
1696 | +# that are alone on a line, have an all uppercase name, and do not end with a |
1697 | +# semicolon, because these will confuse the parser if not removed. |
1698 | + |
1699 | +SKIP_FUNCTION_MACROS = YES |
1700 | + |
1701 | +#--------------------------------------------------------------------------- |
1702 | +# Configuration::additions related to external references |
1703 | +#--------------------------------------------------------------------------- |
1704 | + |
1705 | +# The TAGFILES option can be used to specify one or more tagfiles. |
1706 | +# Optionally an initial location of the external documentation |
1707 | +# can be added for each tagfile. The format of a tag file without |
1708 | +# this location is as follows: |
1709 | +# TAGFILES = file1 file2 ... |
1710 | +# Adding location for the tag files is done as follows: |
1711 | +# TAGFILES = file1=loc1 "file2 = loc2" ... |
1712 | +# where "loc1" and "loc2" can be relative or absolute paths or |
1713 | +# URLs. If a location is present for each tag, the installdox tool |
1714 | +# does not have to be run to correct the links. |
1715 | +# Note that each tag file must have a unique name |
1716 | +# (where the name does NOT include the path) |
1717 | +# If a tag file is not located in the directory in which doxygen |
1718 | +# is run, you must also specify the path to the tagfile here. |
1719 | + |
1720 | +TAGFILES = |
1721 | + |
1722 | +# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
1723 | +# a tag file that is based on the input files it reads. |
1724 | + |
1725 | +GENERATE_TAGFILE = |
1726 | + |
1727 | +# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
1728 | +# in the class index. If set to NO only the inherited external classes |
1729 | +# will be listed. |
1730 | + |
1731 | +ALLEXTERNALS = NO |
1732 | + |
1733 | +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
1734 | +# in the modules index. If set to NO, only the current project's groups will |
1735 | +# be listed. |
1736 | + |
1737 | +EXTERNAL_GROUPS = YES |
1738 | + |
1739 | +# The PERL_PATH should be the absolute path and name of the perl script |
1740 | +# interpreter (i.e. the result of `which perl'). |
1741 | + |
1742 | +PERL_PATH = /usr/bin/perl |
1743 | + |
1744 | +#--------------------------------------------------------------------------- |
1745 | +# Configuration options related to the dot tool |
1746 | +#--------------------------------------------------------------------------- |
1747 | + |
1748 | +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1749 | +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1750 | +# or super classes. Setting the tag to NO turns the diagrams off. Note that |
1751 | +# this option also works with HAVE_DOT disabled, but it is recommended to |
1752 | +# install and use dot, since it yields more powerful graphs. |
1753 | + |
1754 | +CLASS_DIAGRAMS = NO |
1755 | + |
1756 | +# You can define message sequence charts within doxygen comments using the \msc |
1757 | +# command. Doxygen will then run the mscgen tool (see |
1758 | +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
1759 | +# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
1760 | +# the mscgen tool resides. If left empty the tool is assumed to be found in the |
1761 | +# default search path. |
1762 | + |
1763 | +MSCGEN_PATH = |
1764 | + |
1765 | +# If set to YES, the inheritance and collaboration graphs will hide |
1766 | +# inheritance and usage relations if the target is undocumented |
1767 | +# or is not a class. |
1768 | + |
1769 | +HIDE_UNDOC_RELATIONS = YES |
1770 | + |
1771 | +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
1772 | +# available from the path. This tool is part of Graphviz, a graph visualization |
1773 | +# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
1774 | +# have no effect if this option is set to NO (the default) |
1775 | + |
1776 | +HAVE_DOT = NO |
1777 | + |
1778 | +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
1779 | +# allowed to run in parallel. When set to 0 (the default) doxygen will |
1780 | +# base this on the number of processors available in the system. You can set it |
1781 | +# explicitly to a value larger than 0 to get control over the balance |
1782 | +# between CPU load and processing speed. |
1783 | + |
1784 | +DOT_NUM_THREADS = 0 |
1785 | + |
1786 | +# By default doxygen will write a font called Helvetica to the output |
1787 | +# directory and reference it in all dot files that doxygen generates. |
1788 | +# When you want a differently looking font you can specify the font name |
1789 | +# using DOT_FONTNAME. You need to make sure dot is able to find the font, |
1790 | +# which can be done by putting it in a standard location or by setting the |
1791 | +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
1792 | +# containing the font. |
1793 | + |
1794 | +DOT_FONTNAME = FreeSans |
1795 | + |
1796 | +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
1797 | +# The default size is 10pt. |
1798 | + |
1799 | +DOT_FONTSIZE = 10 |
1800 | + |
1801 | +# By default doxygen will tell dot to use the output directory to look for the |
1802 | +# FreeSans.ttf font (which doxygen will put there itself). If you specify a |
1803 | +# different font using DOT_FONTNAME you can set the path where dot |
1804 | +# can find it using this tag. |
1805 | + |
1806 | +DOT_FONTPATH = |
1807 | + |
1808 | +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1809 | +# will generate a graph for each documented class showing the direct and |
1810 | +# indirect inheritance relations. Setting this tag to YES will force the |
1811 | +# the CLASS_DIAGRAMS tag to NO. |
1812 | + |
1813 | +CLASS_GRAPH = YES |
1814 | + |
1815 | +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1816 | +# will generate a graph for each documented class showing the direct and |
1817 | +# indirect implementation dependencies (inheritance, containment, and |
1818 | +# class references variables) of the class with other documented classes. |
1819 | + |
1820 | +COLLABORATION_GRAPH = YES |
1821 | + |
1822 | +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1823 | +# will generate a graph for groups, showing the direct groups dependencies |
1824 | + |
1825 | +GROUP_GRAPHS = YES |
1826 | + |
1827 | +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1828 | +# collaboration diagrams in a style similar to the OMG's Unified Modeling |
1829 | +# Language. |
1830 | + |
1831 | +UML_LOOK = NO |
1832 | + |
1833 | +# If set to YES, the inheritance and collaboration graphs will show the |
1834 | +# relations between templates and their instances. |
1835 | + |
1836 | +TEMPLATE_RELATIONS = NO |
1837 | + |
1838 | +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
1839 | +# tags are set to YES then doxygen will generate a graph for each documented |
1840 | +# file showing the direct and indirect include dependencies of the file with |
1841 | +# other documented files. |
1842 | + |
1843 | +INCLUDE_GRAPH = YES |
1844 | + |
1845 | +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
1846 | +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
1847 | +# documented header file showing the documented files that directly or |
1848 | +# indirectly include this file. |
1849 | + |
1850 | +INCLUDED_BY_GRAPH = YES |
1851 | + |
1852 | +# If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1853 | +# doxygen will generate a call dependency graph for every global function |
1854 | +# or class method. Note that enabling this option will significantly increase |
1855 | +# the time of a run. So in most cases it will be better to enable call graphs |
1856 | +# for selected functions only using the \callgraph command. |
1857 | + |
1858 | +CALL_GRAPH = YES |
1859 | + |
1860 | +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
1861 | +# doxygen will generate a caller dependency graph for every global function |
1862 | +# or class method. Note that enabling this option will significantly increase |
1863 | +# the time of a run. So in most cases it will be better to enable caller |
1864 | +# graphs for selected functions only using the \callergraph command. |
1865 | + |
1866 | +CALLER_GRAPH = YES |
1867 | + |
1868 | +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1869 | +# will generate a graphical hierarchy of all classes instead of a textual one. |
1870 | + |
1871 | +GRAPHICAL_HIERARCHY = YES |
1872 | + |
1873 | +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
1874 | +# then doxygen will show the dependencies a directory has on other directories |
1875 | +# in a graphical way. The dependency relations are determined by the #include |
1876 | +# relations between the files in the directories. |
1877 | + |
1878 | +DIRECTORY_GRAPH = YES |
1879 | + |
1880 | +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1881 | +# generated by dot. Possible values are png, svg, gif or svg. |
1882 | +# If left blank png will be used. |
1883 | + |
1884 | +DOT_IMAGE_FORMAT = png |
1885 | + |
1886 | +# The tag DOT_PATH can be used to specify the path where the dot tool can be |
1887 | +# found. If left blank, it is assumed the dot tool can be found in the path. |
1888 | + |
1889 | +DOT_PATH = |
1890 | + |
1891 | +# The DOTFILE_DIRS tag can be used to specify one or more directories that |
1892 | +# contain dot files that are included in the documentation (see the |
1893 | +# \dotfile command). |
1894 | + |
1895 | +DOTFILE_DIRS = |
1896 | + |
1897 | +# The MSCFILE_DIRS tag can be used to specify one or more directories that |
1898 | +# contain msc files that are included in the documentation (see the |
1899 | +# \mscfile command). |
1900 | + |
1901 | +MSCFILE_DIRS = |
1902 | + |
1903 | +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1904 | +# nodes that will be shown in the graph. If the number of nodes in a graph |
1905 | +# becomes larger than this value, doxygen will truncate the graph, which is |
1906 | +# visualized by representing a node as a red box. Note that doxygen if the |
1907 | +# number of direct children of the root node in a graph is already larger than |
1908 | +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
1909 | +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1910 | + |
1911 | +DOT_GRAPH_MAX_NODES = 50 |
1912 | + |
1913 | +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1914 | +# graphs generated by dot. A depth value of 3 means that only nodes reachable |
1915 | +# from the root by following a path via at most 3 edges will be shown. Nodes |
1916 | +# that lay further from the root node will be omitted. Note that setting this |
1917 | +# option to 1 or 2 may greatly reduce the computation time needed for large |
1918 | +# code bases. Also note that the size of a graph can be further restricted by |
1919 | +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1920 | + |
1921 | +MAX_DOT_GRAPH_DEPTH = 0 |
1922 | + |
1923 | +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1924 | +# background. This is disabled by default, because dot on Windows does not |
1925 | +# seem to support this out of the box. Warning: Depending on the platform used, |
1926 | +# enabling this option may lead to badly anti-aliased labels on the edges of |
1927 | +# a graph (i.e. they become hard to read). |
1928 | + |
1929 | +DOT_TRANSPARENT = NO |
1930 | + |
1931 | +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
1932 | +# files in one run (i.e. multiple -o and -T options on the command line). This |
1933 | +# makes dot run faster, but since only newer versions of dot (>1.8.10) |
1934 | +# support this, this feature is disabled by default. |
1935 | + |
1936 | +DOT_MULTI_TARGETS = NO |
1937 | + |
1938 | +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1939 | +# generate a legend page explaining the meaning of the various boxes and |
1940 | +# arrows in the dot generated graphs. |
1941 | + |
1942 | +GENERATE_LEGEND = YES |
1943 | + |
1944 | +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
1945 | +# remove the intermediate dot files that are used to generate |
1946 | +# the various graphs. |
1947 | + |
1948 | +DOT_CLEANUP = YES |
1949 | |
1950 | === removed file 'documentation/doxyfile_en' |
1951 | --- documentation/doxyfile_en 2011-08-18 16:21:09 +0000 |
1952 | +++ documentation/doxyfile_en 1970-01-01 00:00:00 +0000 |
1953 | @@ -1,1661 +0,0 @@ |
1954 | -# Doxyfile 1.7.1 |
1955 | - |
1956 | -# This file describes the settings to be used by the documentation system |
1957 | -# doxygen (www.doxygen.org) for a project |
1958 | -# |
1959 | -# All text after a hash (#) is considered a comment and will be ignored |
1960 | -# The format is: |
1961 | -# TAG = value [value, ...] |
1962 | -# For lists items can also be appended using: |
1963 | -# TAG += value [value, ...] |
1964 | -# Values that contain spaces should be placed between quotes (" ") |
1965 | - |
1966 | -#--------------------------------------------------------------------------- |
1967 | -# Project related configuration options |
1968 | -#--------------------------------------------------------------------------- |
1969 | - |
1970 | -# This tag specifies the encoding used for all characters in the config file |
1971 | -# that follow. The default is UTF-8 which is also the encoding used for all |
1972 | -# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
1973 | -# iconv built into libc) for the transcoding. See |
1974 | -# http://www.gnu.org/software/libiconv for the list of possible encodings. |
1975 | - |
1976 | -DOXYFILE_ENCODING = UTF-8 |
1977 | - |
1978 | -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
1979 | -# by quotes) that should identify the project. |
1980 | - |
1981 | -PROJECT_NAME = Touchégg |
1982 | - |
1983 | -# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
1984 | -# This could be handy for archiving the generated documentation or |
1985 | -# if some version control system is used. |
1986 | - |
1987 | -PROJECT_NUMBER = 0.2 |
1988 | - |
1989 | -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
1990 | -# base path where the generated documentation will be put. |
1991 | -# If a relative path is entered, it will be relative to the location |
1992 | -# where doxygen was started. If left blank the current directory will be used. |
1993 | - |
1994 | -OUTPUT_DIRECTORY = . |
1995 | - |
1996 | -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
1997 | -# 4096 sub-directories (in 2 levels) under the output directory of each output |
1998 | -# format and will distribute the generated files over these directories. |
1999 | -# Enabling this option can be useful when feeding doxygen a huge amount of |
2000 | -# source files, where putting all generated files in the same directory would |
2001 | -# otherwise cause performance problems for the file system. |
2002 | - |
2003 | -CREATE_SUBDIRS = NO |
2004 | - |
2005 | -# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
2006 | -# documentation generated by doxygen is written. Doxygen will use this |
2007 | -# information to generate all constant output in the proper language. |
2008 | -# The default language is English, other supported languages are: |
2009 | -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
2010 | -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
2011 | -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
2012 | -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
2013 | -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, |
2014 | -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
2015 | - |
2016 | -OUTPUT_LANGUAGE = English |
2017 | - |
2018 | -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
2019 | -# include brief member descriptions after the members that are listed in |
2020 | -# the file and class documentation (similar to JavaDoc). |
2021 | -# Set to NO to disable this. |
2022 | - |
2023 | -BRIEF_MEMBER_DESC = YES |
2024 | - |
2025 | -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
2026 | -# the brief description of a member or function before the detailed description. |
2027 | -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
2028 | -# brief descriptions will be completely suppressed. |
2029 | - |
2030 | -REPEAT_BRIEF = YES |
2031 | - |
2032 | -# This tag implements a quasi-intelligent brief description abbreviator |
2033 | -# that is used to form the text in various listings. Each string |
2034 | -# in this list, if found as the leading text of the brief description, will be |
2035 | -# stripped from the text and the result after processing the whole list, is |
2036 | -# used as the annotated text. Otherwise, the brief description is used as-is. |
2037 | -# If left blank, the following values are used ("$name" is automatically |
2038 | -# replaced with the name of the entity): "The $name class" "The $name widget" |
2039 | -# "The $name file" "is" "provides" "specifies" "contains" |
2040 | -# "represents" "a" "an" "the" |
2041 | - |
2042 | -ABBREVIATE_BRIEF = "The $name class" \ |
2043 | - "The $name widget" \ |
2044 | - "The $name file" \ |
2045 | - is \ |
2046 | - provides \ |
2047 | - specifies \ |
2048 | - contains \ |
2049 | - represents \ |
2050 | - a \ |
2051 | - an \ |
2052 | - the |
2053 | - |
2054 | -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
2055 | -# Doxygen will generate a detailed section even if there is only a brief |
2056 | -# description. |
2057 | - |
2058 | -ALWAYS_DETAILED_SEC = NO |
2059 | - |
2060 | -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
2061 | -# inherited members of a class in the documentation of that class as if those |
2062 | -# members were ordinary class members. Constructors, destructors and assignment |
2063 | -# operators of the base classes will not be shown. |
2064 | - |
2065 | -INLINE_INHERITED_MEMB = NO |
2066 | - |
2067 | -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
2068 | -# path before files name in the file list and in the header files. If set |
2069 | -# to NO the shortest path that makes the file name unique will be used. |
2070 | - |
2071 | -FULL_PATH_NAMES = NO |
2072 | - |
2073 | -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
2074 | -# can be used to strip a user-defined part of the path. Stripping is |
2075 | -# only done if one of the specified strings matches the left-hand part of |
2076 | -# the path. The tag can be used to show relative paths in the file list. |
2077 | -# If left blank the directory from which doxygen is run is used as the |
2078 | -# path to strip. |
2079 | - |
2080 | -STRIP_FROM_PATH = |
2081 | - |
2082 | -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
2083 | -# the path mentioned in the documentation of a class, which tells |
2084 | -# the reader which header file to include in order to use a class. |
2085 | -# If left blank only the name of the header file containing the class |
2086 | -# definition is used. Otherwise one should specify the include paths that |
2087 | -# are normally passed to the compiler using the -I flag. |
2088 | - |
2089 | -STRIP_FROM_INC_PATH = |
2090 | - |
2091 | -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
2092 | -# (but less readable) file names. This can be useful is your file systems |
2093 | -# doesn't support long names like on DOS, Mac, or CD-ROM. |
2094 | - |
2095 | -SHORT_NAMES = NO |
2096 | - |
2097 | -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
2098 | -# will interpret the first line (until the first dot) of a JavaDoc-style |
2099 | -# comment as the brief description. If set to NO, the JavaDoc |
2100 | -# comments will behave just like regular Qt-style comments |
2101 | -# (thus requiring an explicit @brief command for a brief description.) |
2102 | - |
2103 | -JAVADOC_AUTOBRIEF = YES |
2104 | - |
2105 | -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
2106 | -# interpret the first line (until the first dot) of a Qt-style |
2107 | -# comment as the brief description. If set to NO, the comments |
2108 | -# will behave just like regular Qt-style comments (thus requiring |
2109 | -# an explicit \brief command for a brief description.) |
2110 | - |
2111 | -QT_AUTOBRIEF = NO |
2112 | - |
2113 | -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
2114 | -# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
2115 | -# comments) as a brief description. This used to be the default behaviour. |
2116 | -# The new default is to treat a multi-line C++ comment block as a detailed |
2117 | -# description. Set this tag to YES if you prefer the old behaviour instead. |
2118 | - |
2119 | -MULTILINE_CPP_IS_BRIEF = NO |
2120 | - |
2121 | -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
2122 | -# member inherits the documentation from any documented member that it |
2123 | -# re-implements. |
2124 | - |
2125 | -INHERIT_DOCS = YES |
2126 | - |
2127 | -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
2128 | -# a new page for each member. If set to NO, the documentation of a member will |
2129 | -# be part of the file/class/namespace that contains it. |
2130 | - |
2131 | -SEPARATE_MEMBER_PAGES = NO |
2132 | - |
2133 | -# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
2134 | -# Doxygen uses this value to replace tabs by spaces in code fragments. |
2135 | - |
2136 | -TAB_SIZE = 8 |
2137 | - |
2138 | -# This tag can be used to specify a number of aliases that acts |
2139 | -# as commands in the documentation. An alias has the form "name=value". |
2140 | -# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
2141 | -# put the command \sideeffect (or @sideeffect) in the documentation, which |
2142 | -# will result in a user-defined paragraph with heading "Side Effects:". |
2143 | -# You can put \n's in the value part of an alias to insert newlines. |
2144 | - |
2145 | -ALIASES = |
2146 | - |
2147 | -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
2148 | -# sources only. Doxygen will then generate output that is more tailored for C. |
2149 | -# For instance, some of the names that are used will be different. The list |
2150 | -# of all members will be omitted, etc. |
2151 | - |
2152 | -OPTIMIZE_OUTPUT_FOR_C = NO |
2153 | - |
2154 | -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
2155 | -# sources only. Doxygen will then generate output that is more tailored for |
2156 | -# Java. For instance, namespaces will be presented as packages, qualified |
2157 | -# scopes will look different, etc. |
2158 | - |
2159 | -OPTIMIZE_OUTPUT_JAVA = NO |
2160 | - |
2161 | -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
2162 | -# sources only. Doxygen will then generate output that is more tailored for |
2163 | -# Fortran. |
2164 | - |
2165 | -OPTIMIZE_FOR_FORTRAN = NO |
2166 | - |
2167 | -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
2168 | -# sources. Doxygen will then generate output that is tailored for |
2169 | -# VHDL. |
2170 | - |
2171 | -OPTIMIZE_OUTPUT_VHDL = NO |
2172 | - |
2173 | -# Doxygen selects the parser to use depending on the extension of the files it |
2174 | -# parses. With this tag you can assign which parser to use for a given extension. |
2175 | -# Doxygen has a built-in mapping, but you can override or extend it using this |
2176 | -# tag. The format is ext=language, where ext is a file extension, and language |
2177 | -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
2178 | -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
2179 | -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
2180 | -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
2181 | -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
2182 | - |
2183 | -EXTENSION_MAPPING = |
2184 | - |
2185 | -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
2186 | -# to include (a tag file for) the STL sources as input, then you should |
2187 | -# set this tag to YES in order to let doxygen match functions declarations and |
2188 | -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
2189 | -# func(std::string) {}). This also make the inheritance and collaboration |
2190 | -# diagrams that involve STL classes more complete and accurate. |
2191 | - |
2192 | -BUILTIN_STL_SUPPORT = NO |
2193 | - |
2194 | -# If you use Microsoft's C++/CLI language, you should set this option to YES to |
2195 | -# enable parsing support. |
2196 | - |
2197 | -CPP_CLI_SUPPORT = NO |
2198 | - |
2199 | -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
2200 | -# Doxygen will parse them like normal C++ but will assume all classes use public |
2201 | -# instead of private inheritance when no explicit protection keyword is present. |
2202 | - |
2203 | -SIP_SUPPORT = NO |
2204 | - |
2205 | -# For Microsoft's IDL there are propget and propput attributes to indicate getter |
2206 | -# and setter methods for a property. Setting this option to YES (the default) |
2207 | -# will make doxygen to replace the get and set methods by a property in the |
2208 | -# documentation. This will only work if the methods are indeed getting or |
2209 | -# setting a simple type. If this is not the case, or you want to show the |
2210 | -# methods anyway, you should set this option to NO. |
2211 | - |
2212 | -IDL_PROPERTY_SUPPORT = YES |
2213 | - |
2214 | -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
2215 | -# tag is set to YES, then doxygen will reuse the documentation of the first |
2216 | -# member in the group (if any) for the other members of the group. By default |
2217 | -# all members of a group must be documented explicitly. |
2218 | - |
2219 | -DISTRIBUTE_GROUP_DOC = NO |
2220 | - |
2221 | -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
2222 | -# the same type (for instance a group of public functions) to be put as a |
2223 | -# subgroup of that type (e.g. under the Public Functions section). Set it to |
2224 | -# NO to prevent subgrouping. Alternatively, this can be done per class using |
2225 | -# the \nosubgrouping command. |
2226 | - |
2227 | -SUBGROUPING = YES |
2228 | - |
2229 | -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
2230 | -# is documented as struct, union, or enum with the name of the typedef. So |
2231 | -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
2232 | -# with name TypeT. When disabled the typedef will appear as a member of a file, |
2233 | -# namespace, or class. And the struct will be named TypeS. This can typically |
2234 | -# be useful for C code in case the coding convention dictates that all compound |
2235 | -# types are typedef'ed and only the typedef is referenced, never the tag name. |
2236 | - |
2237 | -TYPEDEF_HIDES_STRUCT = NO |
2238 | - |
2239 | -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
2240 | -# determine which symbols to keep in memory and which to flush to disk. |
2241 | -# When the cache is full, less often used symbols will be written to disk. |
2242 | -# For small to medium size projects (<1000 input files) the default value is |
2243 | -# probably good enough. For larger projects a too small cache size can cause |
2244 | -# doxygen to be busy swapping symbols to and from disk most of the time |
2245 | -# causing a significant performance penality. |
2246 | -# If the system has enough physical memory increasing the cache will improve the |
2247 | -# performance by keeping more symbols in memory. Note that the value works on |
2248 | -# a logarithmic scale so increasing the size by one will rougly double the |
2249 | -# memory usage. The cache size is given by this formula: |
2250 | -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
2251 | -# corresponding to a cache size of 2^16 = 65536 symbols |
2252 | - |
2253 | -SYMBOL_CACHE_SIZE = 0 |
2254 | - |
2255 | -#--------------------------------------------------------------------------- |
2256 | -# Build related configuration options |
2257 | -#--------------------------------------------------------------------------- |
2258 | - |
2259 | -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
2260 | -# documentation are documented, even if no documentation was available. |
2261 | -# Private class members and static file members will be hidden unless |
2262 | -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
2263 | - |
2264 | -EXTRACT_ALL = YES |
2265 | - |
2266 | -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
2267 | -# will be included in the documentation. |
2268 | - |
2269 | -EXTRACT_PRIVATE = YES |
2270 | - |
2271 | -# If the EXTRACT_STATIC tag is set to YES all static members of a file |
2272 | -# will be included in the documentation. |
2273 | - |
2274 | -EXTRACT_STATIC = YES |
2275 | - |
2276 | -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
2277 | -# defined locally in source files will be included in the documentation. |
2278 | -# If set to NO only classes defined in header files are included. |
2279 | - |
2280 | -EXTRACT_LOCAL_CLASSES = YES |
2281 | - |
2282 | -# This flag is only useful for Objective-C code. When set to YES local |
2283 | -# methods, which are defined in the implementation section but not in |
2284 | -# the interface are included in the documentation. |
2285 | -# If set to NO (the default) only methods in the interface are included. |
2286 | - |
2287 | -EXTRACT_LOCAL_METHODS = YES |
2288 | - |
2289 | -# If this flag is set to YES, the members of anonymous namespaces will be |
2290 | -# extracted and appear in the documentation as a namespace called |
2291 | -# 'anonymous_namespace{file}', where file will be replaced with the base |
2292 | -# name of the file that contains the anonymous namespace. By default |
2293 | -# anonymous namespace are hidden. |
2294 | - |
2295 | -EXTRACT_ANON_NSPACES = YES |
2296 | - |
2297 | -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
2298 | -# undocumented members of documented classes, files or namespaces. |
2299 | -# If set to NO (the default) these members will be included in the |
2300 | -# various overviews, but no documentation section is generated. |
2301 | -# This option has no effect if EXTRACT_ALL is enabled. |
2302 | - |
2303 | -HIDE_UNDOC_MEMBERS = NO |
2304 | - |
2305 | -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
2306 | -# undocumented classes that are normally visible in the class hierarchy. |
2307 | -# If set to NO (the default) these classes will be included in the various |
2308 | -# overviews. This option has no effect if EXTRACT_ALL is enabled. |
2309 | - |
2310 | -HIDE_UNDOC_CLASSES = NO |
2311 | - |
2312 | -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
2313 | -# friend (class|struct|union) declarations. |
2314 | -# If set to NO (the default) these declarations will be included in the |
2315 | -# documentation. |
2316 | - |
2317 | -HIDE_FRIEND_COMPOUNDS = NO |
2318 | - |
2319 | -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
2320 | -# documentation blocks found inside the body of a function. |
2321 | -# If set to NO (the default) these blocks will be appended to the |
2322 | -# function's detailed documentation block. |
2323 | - |
2324 | -HIDE_IN_BODY_DOCS = NO |
2325 | - |
2326 | -# The INTERNAL_DOCS tag determines if documentation |
2327 | -# that is typed after a \internal command is included. If the tag is set |
2328 | -# to NO (the default) then the documentation will be excluded. |
2329 | -# Set it to YES to include the internal documentation. |
2330 | - |
2331 | -INTERNAL_DOCS = NO |
2332 | - |
2333 | -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
2334 | -# file names in lower-case letters. If set to YES upper-case letters are also |
2335 | -# allowed. This is useful if you have classes or files whose names only differ |
2336 | -# in case and if your file system supports case sensitive file names. Windows |
2337 | -# and Mac users are advised to set this option to NO. |
2338 | - |
2339 | -CASE_SENSE_NAMES = NO |
2340 | - |
2341 | -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
2342 | -# will show members with their full class and namespace scopes in the |
2343 | -# documentation. If set to YES the scope will be hidden. |
2344 | - |
2345 | -HIDE_SCOPE_NAMES = NO |
2346 | - |
2347 | -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
2348 | -# will put a list of the files that are included by a file in the documentation |
2349 | -# of that file. |
2350 | - |
2351 | -SHOW_INCLUDE_FILES = NO |
2352 | - |
2353 | -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen |
2354 | -# will list include files with double quotes in the documentation |
2355 | -# rather than with sharp brackets. |
2356 | - |
2357 | -FORCE_LOCAL_INCLUDES = NO |
2358 | - |
2359 | -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
2360 | -# is inserted in the documentation for inline members. |
2361 | - |
2362 | -INLINE_INFO = NO |
2363 | - |
2364 | -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
2365 | -# will sort the (detailed) documentation of file and class members |
2366 | -# alphabetically by member name. If set to NO the members will appear in |
2367 | -# declaration order. |
2368 | - |
2369 | -SORT_MEMBER_DOCS = YES |
2370 | - |
2371 | -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
2372 | -# brief documentation of file, namespace and class members alphabetically |
2373 | -# by member name. If set to NO (the default) the members will appear in |
2374 | -# declaration order. |
2375 | - |
2376 | -SORT_BRIEF_DOCS = NO |
2377 | - |
2378 | -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
2379 | -# will sort the (brief and detailed) documentation of class members so that |
2380 | -# constructors and destructors are listed first. If set to NO (the default) |
2381 | -# the constructors will appear in the respective orders defined by |
2382 | -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
2383 | -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
2384 | -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
2385 | - |
2386 | -SORT_MEMBERS_CTORS_1ST = NO |
2387 | - |
2388 | -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
2389 | -# hierarchy of group names into alphabetical order. If set to NO (the default) |
2390 | -# the group names will appear in their defined order. |
2391 | - |
2392 | -SORT_GROUP_NAMES = NO |
2393 | - |
2394 | -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
2395 | -# sorted by fully-qualified names, including namespaces. If set to |
2396 | -# NO (the default), the class list will be sorted only by class name, |
2397 | -# not including the namespace part. |
2398 | -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
2399 | -# Note: This option applies only to the class list, not to the |
2400 | -# alphabetical list. |
2401 | - |
2402 | -SORT_BY_SCOPE_NAME = NO |
2403 | - |
2404 | -# The GENERATE_TODOLIST tag can be used to enable (YES) or |
2405 | -# disable (NO) the todo list. This list is created by putting \todo |
2406 | -# commands in the documentation. |
2407 | - |
2408 | -GENERATE_TODOLIST = NO |
2409 | - |
2410 | -# The GENERATE_TESTLIST tag can be used to enable (YES) or |
2411 | -# disable (NO) the test list. This list is created by putting \test |
2412 | -# commands in the documentation. |
2413 | - |
2414 | -GENERATE_TESTLIST = NO |
2415 | - |
2416 | -# The GENERATE_BUGLIST tag can be used to enable (YES) or |
2417 | -# disable (NO) the bug list. This list is created by putting \bug |
2418 | -# commands in the documentation. |
2419 | - |
2420 | -GENERATE_BUGLIST = NO |
2421 | - |
2422 | -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
2423 | -# disable (NO) the deprecated list. This list is created by putting |
2424 | -# \deprecated commands in the documentation. |
2425 | - |
2426 | -GENERATE_DEPRECATEDLIST= NO |
2427 | - |
2428 | -# The ENABLED_SECTIONS tag can be used to enable conditional |
2429 | -# documentation sections, marked by \if sectionname ... \endif. |
2430 | - |
2431 | -ENABLED_SECTIONS = |
2432 | - |
2433 | -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
2434 | -# the initial value of a variable or define consists of for it to appear in |
2435 | -# the documentation. If the initializer consists of more lines than specified |
2436 | -# here it will be hidden. Use a value of 0 to hide initializers completely. |
2437 | -# The appearance of the initializer of individual variables and defines in the |
2438 | -# documentation can be controlled using \showinitializer or \hideinitializer |
2439 | -# command in the documentation regardless of this setting. |
2440 | - |
2441 | -MAX_INITIALIZER_LINES = 30 |
2442 | - |
2443 | -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
2444 | -# at the bottom of the documentation of classes and structs. If set to YES the |
2445 | -# list will mention the files that were used to generate the documentation. |
2446 | - |
2447 | -SHOW_USED_FILES = NO |
2448 | - |
2449 | -# If the sources in your project are distributed over multiple directories |
2450 | -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
2451 | -# in the documentation. The default is NO. |
2452 | - |
2453 | -SHOW_DIRECTORIES = NO |
2454 | - |
2455 | -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
2456 | -# This will remove the Files entry from the Quick Index and from the |
2457 | -# Folder Tree View (if specified). The default is YES. |
2458 | - |
2459 | -SHOW_FILES = NO |
2460 | - |
2461 | -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
2462 | -# Namespaces page. This will remove the Namespaces entry from the Quick Index |
2463 | -# and from the Folder Tree View (if specified). The default is YES. |
2464 | - |
2465 | -SHOW_NAMESPACES = YES |
2466 | - |
2467 | -# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
2468 | -# doxygen should invoke to get the current version for each file (typically from |
2469 | -# the version control system). Doxygen will invoke the program by executing (via |
2470 | -# popen()) the command <command> <input-file>, where <command> is the value of |
2471 | -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
2472 | -# provided by doxygen. Whatever the program writes to standard output |
2473 | -# is used as the file version. See the manual for examples. |
2474 | - |
2475 | -FILE_VERSION_FILTER = |
2476 | - |
2477 | -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
2478 | -# by doxygen. The layout file controls the global structure of the generated |
2479 | -# output files in an output format independent way. The create the layout file |
2480 | -# that represents doxygen's defaults, run doxygen with the -l option. |
2481 | -# You can optionally specify a file name after the option, if omitted |
2482 | -# DoxygenLayout.xml will be used as the name of the layout file. |
2483 | - |
2484 | -LAYOUT_FILE = |
2485 | - |
2486 | -#--------------------------------------------------------------------------- |
2487 | -# configuration options related to warning and progress messages |
2488 | -#--------------------------------------------------------------------------- |
2489 | - |
2490 | -# The QUIET tag can be used to turn on/off the messages that are generated |
2491 | -# by doxygen. Possible values are YES and NO. If left blank NO is used. |
2492 | - |
2493 | -QUIET = NO |
2494 | - |
2495 | -# The WARNINGS tag can be used to turn on/off the warning messages that are |
2496 | -# generated by doxygen. Possible values are YES and NO. If left blank |
2497 | -# NO is used. |
2498 | - |
2499 | -WARNINGS = YES |
2500 | - |
2501 | -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
2502 | -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
2503 | -# automatically be disabled. |
2504 | - |
2505 | -WARN_IF_UNDOCUMENTED = YES |
2506 | - |
2507 | -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
2508 | -# potential errors in the documentation, such as not documenting some |
2509 | -# parameters in a documented function, or documenting parameters that |
2510 | -# don't exist or using markup commands wrongly. |
2511 | - |
2512 | -WARN_IF_DOC_ERROR = YES |
2513 | - |
2514 | -# This WARN_NO_PARAMDOC option can be abled to get warnings for |
2515 | -# functions that are documented, but have no documentation for their parameters |
2516 | -# or return value. If set to NO (the default) doxygen will only warn about |
2517 | -# wrong or incomplete parameter documentation, but not about the absence of |
2518 | -# documentation. |
2519 | - |
2520 | -WARN_NO_PARAMDOC = YES |
2521 | - |
2522 | -# The WARN_FORMAT tag determines the format of the warning messages that |
2523 | -# doxygen can produce. The string should contain the $file, $line, and $text |
2524 | -# tags, which will be replaced by the file and line number from which the |
2525 | -# warning originated and the warning text. Optionally the format may contain |
2526 | -# $version, which will be replaced by the version of the file (if it could |
2527 | -# be obtained via FILE_VERSION_FILTER) |
2528 | - |
2529 | -WARN_FORMAT = "$file:$line: $text" |
2530 | - |
2531 | -# The WARN_LOGFILE tag can be used to specify a file to which warning |
2532 | -# and error messages should be written. If left blank the output is written |
2533 | -# to stderr. |
2534 | - |
2535 | -WARN_LOGFILE = log |
2536 | - |
2537 | -#--------------------------------------------------------------------------- |
2538 | -# configuration options related to the input files |
2539 | -#--------------------------------------------------------------------------- |
2540 | - |
2541 | -# The INPUT tag can be used to specify the files and/or directories that contain |
2542 | -# documented source files. You may enter file names like "myfile.cpp" or |
2543 | -# directories like "/usr/src/myproject". Separate the files or directories |
2544 | -# with spaces. |
2545 | - |
2546 | -INPUT = ../src |
2547 | - |
2548 | -# This tag can be used to specify the character encoding of the source files |
2549 | -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
2550 | -# also the default input encoding. Doxygen uses libiconv (or the iconv built |
2551 | -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
2552 | -# the list of possible encodings. |
2553 | - |
2554 | -INPUT_ENCODING = UTF-8 |
2555 | - |
2556 | -# If the value of the INPUT tag contains directories, you can use the |
2557 | -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
2558 | -# and *.h) to filter out the source-files in the directories. If left |
2559 | -# blank the following patterns are tested: |
2560 | -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
2561 | -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
2562 | - |
2563 | -FILE_PATTERNS = *.c \ |
2564 | - *.cc \ |
2565 | - *.cxx \ |
2566 | - *.cpp \ |
2567 | - *.c++ \ |
2568 | - *.d \ |
2569 | - *.java \ |
2570 | - *.ii \ |
2571 | - *.ixx \ |
2572 | - *.ipp \ |
2573 | - *.i++ \ |
2574 | - *.inl \ |
2575 | - *.h \ |
2576 | - *.hh \ |
2577 | - *.hxx \ |
2578 | - *.hpp \ |
2579 | - *.h++ \ |
2580 | - *.idl \ |
2581 | - *.odl \ |
2582 | - *.cs \ |
2583 | - *.php \ |
2584 | - *.php3 \ |
2585 | - *.inc \ |
2586 | - *.m \ |
2587 | - *.mm \ |
2588 | - *.dox \ |
2589 | - *.py \ |
2590 | - *.f90 \ |
2591 | - *.f \ |
2592 | - *.vhd \ |
2593 | - *.vhdl |
2594 | - |
2595 | -# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
2596 | -# should be searched for input files as well. Possible values are YES and NO. |
2597 | -# If left blank NO is used. |
2598 | - |
2599 | -RECURSIVE = YES |
2600 | - |
2601 | -# The EXCLUDE tag can be used to specify files and/or directories that should |
2602 | -# excluded from the INPUT source files. This way you can easily exclude a |
2603 | -# subdirectory from a directory tree whose root is specified with the INPUT tag. |
2604 | - |
2605 | -EXCLUDE = |
2606 | - |
2607 | -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
2608 | -# directories that are symbolic links (a Unix filesystem feature) are excluded |
2609 | -# from the input. |
2610 | - |
2611 | -EXCLUDE_SYMLINKS = NO |
2612 | - |
2613 | -# If the value of the INPUT tag contains directories, you can use the |
2614 | -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
2615 | -# certain files from those directories. Note that the wildcards are matched |
2616 | -# against the file with absolute path, so to exclude all test directories |
2617 | -# for example use the pattern */test/* |
2618 | - |
2619 | -EXCLUDE_PATTERNS = |
2620 | - |
2621 | -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
2622 | -# (namespaces, classes, functions, etc.) that should be excluded from the |
2623 | -# output. The symbol name can be a fully qualified name, a word, or if the |
2624 | -# wildcard * is used, a substring. Examples: ANamespace, AClass, |
2625 | -# AClass::ANamespace, ANamespace::*Test |
2626 | - |
2627 | -EXCLUDE_SYMBOLS = |
2628 | - |
2629 | -# The EXAMPLE_PATH tag can be used to specify one or more files or |
2630 | -# directories that contain example code fragments that are included (see |
2631 | -# the \include command). |
2632 | - |
2633 | -EXAMPLE_PATH = |
2634 | - |
2635 | -# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
2636 | -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
2637 | -# and *.h) to filter out the source-files in the directories. If left |
2638 | -# blank all files are included. |
2639 | - |
2640 | -EXAMPLE_PATTERNS = * |
2641 | - |
2642 | -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
2643 | -# searched for input files to be used with the \include or \dontinclude |
2644 | -# commands irrespective of the value of the RECURSIVE tag. |
2645 | -# Possible values are YES and NO. If left blank NO is used. |
2646 | - |
2647 | -EXAMPLE_RECURSIVE = NO |
2648 | - |
2649 | -# The IMAGE_PATH tag can be used to specify one or more files or |
2650 | -# directories that contain image that are included in the documentation (see |
2651 | -# the \image command). |
2652 | - |
2653 | -IMAGE_PATH = |
2654 | - |
2655 | -# The INPUT_FILTER tag can be used to specify a program that doxygen should |
2656 | -# invoke to filter for each input file. Doxygen will invoke the filter program |
2657 | -# by executing (via popen()) the command <filter> <input-file>, where <filter> |
2658 | -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
2659 | -# input file. Doxygen will then use the output that the filter program writes |
2660 | -# to standard output. If FILTER_PATTERNS is specified, this tag will be |
2661 | -# ignored. |
2662 | - |
2663 | -INPUT_FILTER = |
2664 | - |
2665 | -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
2666 | -# basis. Doxygen will compare the file name with each pattern and apply the |
2667 | -# filter if there is a match. The filters are a list of the form: |
2668 | -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
2669 | -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
2670 | -# is applied to all files. |
2671 | - |
2672 | -FILTER_PATTERNS = |
2673 | - |
2674 | -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
2675 | -# INPUT_FILTER) will be used to filter the input files when producing source |
2676 | -# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
2677 | - |
2678 | -FILTER_SOURCE_FILES = NO |
2679 | - |
2680 | -#--------------------------------------------------------------------------- |
2681 | -# configuration options related to source browsing |
2682 | -#--------------------------------------------------------------------------- |
2683 | - |
2684 | -# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
2685 | -# be generated. Documented entities will be cross-referenced with these sources. |
2686 | -# Note: To get rid of all source code in the generated output, make sure also |
2687 | -# VERBATIM_HEADERS is set to NO. |
2688 | - |
2689 | -SOURCE_BROWSER = YES |
2690 | - |
2691 | -# Setting the INLINE_SOURCES tag to YES will include the body |
2692 | -# of functions and classes directly in the documentation. |
2693 | - |
2694 | -INLINE_SOURCES = NO |
2695 | - |
2696 | -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
2697 | -# doxygen to hide any special comment blocks from generated source code |
2698 | -# fragments. Normal C and C++ comments will always remain visible. |
2699 | - |
2700 | -STRIP_CODE_COMMENTS = YES |
2701 | - |
2702 | -# If the REFERENCED_BY_RELATION tag is set to YES |
2703 | -# then for each documented function all documented |
2704 | -# functions referencing it will be listed. |
2705 | - |
2706 | -REFERENCED_BY_RELATION = NO |
2707 | - |
2708 | -# If the REFERENCES_RELATION tag is set to YES |
2709 | -# then for each documented function all documented entities |
2710 | -# called/used by that function will be listed. |
2711 | - |
2712 | -REFERENCES_RELATION = NO |
2713 | - |
2714 | -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
2715 | -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
2716 | -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
2717 | -# link to the source code. Otherwise they will link to the documentation. |
2718 | - |
2719 | -REFERENCES_LINK_SOURCE = YES |
2720 | - |
2721 | -# If the USE_HTAGS tag is set to YES then the references to source code |
2722 | -# will point to the HTML generated by the htags(1) tool instead of doxygen |
2723 | -# built-in source browser. The htags tool is part of GNU's global source |
2724 | -# tagging system (see http://www.gnu.org/software/global/global.html). You |
2725 | -# will need version 4.8.6 or higher. |
2726 | - |
2727 | -USE_HTAGS = NO |
2728 | - |
2729 | -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
2730 | -# will generate a verbatim copy of the header file for each class for |
2731 | -# which an include is specified. Set to NO to disable this. |
2732 | - |
2733 | -VERBATIM_HEADERS = YES |
2734 | - |
2735 | -#--------------------------------------------------------------------------- |
2736 | -# configuration options related to the alphabetical class index |
2737 | -#--------------------------------------------------------------------------- |
2738 | - |
2739 | -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
2740 | -# of all compounds will be generated. Enable this if the project |
2741 | -# contains a lot of classes, structs, unions or interfaces. |
2742 | - |
2743 | -ALPHABETICAL_INDEX = NO |
2744 | - |
2745 | -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
2746 | -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
2747 | -# in which this list will be split (can be a number in the range [1..20]) |
2748 | - |
2749 | -COLS_IN_ALPHA_INDEX = 5 |
2750 | - |
2751 | -# In case all classes in a project start with a common prefix, all |
2752 | -# classes will be put under the same header in the alphabetical index. |
2753 | -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
2754 | -# should be ignored while generating the index headers. |
2755 | - |
2756 | -IGNORE_PREFIX = |
2757 | - |
2758 | -#--------------------------------------------------------------------------- |
2759 | -# configuration options related to the HTML output |
2760 | -#--------------------------------------------------------------------------- |
2761 | - |
2762 | -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
2763 | -# generate HTML output. |
2764 | - |
2765 | -GENERATE_HTML = YES |
2766 | - |
2767 | -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
2768 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
2769 | -# put in front of it. If left blank `html' will be used as the default path. |
2770 | - |
2771 | -HTML_OUTPUT = html |
2772 | - |
2773 | -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
2774 | -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
2775 | -# doxygen will generate files with .html extension. |
2776 | - |
2777 | -HTML_FILE_EXTENSION = .html |
2778 | - |
2779 | -# The HTML_HEADER tag can be used to specify a personal HTML header for |
2780 | -# each generated HTML page. If it is left blank doxygen will generate a |
2781 | -# standard header. |
2782 | - |
2783 | -HTML_HEADER = |
2784 | - |
2785 | -# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
2786 | -# each generated HTML page. If it is left blank doxygen will generate a |
2787 | -# standard footer. |
2788 | - |
2789 | -HTML_FOOTER = |
2790 | - |
2791 | -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
2792 | -# style sheet that is used by each HTML page. It can be used to |
2793 | -# fine-tune the look of the HTML output. If the tag is left blank doxygen |
2794 | -# will generate a default style sheet. Note that doxygen will try to copy |
2795 | -# the style sheet file to the HTML output directory, so don't put your own |
2796 | -# stylesheet in the HTML output directory as well, or it will be erased! |
2797 | - |
2798 | -HTML_STYLESHEET = |
2799 | - |
2800 | -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
2801 | -# Doxygen will adjust the colors in the stylesheet and background images |
2802 | -# according to this color. Hue is specified as an angle on a colorwheel, |
2803 | -# see http://en.wikipedia.org/wiki/Hue for more information. |
2804 | -# For instance the value 0 represents red, 60 is yellow, 120 is green, |
2805 | -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. |
2806 | -# The allowed range is 0 to 359. |
2807 | - |
2808 | -HTML_COLORSTYLE_HUE = 220 |
2809 | - |
2810 | -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of |
2811 | -# the colors in the HTML output. For a value of 0 the output will use |
2812 | -# grayscales only. A value of 255 will produce the most vivid colors. |
2813 | - |
2814 | -HTML_COLORSTYLE_SAT = 100 |
2815 | - |
2816 | -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to |
2817 | -# the luminance component of the colors in the HTML output. Values below |
2818 | -# 100 gradually make the output lighter, whereas values above 100 make |
2819 | -# the output darker. The value divided by 100 is the actual gamma applied, |
2820 | -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, |
2821 | -# and 100 does not change the gamma. |
2822 | - |
2823 | -HTML_COLORSTYLE_GAMMA = 80 |
2824 | - |
2825 | -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
2826 | -# page will contain the date and time when the page was generated. Setting |
2827 | -# this to NO can help when comparing the output of multiple runs. |
2828 | - |
2829 | -HTML_TIMESTAMP = NO |
2830 | - |
2831 | -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
2832 | -# files or namespaces will be aligned in HTML using tables. If set to |
2833 | -# NO a bullet list will be used. |
2834 | - |
2835 | -HTML_ALIGN_MEMBERS = YES |
2836 | - |
2837 | -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
2838 | -# documentation will contain sections that can be hidden and shown after the |
2839 | -# page has loaded. For this to work a browser that supports |
2840 | -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
2841 | -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
2842 | - |
2843 | -HTML_DYNAMIC_SECTIONS = NO |
2844 | - |
2845 | -# If the GENERATE_DOCSET tag is set to YES, additional index files |
2846 | -# will be generated that can be used as input for Apple's Xcode 3 |
2847 | -# integrated development environment, introduced with OSX 10.5 (Leopard). |
2848 | -# To create a documentation set, doxygen will generate a Makefile in the |
2849 | -# HTML output directory. Running make will produce the docset in that |
2850 | -# directory and running "make install" will install the docset in |
2851 | -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
2852 | -# it at startup. |
2853 | -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
2854 | -# for more information. |
2855 | - |
2856 | -GENERATE_DOCSET = NO |
2857 | - |
2858 | -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
2859 | -# feed. A documentation feed provides an umbrella under which multiple |
2860 | -# documentation sets from a single provider (such as a company or product suite) |
2861 | -# can be grouped. |
2862 | - |
2863 | -DOCSET_FEEDNAME = "Doxygen generated docs" |
2864 | - |
2865 | -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
2866 | -# should uniquely identify the documentation set bundle. This should be a |
2867 | -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
2868 | -# will append .docset to the name. |
2869 | - |
2870 | -DOCSET_BUNDLE_ID = org.doxygen.Project |
2871 | - |
2872 | -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify |
2873 | -# the documentation publisher. This should be a reverse domain-name style |
2874 | -# string, e.g. com.mycompany.MyDocSet.documentation. |
2875 | - |
2876 | -DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
2877 | - |
2878 | -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. |
2879 | - |
2880 | -DOCSET_PUBLISHER_NAME = Publisher |
2881 | - |
2882 | -# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
2883 | -# will be generated that can be used as input for tools like the |
2884 | -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
2885 | -# of the generated HTML documentation. |
2886 | - |
2887 | -GENERATE_HTMLHELP = NO |
2888 | - |
2889 | -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
2890 | -# be used to specify the file name of the resulting .chm file. You |
2891 | -# can add a path in front of the file if the result should not be |
2892 | -# written to the html output directory. |
2893 | - |
2894 | -CHM_FILE = |
2895 | - |
2896 | -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
2897 | -# be used to specify the location (absolute path including file name) of |
2898 | -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
2899 | -# the HTML help compiler on the generated index.hhp. |
2900 | - |
2901 | -HHC_LOCATION = |
2902 | - |
2903 | -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
2904 | -# controls if a separate .chi index file is generated (YES) or that |
2905 | -# it should be included in the master .chm file (NO). |
2906 | - |
2907 | -GENERATE_CHI = NO |
2908 | - |
2909 | -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
2910 | -# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
2911 | -# content. |
2912 | - |
2913 | -CHM_INDEX_ENCODING = |
2914 | - |
2915 | -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
2916 | -# controls whether a binary table of contents is generated (YES) or a |
2917 | -# normal table of contents (NO) in the .chm file. |
2918 | - |
2919 | -BINARY_TOC = NO |
2920 | - |
2921 | -# The TOC_EXPAND flag can be set to YES to add extra items for group members |
2922 | -# to the contents of the HTML help documentation and to the tree view. |
2923 | - |
2924 | -TOC_EXPAND = NO |
2925 | - |
2926 | -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
2927 | -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
2928 | -# that can be used as input for Qt's qhelpgenerator to generate a |
2929 | -# Qt Compressed Help (.qch) of the generated HTML documentation. |
2930 | - |
2931 | -GENERATE_QHP = NO |
2932 | - |
2933 | -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
2934 | -# be used to specify the file name of the resulting .qch file. |
2935 | -# The path specified is relative to the HTML output folder. |
2936 | - |
2937 | -QCH_FILE = |
2938 | - |
2939 | -# The QHP_NAMESPACE tag specifies the namespace to use when generating |
2940 | -# Qt Help Project output. For more information please see |
2941 | -# http://doc.trolltech.com/qthelpproject.html#namespace |
2942 | - |
2943 | -QHP_NAMESPACE = org.doxygen.Project |
2944 | - |
2945 | -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
2946 | -# Qt Help Project output. For more information please see |
2947 | -# http://doc.trolltech.com/qthelpproject.html#virtual-folders |
2948 | - |
2949 | -QHP_VIRTUAL_FOLDER = doc |
2950 | - |
2951 | -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
2952 | -# add. For more information please see |
2953 | -# http://doc.trolltech.com/qthelpproject.html#custom-filters |
2954 | - |
2955 | -QHP_CUST_FILTER_NAME = |
2956 | - |
2957 | -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
2958 | -# custom filter to add. For more information please see |
2959 | -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
2960 | -# Qt Help Project / Custom Filters</a>. |
2961 | - |
2962 | -QHP_CUST_FILTER_ATTRS = |
2963 | - |
2964 | -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
2965 | -# project's |
2966 | -# filter section matches. |
2967 | -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
2968 | -# Qt Help Project / Filter Attributes</a>. |
2969 | - |
2970 | -QHP_SECT_FILTER_ATTRS = |
2971 | - |
2972 | -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
2973 | -# be used to specify the location of Qt's qhelpgenerator. |
2974 | -# If non-empty doxygen will try to run qhelpgenerator on the generated |
2975 | -# .qhp file. |
2976 | - |
2977 | -QHG_LOCATION = |
2978 | - |
2979 | -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files |
2980 | -# will be generated, which together with the HTML files, form an Eclipse help |
2981 | -# plugin. To install this plugin and make it available under the help contents |
2982 | -# menu in Eclipse, the contents of the directory containing the HTML and XML |
2983 | -# files needs to be copied into the plugins directory of eclipse. The name of |
2984 | -# the directory within the plugins directory should be the same as |
2985 | -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
2986 | -# the help appears. |
2987 | - |
2988 | -GENERATE_ECLIPSEHELP = NO |
2989 | - |
2990 | -# A unique identifier for the eclipse help plugin. When installing the plugin |
2991 | -# the directory name containing the HTML and XML files should also have |
2992 | -# this name. |
2993 | - |
2994 | -ECLIPSE_DOC_ID = org.doxygen.Project |
2995 | - |
2996 | -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
2997 | -# top of each HTML page. The value NO (the default) enables the index and |
2998 | -# the value YES disables it. |
2999 | - |
3000 | -DISABLE_INDEX = NO |
3001 | - |
3002 | -# This tag can be used to set the number of enum values (range [1..20]) |
3003 | -# that doxygen will group on one line in the generated HTML documentation. |
3004 | - |
3005 | -ENUM_VALUES_PER_LINE = 4 |
3006 | - |
3007 | -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
3008 | -# structure should be generated to display hierarchical information. |
3009 | -# If the tag value is set to YES, a side panel will be generated |
3010 | -# containing a tree-like index structure (just like the one that |
3011 | -# is generated for HTML Help). For this to work a browser that supports |
3012 | -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
3013 | -# Windows users are probably better off using the HTML help feature. |
3014 | - |
3015 | -GENERATE_TREEVIEW = NO |
3016 | - |
3017 | -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
3018 | -# and Class Hierarchy pages using a tree view instead of an ordered list. |
3019 | - |
3020 | -USE_INLINE_TREES = NO |
3021 | - |
3022 | -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
3023 | -# used to set the initial width (in pixels) of the frame in which the tree |
3024 | -# is shown. |
3025 | - |
3026 | -TREEVIEW_WIDTH = 250 |
3027 | - |
3028 | -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open |
3029 | -# links to external symbols imported via tag files in a separate window. |
3030 | - |
3031 | -EXT_LINKS_IN_WINDOW = NO |
3032 | - |
3033 | -# Use this tag to change the font size of Latex formulas included |
3034 | -# as images in the HTML documentation. The default is 10. Note that |
3035 | -# when you change the font size after a successful doxygen run you need |
3036 | -# to manually remove any form_*.png images from the HTML output directory |
3037 | -# to force them to be regenerated. |
3038 | - |
3039 | -FORMULA_FONTSIZE = 10 |
3040 | - |
3041 | -# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
3042 | -# generated for formulas are transparent PNGs. Transparent PNGs are |
3043 | -# not supported properly for IE 6.0, but are supported on all modern browsers. |
3044 | -# Note that when changing this option you need to delete any form_*.png files |
3045 | -# in the HTML output before the changes have effect. |
3046 | - |
3047 | -FORMULA_TRANSPARENT = YES |
3048 | - |
3049 | -# When the SEARCHENGINE tag is enabled doxygen will generate a search box |
3050 | -# for the HTML output. The underlying search engine uses javascript |
3051 | -# and DHTML and should work on any modern browser. Note that when using |
3052 | -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
3053 | -# (GENERATE_DOCSET) there is already a search function so this one should |
3054 | -# typically be disabled. For large projects the javascript based search engine |
3055 | -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
3056 | - |
3057 | -SEARCHENGINE = NO |
3058 | - |
3059 | -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
3060 | -# implemented using a PHP enabled web server instead of at the web client |
3061 | -# using Javascript. Doxygen will generate the search PHP script and index |
3062 | -# file to put on the web server. The advantage of the server |
3063 | -# based approach is that it scales better to large projects and allows |
3064 | -# full text search. The disadvances is that it is more difficult to setup |
3065 | -# and does not have live searching capabilities. |
3066 | - |
3067 | -SERVER_BASED_SEARCH = NO |
3068 | - |
3069 | -#--------------------------------------------------------------------------- |
3070 | -# configuration options related to the LaTeX output |
3071 | -#--------------------------------------------------------------------------- |
3072 | - |
3073 | -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
3074 | -# generate Latex output. |
3075 | - |
3076 | -GENERATE_LATEX = NO |
3077 | - |
3078 | -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
3079 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
3080 | -# put in front of it. If left blank `latex' will be used as the default path. |
3081 | - |
3082 | -LATEX_OUTPUT = latex |
3083 | - |
3084 | -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
3085 | -# invoked. If left blank `latex' will be used as the default command name. |
3086 | -# Note that when enabling USE_PDFLATEX this option is only used for |
3087 | -# generating bitmaps for formulas in the HTML output, but not in the |
3088 | -# Makefile that is written to the output directory. |
3089 | - |
3090 | -LATEX_CMD_NAME = latex |
3091 | - |
3092 | -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
3093 | -# generate index for LaTeX. If left blank `makeindex' will be used as the |
3094 | -# default command name. |
3095 | - |
3096 | -MAKEINDEX_CMD_NAME = makeindex |
3097 | - |
3098 | -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
3099 | -# LaTeX documents. This may be useful for small projects and may help to |
3100 | -# save some trees in general. |
3101 | - |
3102 | -COMPACT_LATEX = NO |
3103 | - |
3104 | -# The PAPER_TYPE tag can be used to set the paper type that is used |
3105 | -# by the printer. Possible values are: a4, a4wide, letter, legal and |
3106 | -# executive. If left blank a4wide will be used. |
3107 | - |
3108 | -PAPER_TYPE = a4wide |
3109 | - |
3110 | -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
3111 | -# packages that should be included in the LaTeX output. |
3112 | - |
3113 | -EXTRA_PACKAGES = |
3114 | - |
3115 | -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
3116 | -# the generated latex document. The header should contain everything until |
3117 | -# the first chapter. If it is left blank doxygen will generate a |
3118 | -# standard header. Notice: only use this tag if you know what you are doing! |
3119 | - |
3120 | -LATEX_HEADER = |
3121 | - |
3122 | -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
3123 | -# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
3124 | -# contain links (just like the HTML output) instead of page references |
3125 | -# This makes the output suitable for online browsing using a pdf viewer. |
3126 | - |
3127 | -PDF_HYPERLINKS = YES |
3128 | - |
3129 | -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
3130 | -# plain latex in the generated Makefile. Set this option to YES to get a |
3131 | -# higher quality PDF documentation. |
3132 | - |
3133 | -USE_PDFLATEX = YES |
3134 | - |
3135 | -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
3136 | -# command to the generated LaTeX files. This will instruct LaTeX to keep |
3137 | -# running if errors occur, instead of asking the user for help. |
3138 | -# This option is also used when generating formulas in HTML. |
3139 | - |
3140 | -LATEX_BATCHMODE = NO |
3141 | - |
3142 | -# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
3143 | -# include the index chapters (such as File Index, Compound Index, etc.) |
3144 | -# in the output. |
3145 | - |
3146 | -LATEX_HIDE_INDICES = NO |
3147 | - |
3148 | -# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
3149 | -# source code with syntax highlighting in the LaTeX output. |
3150 | -# Note that which sources are shown also depends on other settings |
3151 | -# such as SOURCE_BROWSER. |
3152 | - |
3153 | -LATEX_SOURCE_CODE = NO |
3154 | - |
3155 | -#--------------------------------------------------------------------------- |
3156 | -# configuration options related to the RTF output |
3157 | -#--------------------------------------------------------------------------- |
3158 | - |
3159 | -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
3160 | -# The RTF output is optimized for Word 97 and may not look very pretty with |
3161 | -# other RTF readers or editors. |
3162 | - |
3163 | -GENERATE_RTF = NO |
3164 | - |
3165 | -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
3166 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
3167 | -# put in front of it. If left blank `rtf' will be used as the default path. |
3168 | - |
3169 | -RTF_OUTPUT = rtf |
3170 | - |
3171 | -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
3172 | -# RTF documents. This may be useful for small projects and may help to |
3173 | -# save some trees in general. |
3174 | - |
3175 | -COMPACT_RTF = NO |
3176 | - |
3177 | -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
3178 | -# will contain hyperlink fields. The RTF file will |
3179 | -# contain links (just like the HTML output) instead of page references. |
3180 | -# This makes the output suitable for online browsing using WORD or other |
3181 | -# programs which support those fields. |
3182 | -# Note: wordpad (write) and others do not support links. |
3183 | - |
3184 | -RTF_HYPERLINKS = NO |
3185 | - |
3186 | -# Load stylesheet definitions from file. Syntax is similar to doxygen's |
3187 | -# config file, i.e. a series of assignments. You only have to provide |
3188 | -# replacements, missing definitions are set to their default value. |
3189 | - |
3190 | -RTF_STYLESHEET_FILE = |
3191 | - |
3192 | -# Set optional variables used in the generation of an rtf document. |
3193 | -# Syntax is similar to doxygen's config file. |
3194 | - |
3195 | -RTF_EXTENSIONS_FILE = |
3196 | - |
3197 | -#--------------------------------------------------------------------------- |
3198 | -# configuration options related to the man page output |
3199 | -#--------------------------------------------------------------------------- |
3200 | - |
3201 | -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
3202 | -# generate man pages |
3203 | - |
3204 | -GENERATE_MAN = NO |
3205 | - |
3206 | -# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
3207 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
3208 | -# put in front of it. If left blank `man' will be used as the default path. |
3209 | - |
3210 | -MAN_OUTPUT = man |
3211 | - |
3212 | -# The MAN_EXTENSION tag determines the extension that is added to |
3213 | -# the generated man pages (default is the subroutine's section .3) |
3214 | - |
3215 | -MAN_EXTENSION = .3 |
3216 | - |
3217 | -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
3218 | -# then it will generate one additional man file for each entity |
3219 | -# documented in the real man page(s). These additional files |
3220 | -# only source the real man page, but without them the man command |
3221 | -# would be unable to find the correct page. The default is NO. |
3222 | - |
3223 | -MAN_LINKS = NO |
3224 | - |
3225 | -#--------------------------------------------------------------------------- |
3226 | -# configuration options related to the XML output |
3227 | -#--------------------------------------------------------------------------- |
3228 | - |
3229 | -# If the GENERATE_XML tag is set to YES Doxygen will |
3230 | -# generate an XML file that captures the structure of |
3231 | -# the code including all documentation. |
3232 | - |
3233 | -GENERATE_XML = NO |
3234 | - |
3235 | -# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
3236 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
3237 | -# put in front of it. If left blank `xml' will be used as the default path. |
3238 | - |
3239 | -XML_OUTPUT = xml |
3240 | - |
3241 | -# The XML_SCHEMA tag can be used to specify an XML schema, |
3242 | -# which can be used by a validating XML parser to check the |
3243 | -# syntax of the XML files. |
3244 | - |
3245 | -XML_SCHEMA = |
3246 | - |
3247 | -# The XML_DTD tag can be used to specify an XML DTD, |
3248 | -# which can be used by a validating XML parser to check the |
3249 | -# syntax of the XML files. |
3250 | - |
3251 | -XML_DTD = |
3252 | - |
3253 | -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
3254 | -# dump the program listings (including syntax highlighting |
3255 | -# and cross-referencing information) to the XML output. Note that |
3256 | -# enabling this will significantly increase the size of the XML output. |
3257 | - |
3258 | -XML_PROGRAMLISTING = YES |
3259 | - |
3260 | -#--------------------------------------------------------------------------- |
3261 | -# configuration options for the AutoGen Definitions output |
3262 | -#--------------------------------------------------------------------------- |
3263 | - |
3264 | -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
3265 | -# generate an AutoGen Definitions (see autogen.sf.net) file |
3266 | -# that captures the structure of the code including all |
3267 | -# documentation. Note that this feature is still experimental |
3268 | -# and incomplete at the moment. |
3269 | - |
3270 | -GENERATE_AUTOGEN_DEF = NO |
3271 | - |
3272 | -#--------------------------------------------------------------------------- |
3273 | -# configuration options related to the Perl module output |
3274 | -#--------------------------------------------------------------------------- |
3275 | - |
3276 | -# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
3277 | -# generate a Perl module file that captures the structure of |
3278 | -# the code including all documentation. Note that this |
3279 | -# feature is still experimental and incomplete at the |
3280 | -# moment. |
3281 | - |
3282 | -GENERATE_PERLMOD = NO |
3283 | - |
3284 | -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
3285 | -# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
3286 | -# to generate PDF and DVI output from the Perl module output. |
3287 | - |
3288 | -PERLMOD_LATEX = NO |
3289 | - |
3290 | -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
3291 | -# nicely formatted so it can be parsed by a human reader. This is useful |
3292 | -# if you want to understand what is going on. On the other hand, if this |
3293 | -# tag is set to NO the size of the Perl module output will be much smaller |
3294 | -# and Perl will parse it just the same. |
3295 | - |
3296 | -PERLMOD_PRETTY = YES |
3297 | - |
3298 | -# The names of the make variables in the generated doxyrules.make file |
3299 | -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
3300 | -# This is useful so different doxyrules.make files included by the same |
3301 | -# Makefile don't overwrite each other's variables. |
3302 | - |
3303 | -PERLMOD_MAKEVAR_PREFIX = |
3304 | - |
3305 | -#--------------------------------------------------------------------------- |
3306 | -# Configuration options related to the preprocessor |
3307 | -#--------------------------------------------------------------------------- |
3308 | - |
3309 | -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
3310 | -# evaluate all C-preprocessor directives found in the sources and include |
3311 | -# files. |
3312 | - |
3313 | -ENABLE_PREPROCESSING = YES |
3314 | - |
3315 | -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
3316 | -# names in the source code. If set to NO (the default) only conditional |
3317 | -# compilation will be performed. Macro expansion can be done in a controlled |
3318 | -# way by setting EXPAND_ONLY_PREDEF to YES. |
3319 | - |
3320 | -MACRO_EXPANSION = NO |
3321 | - |
3322 | -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
3323 | -# then the macro expansion is limited to the macros specified with the |
3324 | -# PREDEFINED and EXPAND_AS_DEFINED tags. |
3325 | - |
3326 | -EXPAND_ONLY_PREDEF = NO |
3327 | - |
3328 | -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
3329 | -# in the INCLUDE_PATH (see below) will be search if a #include is found. |
3330 | - |
3331 | -SEARCH_INCLUDES = YES |
3332 | - |
3333 | -# The INCLUDE_PATH tag can be used to specify one or more directories that |
3334 | -# contain include files that are not input files but should be processed by |
3335 | -# the preprocessor. |
3336 | - |
3337 | -INCLUDE_PATH = |
3338 | - |
3339 | -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
3340 | -# patterns (like *.h and *.hpp) to filter out the header-files in the |
3341 | -# directories. If left blank, the patterns specified with FILE_PATTERNS will |
3342 | -# be used. |
3343 | - |
3344 | -INCLUDE_FILE_PATTERNS = |
3345 | - |
3346 | -# The PREDEFINED tag can be used to specify one or more macro names that |
3347 | -# are defined before the preprocessor is started (similar to the -D option of |
3348 | -# gcc). The argument of the tag is a list of macros of the form: name |
3349 | -# or name=definition (no spaces). If the definition and the = are |
3350 | -# omitted =1 is assumed. To prevent a macro definition from being |
3351 | -# undefined via #undef or recursively expanded use the := operator |
3352 | -# instead of the = operator. |
3353 | - |
3354 | -PREDEFINED = |
3355 | - |
3356 | -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
3357 | -# this tag can be used to specify a list of macro names that should be expanded. |
3358 | -# The macro definition that is found in the sources will be used. |
3359 | -# Use the PREDEFINED tag if you want to use a different macro definition. |
3360 | - |
3361 | -EXPAND_AS_DEFINED = |
3362 | - |
3363 | -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
3364 | -# doxygen's preprocessor will remove all function-like macros that are alone |
3365 | -# on a line, have an all uppercase name, and do not end with a semicolon. Such |
3366 | -# function macros are typically used for boiler-plate code, and will confuse |
3367 | -# the parser if not removed. |
3368 | - |
3369 | -SKIP_FUNCTION_MACROS = YES |
3370 | - |
3371 | -#--------------------------------------------------------------------------- |
3372 | -# Configuration::additions related to external references |
3373 | -#--------------------------------------------------------------------------- |
3374 | - |
3375 | -# The TAGFILES option can be used to specify one or more tagfiles. |
3376 | -# Optionally an initial location of the external documentation |
3377 | -# can be added for each tagfile. The format of a tag file without |
3378 | -# this location is as follows: |
3379 | -# TAGFILES = file1 file2 ... |
3380 | -# Adding location for the tag files is done as follows: |
3381 | -# TAGFILES = file1=loc1 "file2 = loc2" ... |
3382 | -# where "loc1" and "loc2" can be relative or absolute paths or |
3383 | -# URLs. If a location is present for each tag, the installdox tool |
3384 | -# does not have to be run to correct the links. |
3385 | -# Note that each tag file must have a unique name |
3386 | -# (where the name does NOT include the path) |
3387 | -# If a tag file is not located in the directory in which doxygen |
3388 | -# is run, you must also specify the path to the tagfile here. |
3389 | - |
3390 | -TAGFILES = |
3391 | - |
3392 | -# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
3393 | -# a tag file that is based on the input files it reads. |
3394 | - |
3395 | -GENERATE_TAGFILE = |
3396 | - |
3397 | -# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
3398 | -# in the class index. If set to NO only the inherited external classes |
3399 | -# will be listed. |
3400 | - |
3401 | -ALLEXTERNALS = NO |
3402 | - |
3403 | -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
3404 | -# in the modules index. If set to NO, only the current project's groups will |
3405 | -# be listed. |
3406 | - |
3407 | -EXTERNAL_GROUPS = YES |
3408 | - |
3409 | -# The PERL_PATH should be the absolute path and name of the perl script |
3410 | -# interpreter (i.e. the result of `which perl'). |
3411 | - |
3412 | -PERL_PATH = /usr/bin/perl |
3413 | - |
3414 | -#--------------------------------------------------------------------------- |
3415 | -# Configuration options related to the dot tool |
3416 | -#--------------------------------------------------------------------------- |
3417 | - |
3418 | -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
3419 | -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
3420 | -# or super classes. Setting the tag to NO turns the diagrams off. Note that |
3421 | -# this option is superseded by the HAVE_DOT option below. This is only a |
3422 | -# fallback. It is recommended to install and use dot, since it yields more |
3423 | -# powerful graphs. |
3424 | - |
3425 | -CLASS_DIAGRAMS = NO |
3426 | - |
3427 | -# You can define message sequence charts within doxygen comments using the \msc |
3428 | -# command. Doxygen will then run the mscgen tool (see |
3429 | -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
3430 | -# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
3431 | -# the mscgen tool resides. If left empty the tool is assumed to be found in the |
3432 | -# default search path. |
3433 | - |
3434 | -MSCGEN_PATH = |
3435 | - |
3436 | -# If set to YES, the inheritance and collaboration graphs will hide |
3437 | -# inheritance and usage relations if the target is undocumented |
3438 | -# or is not a class. |
3439 | - |
3440 | -HIDE_UNDOC_RELATIONS = YES |
3441 | - |
3442 | -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
3443 | -# available from the path. This tool is part of Graphviz, a graph visualization |
3444 | -# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
3445 | -# have no effect if this option is set to NO (the default) |
3446 | - |
3447 | -HAVE_DOT = NO |
3448 | - |
3449 | -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
3450 | -# allowed to run in parallel. When set to 0 (the default) doxygen will |
3451 | -# base this on the number of processors available in the system. You can set it |
3452 | -# explicitly to a value larger than 0 to get control over the balance |
3453 | -# between CPU load and processing speed. |
3454 | - |
3455 | -DOT_NUM_THREADS = 0 |
3456 | - |
3457 | -# By default doxygen will write a font called FreeSans.ttf to the output |
3458 | -# directory and reference it in all dot files that doxygen generates. This |
3459 | -# font does not include all possible unicode characters however, so when you need |
3460 | -# these (or just want a differently looking font) you can specify the font name |
3461 | -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, |
3462 | -# which can be done by putting it in a standard location or by setting the |
3463 | -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
3464 | -# containing the font. |
3465 | - |
3466 | -DOT_FONTNAME = FreeSans |
3467 | - |
3468 | -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
3469 | -# The default size is 10pt. |
3470 | - |
3471 | -DOT_FONTSIZE = 10 |
3472 | - |
3473 | -# By default doxygen will tell dot to use the output directory to look for the |
3474 | -# FreeSans.ttf font (which doxygen will put there itself). If you specify a |
3475 | -# different font using DOT_FONTNAME you can set the path where dot |
3476 | -# can find it using this tag. |
3477 | - |
3478 | -DOT_FONTPATH = |
3479 | - |
3480 | -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
3481 | -# will generate a graph for each documented class showing the direct and |
3482 | -# indirect inheritance relations. Setting this tag to YES will force the |
3483 | -# the CLASS_DIAGRAMS tag to NO. |
3484 | - |
3485 | -CLASS_GRAPH = YES |
3486 | - |
3487 | -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
3488 | -# will generate a graph for each documented class showing the direct and |
3489 | -# indirect implementation dependencies (inheritance, containment, and |
3490 | -# class references variables) of the class with other documented classes. |
3491 | - |
3492 | -COLLABORATION_GRAPH = YES |
3493 | - |
3494 | -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
3495 | -# will generate a graph for groups, showing the direct groups dependencies |
3496 | - |
3497 | -GROUP_GRAPHS = YES |
3498 | - |
3499 | -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
3500 | -# collaboration diagrams in a style similar to the OMG's Unified Modeling |
3501 | -# Language. |
3502 | - |
3503 | -UML_LOOK = NO |
3504 | - |
3505 | -# If set to YES, the inheritance and collaboration graphs will show the |
3506 | -# relations between templates and their instances. |
3507 | - |
3508 | -TEMPLATE_RELATIONS = NO |
3509 | - |
3510 | -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
3511 | -# tags are set to YES then doxygen will generate a graph for each documented |
3512 | -# file showing the direct and indirect include dependencies of the file with |
3513 | -# other documented files. |
3514 | - |
3515 | -INCLUDE_GRAPH = YES |
3516 | - |
3517 | -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
3518 | -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
3519 | -# documented header file showing the documented files that directly or |
3520 | -# indirectly include this file. |
3521 | - |
3522 | -INCLUDED_BY_GRAPH = YES |
3523 | - |
3524 | -# If the CALL_GRAPH and HAVE_DOT options are set to YES then |
3525 | -# doxygen will generate a call dependency graph for every global function |
3526 | -# or class method. Note that enabling this option will significantly increase |
3527 | -# the time of a run. So in most cases it will be better to enable call graphs |
3528 | -# for selected functions only using the \callgraph command. |
3529 | - |
3530 | -CALL_GRAPH = YES |
3531 | - |
3532 | -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
3533 | -# doxygen will generate a caller dependency graph for every global function |
3534 | -# or class method. Note that enabling this option will significantly increase |
3535 | -# the time of a run. So in most cases it will be better to enable caller |
3536 | -# graphs for selected functions only using the \callergraph command. |
3537 | - |
3538 | -CALLER_GRAPH = YES |
3539 | - |
3540 | -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
3541 | -# will graphical hierarchy of all classes instead of a textual one. |
3542 | - |
3543 | -GRAPHICAL_HIERARCHY = YES |
3544 | - |
3545 | -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
3546 | -# then doxygen will show the dependencies a directory has on other directories |
3547 | -# in a graphical way. The dependency relations are determined by the #include |
3548 | -# relations between the files in the directories. |
3549 | - |
3550 | -DIRECTORY_GRAPH = YES |
3551 | - |
3552 | -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
3553 | -# generated by dot. Possible values are png, jpg, or gif |
3554 | -# If left blank png will be used. |
3555 | - |
3556 | -DOT_IMAGE_FORMAT = png |
3557 | - |
3558 | -# The tag DOT_PATH can be used to specify the path where the dot tool can be |
3559 | -# found. If left blank, it is assumed the dot tool can be found in the path. |
3560 | - |
3561 | -DOT_PATH = |
3562 | - |
3563 | -# The DOTFILE_DIRS tag can be used to specify one or more directories that |
3564 | -# contain dot files that are included in the documentation (see the |
3565 | -# \dotfile command). |
3566 | - |
3567 | -DOTFILE_DIRS = |
3568 | - |
3569 | -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
3570 | -# nodes that will be shown in the graph. If the number of nodes in a graph |
3571 | -# becomes larger than this value, doxygen will truncate the graph, which is |
3572 | -# visualized by representing a node as a red box. Note that doxygen if the |
3573 | -# number of direct children of the root node in a graph is already larger than |
3574 | -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
3575 | -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
3576 | - |
3577 | -DOT_GRAPH_MAX_NODES = 50 |
3578 | - |
3579 | -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
3580 | -# graphs generated by dot. A depth value of 3 means that only nodes reachable |
3581 | -# from the root by following a path via at most 3 edges will be shown. Nodes |
3582 | -# that lay further from the root node will be omitted. Note that setting this |
3583 | -# option to 1 or 2 may greatly reduce the computation time needed for large |
3584 | -# code bases. Also note that the size of a graph can be further restricted by |
3585 | -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
3586 | - |
3587 | -MAX_DOT_GRAPH_DEPTH = 0 |
3588 | - |
3589 | -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
3590 | -# background. This is disabled by default, because dot on Windows does not |
3591 | -# seem to support this out of the box. Warning: Depending on the platform used, |
3592 | -# enabling this option may lead to badly anti-aliased labels on the edges of |
3593 | -# a graph (i.e. they become hard to read). |
3594 | - |
3595 | -DOT_TRANSPARENT = NO |
3596 | - |
3597 | -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
3598 | -# files in one run (i.e. multiple -o and -T options on the command line). This |
3599 | -# makes dot run faster, but since only newer versions of dot (>1.8.10) |
3600 | -# support this, this feature is disabled by default. |
3601 | - |
3602 | -DOT_MULTI_TARGETS = NO |
3603 | - |
3604 | -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
3605 | -# generate a legend page explaining the meaning of the various boxes and |
3606 | -# arrows in the dot generated graphs. |
3607 | - |
3608 | -GENERATE_LEGEND = YES |
3609 | - |
3610 | -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
3611 | -# remove the intermediate dot files that are used to generate |
3612 | -# the various graphs. |
3613 | - |
3614 | -DOT_CLEANUP = YES |
3615 | |
3616 | === removed file 'documentation/doxyfile_es' |
3617 | --- documentation/doxyfile_es 2011-08-18 16:21:09 +0000 |
3618 | +++ documentation/doxyfile_es 1970-01-01 00:00:00 +0000 |
3619 | @@ -1,1661 +0,0 @@ |
3620 | -# Doxyfile 1.7.1 |
3621 | - |
3622 | -# This file describes the settings to be used by the documentation system |
3623 | -# doxygen (www.doxygen.org) for a project |
3624 | -# |
3625 | -# All text after a hash (#) is considered a comment and will be ignored |
3626 | -# The format is: |
3627 | -# TAG = value [value, ...] |
3628 | -# For lists items can also be appended using: |
3629 | -# TAG += value [value, ...] |
3630 | -# Values that contain spaces should be placed between quotes (" ") |
3631 | - |
3632 | -#--------------------------------------------------------------------------- |
3633 | -# Project related configuration options |
3634 | -#--------------------------------------------------------------------------- |
3635 | - |
3636 | -# This tag specifies the encoding used for all characters in the config file |
3637 | -# that follow. The default is UTF-8 which is also the encoding used for all |
3638 | -# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
3639 | -# iconv built into libc) for the transcoding. See |
3640 | -# http://www.gnu.org/software/libiconv for the list of possible encodings. |
3641 | - |
3642 | -DOXYFILE_ENCODING = UTF-8 |
3643 | - |
3644 | -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
3645 | -# by quotes) that should identify the project. |
3646 | - |
3647 | -PROJECT_NAME = Touchégg |
3648 | - |
3649 | -# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
3650 | -# This could be handy for archiving the generated documentation or |
3651 | -# if some version control system is used. |
3652 | - |
3653 | -PROJECT_NUMBER = 0.2 |
3654 | - |
3655 | -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
3656 | -# base path where the generated documentation will be put. |
3657 | -# If a relative path is entered, it will be relative to the location |
3658 | -# where doxygen was started. If left blank the current directory will be used. |
3659 | - |
3660 | -OUTPUT_DIRECTORY = . |
3661 | - |
3662 | -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
3663 | -# 4096 sub-directories (in 2 levels) under the output directory of each output |
3664 | -# format and will distribute the generated files over these directories. |
3665 | -# Enabling this option can be useful when feeding doxygen a huge amount of |
3666 | -# source files, where putting all generated files in the same directory would |
3667 | -# otherwise cause performance problems for the file system. |
3668 | - |
3669 | -CREATE_SUBDIRS = NO |
3670 | - |
3671 | -# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
3672 | -# documentation generated by doxygen is written. Doxygen will use this |
3673 | -# information to generate all constant output in the proper language. |
3674 | -# The default language is English, other supported languages are: |
3675 | -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
3676 | -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
3677 | -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
3678 | -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
3679 | -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, |
3680 | -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
3681 | - |
3682 | -OUTPUT_LANGUAGE = Spanish |
3683 | - |
3684 | -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
3685 | -# include brief member descriptions after the members that are listed in |
3686 | -# the file and class documentation (similar to JavaDoc). |
3687 | -# Set to NO to disable this. |
3688 | - |
3689 | -BRIEF_MEMBER_DESC = YES |
3690 | - |
3691 | -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
3692 | -# the brief description of a member or function before the detailed description. |
3693 | -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
3694 | -# brief descriptions will be completely suppressed. |
3695 | - |
3696 | -REPEAT_BRIEF = YES |
3697 | - |
3698 | -# This tag implements a quasi-intelligent brief description abbreviator |
3699 | -# that is used to form the text in various listings. Each string |
3700 | -# in this list, if found as the leading text of the brief description, will be |
3701 | -# stripped from the text and the result after processing the whole list, is |
3702 | -# used as the annotated text. Otherwise, the brief description is used as-is. |
3703 | -# If left blank, the following values are used ("$name" is automatically |
3704 | -# replaced with the name of the entity): "The $name class" "The $name widget" |
3705 | -# "The $name file" "is" "provides" "specifies" "contains" |
3706 | -# "represents" "a" "an" "the" |
3707 | - |
3708 | -ABBREVIATE_BRIEF = "The $name class" \ |
3709 | - "The $name widget" \ |
3710 | - "The $name file" \ |
3711 | - is \ |
3712 | - provides \ |
3713 | - specifies \ |
3714 | - contains \ |
3715 | - represents \ |
3716 | - a \ |
3717 | - an \ |
3718 | - the |
3719 | - |
3720 | -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
3721 | -# Doxygen will generate a detailed section even if there is only a brief |
3722 | -# description. |
3723 | - |
3724 | -ALWAYS_DETAILED_SEC = NO |
3725 | - |
3726 | -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
3727 | -# inherited members of a class in the documentation of that class as if those |
3728 | -# members were ordinary class members. Constructors, destructors and assignment |
3729 | -# operators of the base classes will not be shown. |
3730 | - |
3731 | -INLINE_INHERITED_MEMB = NO |
3732 | - |
3733 | -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
3734 | -# path before files name in the file list and in the header files. If set |
3735 | -# to NO the shortest path that makes the file name unique will be used. |
3736 | - |
3737 | -FULL_PATH_NAMES = NO |
3738 | - |
3739 | -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
3740 | -# can be used to strip a user-defined part of the path. Stripping is |
3741 | -# only done if one of the specified strings matches the left-hand part of |
3742 | -# the path. The tag can be used to show relative paths in the file list. |
3743 | -# If left blank the directory from which doxygen is run is used as the |
3744 | -# path to strip. |
3745 | - |
3746 | -STRIP_FROM_PATH = |
3747 | - |
3748 | -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
3749 | -# the path mentioned in the documentation of a class, which tells |
3750 | -# the reader which header file to include in order to use a class. |
3751 | -# If left blank only the name of the header file containing the class |
3752 | -# definition is used. Otherwise one should specify the include paths that |
3753 | -# are normally passed to the compiler using the -I flag. |
3754 | - |
3755 | -STRIP_FROM_INC_PATH = |
3756 | - |
3757 | -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
3758 | -# (but less readable) file names. This can be useful is your file systems |
3759 | -# doesn't support long names like on DOS, Mac, or CD-ROM. |
3760 | - |
3761 | -SHORT_NAMES = NO |
3762 | - |
3763 | -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
3764 | -# will interpret the first line (until the first dot) of a JavaDoc-style |
3765 | -# comment as the brief description. If set to NO, the JavaDoc |
3766 | -# comments will behave just like regular Qt-style comments |
3767 | -# (thus requiring an explicit @brief command for a brief description.) |
3768 | - |
3769 | -JAVADOC_AUTOBRIEF = YES |
3770 | - |
3771 | -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
3772 | -# interpret the first line (until the first dot) of a Qt-style |
3773 | -# comment as the brief description. If set to NO, the comments |
3774 | -# will behave just like regular Qt-style comments (thus requiring |
3775 | -# an explicit \brief command for a brief description.) |
3776 | - |
3777 | -QT_AUTOBRIEF = NO |
3778 | - |
3779 | -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
3780 | -# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
3781 | -# comments) as a brief description. This used to be the default behaviour. |
3782 | -# The new default is to treat a multi-line C++ comment block as a detailed |
3783 | -# description. Set this tag to YES if you prefer the old behaviour instead. |
3784 | - |
3785 | -MULTILINE_CPP_IS_BRIEF = NO |
3786 | - |
3787 | -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
3788 | -# member inherits the documentation from any documented member that it |
3789 | -# re-implements. |
3790 | - |
3791 | -INHERIT_DOCS = YES |
3792 | - |
3793 | -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
3794 | -# a new page for each member. If set to NO, the documentation of a member will |
3795 | -# be part of the file/class/namespace that contains it. |
3796 | - |
3797 | -SEPARATE_MEMBER_PAGES = NO |
3798 | - |
3799 | -# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
3800 | -# Doxygen uses this value to replace tabs by spaces in code fragments. |
3801 | - |
3802 | -TAB_SIZE = 8 |
3803 | - |
3804 | -# This tag can be used to specify a number of aliases that acts |
3805 | -# as commands in the documentation. An alias has the form "name=value". |
3806 | -# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
3807 | -# put the command \sideeffect (or @sideeffect) in the documentation, which |
3808 | -# will result in a user-defined paragraph with heading "Side Effects:". |
3809 | -# You can put \n's in the value part of an alias to insert newlines. |
3810 | - |
3811 | -ALIASES = |
3812 | - |
3813 | -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
3814 | -# sources only. Doxygen will then generate output that is more tailored for C. |
3815 | -# For instance, some of the names that are used will be different. The list |
3816 | -# of all members will be omitted, etc. |
3817 | - |
3818 | -OPTIMIZE_OUTPUT_FOR_C = NO |
3819 | - |
3820 | -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
3821 | -# sources only. Doxygen will then generate output that is more tailored for |
3822 | -# Java. For instance, namespaces will be presented as packages, qualified |
3823 | -# scopes will look different, etc. |
3824 | - |
3825 | -OPTIMIZE_OUTPUT_JAVA = NO |
3826 | - |
3827 | -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
3828 | -# sources only. Doxygen will then generate output that is more tailored for |
3829 | -# Fortran. |
3830 | - |
3831 | -OPTIMIZE_FOR_FORTRAN = NO |
3832 | - |
3833 | -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
3834 | -# sources. Doxygen will then generate output that is tailored for |
3835 | -# VHDL. |
3836 | - |
3837 | -OPTIMIZE_OUTPUT_VHDL = NO |
3838 | - |
3839 | -# Doxygen selects the parser to use depending on the extension of the files it |
3840 | -# parses. With this tag you can assign which parser to use for a given extension. |
3841 | -# Doxygen has a built-in mapping, but you can override or extend it using this |
3842 | -# tag. The format is ext=language, where ext is a file extension, and language |
3843 | -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
3844 | -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
3845 | -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
3846 | -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
3847 | -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
3848 | - |
3849 | -EXTENSION_MAPPING = |
3850 | - |
3851 | -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
3852 | -# to include (a tag file for) the STL sources as input, then you should |
3853 | -# set this tag to YES in order to let doxygen match functions declarations and |
3854 | -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
3855 | -# func(std::string) {}). This also make the inheritance and collaboration |
3856 | -# diagrams that involve STL classes more complete and accurate. |
3857 | - |
3858 | -BUILTIN_STL_SUPPORT = NO |
3859 | - |
3860 | -# If you use Microsoft's C++/CLI language, you should set this option to YES to |
3861 | -# enable parsing support. |
3862 | - |
3863 | -CPP_CLI_SUPPORT = NO |
3864 | - |
3865 | -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
3866 | -# Doxygen will parse them like normal C++ but will assume all classes use public |
3867 | -# instead of private inheritance when no explicit protection keyword is present. |
3868 | - |
3869 | -SIP_SUPPORT = NO |
3870 | - |
3871 | -# For Microsoft's IDL there are propget and propput attributes to indicate getter |
3872 | -# and setter methods for a property. Setting this option to YES (the default) |
3873 | -# will make doxygen to replace the get and set methods by a property in the |
3874 | -# documentation. This will only work if the methods are indeed getting or |
3875 | -# setting a simple type. If this is not the case, or you want to show the |
3876 | -# methods anyway, you should set this option to NO. |
3877 | - |
3878 | -IDL_PROPERTY_SUPPORT = YES |
3879 | - |
3880 | -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
3881 | -# tag is set to YES, then doxygen will reuse the documentation of the first |
3882 | -# member in the group (if any) for the other members of the group. By default |
3883 | -# all members of a group must be documented explicitly. |
3884 | - |
3885 | -DISTRIBUTE_GROUP_DOC = NO |
3886 | - |
3887 | -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
3888 | -# the same type (for instance a group of public functions) to be put as a |
3889 | -# subgroup of that type (e.g. under the Public Functions section). Set it to |
3890 | -# NO to prevent subgrouping. Alternatively, this can be done per class using |
3891 | -# the \nosubgrouping command. |
3892 | - |
3893 | -SUBGROUPING = YES |
3894 | - |
3895 | -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
3896 | -# is documented as struct, union, or enum with the name of the typedef. So |
3897 | -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
3898 | -# with name TypeT. When disabled the typedef will appear as a member of a file, |
3899 | -# namespace, or class. And the struct will be named TypeS. This can typically |
3900 | -# be useful for C code in case the coding convention dictates that all compound |
3901 | -# types are typedef'ed and only the typedef is referenced, never the tag name. |
3902 | - |
3903 | -TYPEDEF_HIDES_STRUCT = NO |
3904 | - |
3905 | -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
3906 | -# determine which symbols to keep in memory and which to flush to disk. |
3907 | -# When the cache is full, less often used symbols will be written to disk. |
3908 | -# For small to medium size projects (<1000 input files) the default value is |
3909 | -# probably good enough. For larger projects a too small cache size can cause |
3910 | -# doxygen to be busy swapping symbols to and from disk most of the time |
3911 | -# causing a significant performance penality. |
3912 | -# If the system has enough physical memory increasing the cache will improve the |
3913 | -# performance by keeping more symbols in memory. Note that the value works on |
3914 | -# a logarithmic scale so increasing the size by one will rougly double the |
3915 | -# memory usage. The cache size is given by this formula: |
3916 | -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
3917 | -# corresponding to a cache size of 2^16 = 65536 symbols |
3918 | - |
3919 | -SYMBOL_CACHE_SIZE = 0 |
3920 | - |
3921 | -#--------------------------------------------------------------------------- |
3922 | -# Build related configuration options |
3923 | -#--------------------------------------------------------------------------- |
3924 | - |
3925 | -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
3926 | -# documentation are documented, even if no documentation was available. |
3927 | -# Private class members and static file members will be hidden unless |
3928 | -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
3929 | - |
3930 | -EXTRACT_ALL = YES |
3931 | - |
3932 | -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
3933 | -# will be included in the documentation. |
3934 | - |
3935 | -EXTRACT_PRIVATE = YES |
3936 | - |
3937 | -# If the EXTRACT_STATIC tag is set to YES all static members of a file |
3938 | -# will be included in the documentation. |
3939 | - |
3940 | -EXTRACT_STATIC = YES |
3941 | - |
3942 | -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
3943 | -# defined locally in source files will be included in the documentation. |
3944 | -# If set to NO only classes defined in header files are included. |
3945 | - |
3946 | -EXTRACT_LOCAL_CLASSES = YES |
3947 | - |
3948 | -# This flag is only useful for Objective-C code. When set to YES local |
3949 | -# methods, which are defined in the implementation section but not in |
3950 | -# the interface are included in the documentation. |
3951 | -# If set to NO (the default) only methods in the interface are included. |
3952 | - |
3953 | -EXTRACT_LOCAL_METHODS = YES |
3954 | - |
3955 | -# If this flag is set to YES, the members of anonymous namespaces will be |
3956 | -# extracted and appear in the documentation as a namespace called |
3957 | -# 'anonymous_namespace{file}', where file will be replaced with the base |
3958 | -# name of the file that contains the anonymous namespace. By default |
3959 | -# anonymous namespace are hidden. |
3960 | - |
3961 | -EXTRACT_ANON_NSPACES = YES |
3962 | - |
3963 | -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
3964 | -# undocumented members of documented classes, files or namespaces. |
3965 | -# If set to NO (the default) these members will be included in the |
3966 | -# various overviews, but no documentation section is generated. |
3967 | -# This option has no effect if EXTRACT_ALL is enabled. |
3968 | - |
3969 | -HIDE_UNDOC_MEMBERS = NO |
3970 | - |
3971 | -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
3972 | -# undocumented classes that are normally visible in the class hierarchy. |
3973 | -# If set to NO (the default) these classes will be included in the various |
3974 | -# overviews. This option has no effect if EXTRACT_ALL is enabled. |
3975 | - |
3976 | -HIDE_UNDOC_CLASSES = NO |
3977 | - |
3978 | -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
3979 | -# friend (class|struct|union) declarations. |
3980 | -# If set to NO (the default) these declarations will be included in the |
3981 | -# documentation. |
3982 | - |
3983 | -HIDE_FRIEND_COMPOUNDS = NO |
3984 | - |
3985 | -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
3986 | -# documentation blocks found inside the body of a function. |
3987 | -# If set to NO (the default) these blocks will be appended to the |
3988 | -# function's detailed documentation block. |
3989 | - |
3990 | -HIDE_IN_BODY_DOCS = NO |
3991 | - |
3992 | -# The INTERNAL_DOCS tag determines if documentation |
3993 | -# that is typed after a \internal command is included. If the tag is set |
3994 | -# to NO (the default) then the documentation will be excluded. |
3995 | -# Set it to YES to include the internal documentation. |
3996 | - |
3997 | -INTERNAL_DOCS = NO |
3998 | - |
3999 | -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
4000 | -# file names in lower-case letters. If set to YES upper-case letters are also |
4001 | -# allowed. This is useful if you have classes or files whose names only differ |
4002 | -# in case and if your file system supports case sensitive file names. Windows |
4003 | -# and Mac users are advised to set this option to NO. |
4004 | - |
4005 | -CASE_SENSE_NAMES = NO |
4006 | - |
4007 | -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
4008 | -# will show members with their full class and namespace scopes in the |
4009 | -# documentation. If set to YES the scope will be hidden. |
4010 | - |
4011 | -HIDE_SCOPE_NAMES = NO |
4012 | - |
4013 | -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
4014 | -# will put a list of the files that are included by a file in the documentation |
4015 | -# of that file. |
4016 | - |
4017 | -SHOW_INCLUDE_FILES = NO |
4018 | - |
4019 | -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen |
4020 | -# will list include files with double quotes in the documentation |
4021 | -# rather than with sharp brackets. |
4022 | - |
4023 | -FORCE_LOCAL_INCLUDES = NO |
4024 | - |
4025 | -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
4026 | -# is inserted in the documentation for inline members. |
4027 | - |
4028 | -INLINE_INFO = NO |
4029 | - |
4030 | -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
4031 | -# will sort the (detailed) documentation of file and class members |
4032 | -# alphabetically by member name. If set to NO the members will appear in |
4033 | -# declaration order. |
4034 | - |
4035 | -SORT_MEMBER_DOCS = YES |
4036 | - |
4037 | -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
4038 | -# brief documentation of file, namespace and class members alphabetically |
4039 | -# by member name. If set to NO (the default) the members will appear in |
4040 | -# declaration order. |
4041 | - |
4042 | -SORT_BRIEF_DOCS = NO |
4043 | - |
4044 | -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
4045 | -# will sort the (brief and detailed) documentation of class members so that |
4046 | -# constructors and destructors are listed first. If set to NO (the default) |
4047 | -# the constructors will appear in the respective orders defined by |
4048 | -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
4049 | -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
4050 | -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
4051 | - |
4052 | -SORT_MEMBERS_CTORS_1ST = NO |
4053 | - |
4054 | -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
4055 | -# hierarchy of group names into alphabetical order. If set to NO (the default) |
4056 | -# the group names will appear in their defined order. |
4057 | - |
4058 | -SORT_GROUP_NAMES = NO |
4059 | - |
4060 | -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
4061 | -# sorted by fully-qualified names, including namespaces. If set to |
4062 | -# NO (the default), the class list will be sorted only by class name, |
4063 | -# not including the namespace part. |
4064 | -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
4065 | -# Note: This option applies only to the class list, not to the |
4066 | -# alphabetical list. |
4067 | - |
4068 | -SORT_BY_SCOPE_NAME = NO |
4069 | - |
4070 | -# The GENERATE_TODOLIST tag can be used to enable (YES) or |
4071 | -# disable (NO) the todo list. This list is created by putting \todo |
4072 | -# commands in the documentation. |
4073 | - |
4074 | -GENERATE_TODOLIST = NO |
4075 | - |
4076 | -# The GENERATE_TESTLIST tag can be used to enable (YES) or |
4077 | -# disable (NO) the test list. This list is created by putting \test |
4078 | -# commands in the documentation. |
4079 | - |
4080 | -GENERATE_TESTLIST = NO |
4081 | - |
4082 | -# The GENERATE_BUGLIST tag can be used to enable (YES) or |
4083 | -# disable (NO) the bug list. This list is created by putting \bug |
4084 | -# commands in the documentation. |
4085 | - |
4086 | -GENERATE_BUGLIST = NO |
4087 | - |
4088 | -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
4089 | -# disable (NO) the deprecated list. This list is created by putting |
4090 | -# \deprecated commands in the documentation. |
4091 | - |
4092 | -GENERATE_DEPRECATEDLIST= NO |
4093 | - |
4094 | -# The ENABLED_SECTIONS tag can be used to enable conditional |
4095 | -# documentation sections, marked by \if sectionname ... \endif. |
4096 | - |
4097 | -ENABLED_SECTIONS = |
4098 | - |
4099 | -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
4100 | -# the initial value of a variable or define consists of for it to appear in |
4101 | -# the documentation. If the initializer consists of more lines than specified |
4102 | -# here it will be hidden. Use a value of 0 to hide initializers completely. |
4103 | -# The appearance of the initializer of individual variables and defines in the |
4104 | -# documentation can be controlled using \showinitializer or \hideinitializer |
4105 | -# command in the documentation regardless of this setting. |
4106 | - |
4107 | -MAX_INITIALIZER_LINES = 30 |
4108 | - |
4109 | -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
4110 | -# at the bottom of the documentation of classes and structs. If set to YES the |
4111 | -# list will mention the files that were used to generate the documentation. |
4112 | - |
4113 | -SHOW_USED_FILES = NO |
4114 | - |
4115 | -# If the sources in your project are distributed over multiple directories |
4116 | -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
4117 | -# in the documentation. The default is NO. |
4118 | - |
4119 | -SHOW_DIRECTORIES = NO |
4120 | - |
4121 | -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
4122 | -# This will remove the Files entry from the Quick Index and from the |
4123 | -# Folder Tree View (if specified). The default is YES. |
4124 | - |
4125 | -SHOW_FILES = NO |
4126 | - |
4127 | -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
4128 | -# Namespaces page. This will remove the Namespaces entry from the Quick Index |
4129 | -# and from the Folder Tree View (if specified). The default is YES. |
4130 | - |
4131 | -SHOW_NAMESPACES = YES |
4132 | - |
4133 | -# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
4134 | -# doxygen should invoke to get the current version for each file (typically from |
4135 | -# the version control system). Doxygen will invoke the program by executing (via |
4136 | -# popen()) the command <command> <input-file>, where <command> is the value of |
4137 | -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
4138 | -# provided by doxygen. Whatever the program writes to standard output |
4139 | -# is used as the file version. See the manual for examples. |
4140 | - |
4141 | -FILE_VERSION_FILTER = |
4142 | - |
4143 | -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
4144 | -# by doxygen. The layout file controls the global structure of the generated |
4145 | -# output files in an output format independent way. The create the layout file |
4146 | -# that represents doxygen's defaults, run doxygen with the -l option. |
4147 | -# You can optionally specify a file name after the option, if omitted |
4148 | -# DoxygenLayout.xml will be used as the name of the layout file. |
4149 | - |
4150 | -LAYOUT_FILE = |
4151 | - |
4152 | -#--------------------------------------------------------------------------- |
4153 | -# configuration options related to warning and progress messages |
4154 | -#--------------------------------------------------------------------------- |
4155 | - |
4156 | -# The QUIET tag can be used to turn on/off the messages that are generated |
4157 | -# by doxygen. Possible values are YES and NO. If left blank NO is used. |
4158 | - |
4159 | -QUIET = NO |
4160 | - |
4161 | -# The WARNINGS tag can be used to turn on/off the warning messages that are |
4162 | -# generated by doxygen. Possible values are YES and NO. If left blank |
4163 | -# NO is used. |
4164 | - |
4165 | -WARNINGS = YES |
4166 | - |
4167 | -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
4168 | -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
4169 | -# automatically be disabled. |
4170 | - |
4171 | -WARN_IF_UNDOCUMENTED = YES |
4172 | - |
4173 | -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
4174 | -# potential errors in the documentation, such as not documenting some |
4175 | -# parameters in a documented function, or documenting parameters that |
4176 | -# don't exist or using markup commands wrongly. |
4177 | - |
4178 | -WARN_IF_DOC_ERROR = YES |
4179 | - |
4180 | -# This WARN_NO_PARAMDOC option can be abled to get warnings for |
4181 | -# functions that are documented, but have no documentation for their parameters |
4182 | -# or return value. If set to NO (the default) doxygen will only warn about |
4183 | -# wrong or incomplete parameter documentation, but not about the absence of |
4184 | -# documentation. |
4185 | - |
4186 | -WARN_NO_PARAMDOC = YES |
4187 | - |
4188 | -# The WARN_FORMAT tag determines the format of the warning messages that |
4189 | -# doxygen can produce. The string should contain the $file, $line, and $text |
4190 | -# tags, which will be replaced by the file and line number from which the |
4191 | -# warning originated and the warning text. Optionally the format may contain |
4192 | -# $version, which will be replaced by the version of the file (if it could |
4193 | -# be obtained via FILE_VERSION_FILTER) |
4194 | - |
4195 | -WARN_FORMAT = "$file:$line: $text" |
4196 | - |
4197 | -# The WARN_LOGFILE tag can be used to specify a file to which warning |
4198 | -# and error messages should be written. If left blank the output is written |
4199 | -# to stderr. |
4200 | - |
4201 | -WARN_LOGFILE = log |
4202 | - |
4203 | -#--------------------------------------------------------------------------- |
4204 | -# configuration options related to the input files |
4205 | -#--------------------------------------------------------------------------- |
4206 | - |
4207 | -# The INPUT tag can be used to specify the files and/or directories that contain |
4208 | -# documented source files. You may enter file names like "myfile.cpp" or |
4209 | -# directories like "/usr/src/myproject". Separate the files or directories |
4210 | -# with spaces. |
4211 | - |
4212 | -INPUT = ../src |
4213 | - |
4214 | -# This tag can be used to specify the character encoding of the source files |
4215 | -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
4216 | -# also the default input encoding. Doxygen uses libiconv (or the iconv built |
4217 | -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
4218 | -# the list of possible encodings. |
4219 | - |
4220 | -INPUT_ENCODING = UTF-8 |
4221 | - |
4222 | -# If the value of the INPUT tag contains directories, you can use the |
4223 | -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
4224 | -# and *.h) to filter out the source-files in the directories. If left |
4225 | -# blank the following patterns are tested: |
4226 | -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
4227 | -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
4228 | - |
4229 | -FILE_PATTERNS = *.c \ |
4230 | - *.cc \ |
4231 | - *.cxx \ |
4232 | - *.cpp \ |
4233 | - *.c++ \ |
4234 | - *.d \ |
4235 | - *.java \ |
4236 | - *.ii \ |
4237 | - *.ixx \ |
4238 | - *.ipp \ |
4239 | - *.i++ \ |
4240 | - *.inl \ |
4241 | - *.h \ |
4242 | - *.hh \ |
4243 | - *.hxx \ |
4244 | - *.hpp \ |
4245 | - *.h++ \ |
4246 | - *.idl \ |
4247 | - *.odl \ |
4248 | - *.cs \ |
4249 | - *.php \ |
4250 | - *.php3 \ |
4251 | - *.inc \ |
4252 | - *.m \ |
4253 | - *.mm \ |
4254 | - *.dox \ |
4255 | - *.py \ |
4256 | - *.f90 \ |
4257 | - *.f \ |
4258 | - *.vhd \ |
4259 | - *.vhdl |
4260 | - |
4261 | -# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
4262 | -# should be searched for input files as well. Possible values are YES and NO. |
4263 | -# If left blank NO is used. |
4264 | - |
4265 | -RECURSIVE = YES |
4266 | - |
4267 | -# The EXCLUDE tag can be used to specify files and/or directories that should |
4268 | -# excluded from the INPUT source files. This way you can easily exclude a |
4269 | -# subdirectory from a directory tree whose root is specified with the INPUT tag. |
4270 | - |
4271 | -EXCLUDE = |
4272 | - |
4273 | -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
4274 | -# directories that are symbolic links (a Unix filesystem feature) are excluded |
4275 | -# from the input. |
4276 | - |
4277 | -EXCLUDE_SYMLINKS = NO |
4278 | - |
4279 | -# If the value of the INPUT tag contains directories, you can use the |
4280 | -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
4281 | -# certain files from those directories. Note that the wildcards are matched |
4282 | -# against the file with absolute path, so to exclude all test directories |
4283 | -# for example use the pattern */test/* |
4284 | - |
4285 | -EXCLUDE_PATTERNS = |
4286 | - |
4287 | -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
4288 | -# (namespaces, classes, functions, etc.) that should be excluded from the |
4289 | -# output. The symbol name can be a fully qualified name, a word, or if the |
4290 | -# wildcard * is used, a substring. Examples: ANamespace, AClass, |
4291 | -# AClass::ANamespace, ANamespace::*Test |
4292 | - |
4293 | -EXCLUDE_SYMBOLS = |
4294 | - |
4295 | -# The EXAMPLE_PATH tag can be used to specify one or more files or |
4296 | -# directories that contain example code fragments that are included (see |
4297 | -# the \include command). |
4298 | - |
4299 | -EXAMPLE_PATH = |
4300 | - |
4301 | -# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
4302 | -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
4303 | -# and *.h) to filter out the source-files in the directories. If left |
4304 | -# blank all files are included. |
4305 | - |
4306 | -EXAMPLE_PATTERNS = * |
4307 | - |
4308 | -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
4309 | -# searched for input files to be used with the \include or \dontinclude |
4310 | -# commands irrespective of the value of the RECURSIVE tag. |
4311 | -# Possible values are YES and NO. If left blank NO is used. |
4312 | - |
4313 | -EXAMPLE_RECURSIVE = NO |
4314 | - |
4315 | -# The IMAGE_PATH tag can be used to specify one or more files or |
4316 | -# directories that contain image that are included in the documentation (see |
4317 | -# the \image command). |
4318 | - |
4319 | -IMAGE_PATH = |
4320 | - |
4321 | -# The INPUT_FILTER tag can be used to specify a program that doxygen should |
4322 | -# invoke to filter for each input file. Doxygen will invoke the filter program |
4323 | -# by executing (via popen()) the command <filter> <input-file>, where <filter> |
4324 | -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
4325 | -# input file. Doxygen will then use the output that the filter program writes |
4326 | -# to standard output. If FILTER_PATTERNS is specified, this tag will be |
4327 | -# ignored. |
4328 | - |
4329 | -INPUT_FILTER = |
4330 | - |
4331 | -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
4332 | -# basis. Doxygen will compare the file name with each pattern and apply the |
4333 | -# filter if there is a match. The filters are a list of the form: |
4334 | -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
4335 | -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
4336 | -# is applied to all files. |
4337 | - |
4338 | -FILTER_PATTERNS = |
4339 | - |
4340 | -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
4341 | -# INPUT_FILTER) will be used to filter the input files when producing source |
4342 | -# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
4343 | - |
4344 | -FILTER_SOURCE_FILES = NO |
4345 | - |
4346 | -#--------------------------------------------------------------------------- |
4347 | -# configuration options related to source browsing |
4348 | -#--------------------------------------------------------------------------- |
4349 | - |
4350 | -# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
4351 | -# be generated. Documented entities will be cross-referenced with these sources. |
4352 | -# Note: To get rid of all source code in the generated output, make sure also |
4353 | -# VERBATIM_HEADERS is set to NO. |
4354 | - |
4355 | -SOURCE_BROWSER = YES |
4356 | - |
4357 | -# Setting the INLINE_SOURCES tag to YES will include the body |
4358 | -# of functions and classes directly in the documentation. |
4359 | - |
4360 | -INLINE_SOURCES = NO |
4361 | - |
4362 | -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
4363 | -# doxygen to hide any special comment blocks from generated source code |
4364 | -# fragments. Normal C and C++ comments will always remain visible. |
4365 | - |
4366 | -STRIP_CODE_COMMENTS = YES |
4367 | - |
4368 | -# If the REFERENCED_BY_RELATION tag is set to YES |
4369 | -# then for each documented function all documented |
4370 | -# functions referencing it will be listed. |
4371 | - |
4372 | -REFERENCED_BY_RELATION = NO |
4373 | - |
4374 | -# If the REFERENCES_RELATION tag is set to YES |
4375 | -# then for each documented function all documented entities |
4376 | -# called/used by that function will be listed. |
4377 | - |
4378 | -REFERENCES_RELATION = NO |
4379 | - |
4380 | -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
4381 | -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
4382 | -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
4383 | -# link to the source code. Otherwise they will link to the documentation. |
4384 | - |
4385 | -REFERENCES_LINK_SOURCE = YES |
4386 | - |
4387 | -# If the USE_HTAGS tag is set to YES then the references to source code |
4388 | -# will point to the HTML generated by the htags(1) tool instead of doxygen |
4389 | -# built-in source browser. The htags tool is part of GNU's global source |
4390 | -# tagging system (see http://www.gnu.org/software/global/global.html). You |
4391 | -# will need version 4.8.6 or higher. |
4392 | - |
4393 | -USE_HTAGS = NO |
4394 | - |
4395 | -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
4396 | -# will generate a verbatim copy of the header file for each class for |
4397 | -# which an include is specified. Set to NO to disable this. |
4398 | - |
4399 | -VERBATIM_HEADERS = YES |
4400 | - |
4401 | -#--------------------------------------------------------------------------- |
4402 | -# configuration options related to the alphabetical class index |
4403 | -#--------------------------------------------------------------------------- |
4404 | - |
4405 | -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
4406 | -# of all compounds will be generated. Enable this if the project |
4407 | -# contains a lot of classes, structs, unions or interfaces. |
4408 | - |
4409 | -ALPHABETICAL_INDEX = NO |
4410 | - |
4411 | -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
4412 | -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
4413 | -# in which this list will be split (can be a number in the range [1..20]) |
4414 | - |
4415 | -COLS_IN_ALPHA_INDEX = 5 |
4416 | - |
4417 | -# In case all classes in a project start with a common prefix, all |
4418 | -# classes will be put under the same header in the alphabetical index. |
4419 | -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
4420 | -# should be ignored while generating the index headers. |
4421 | - |
4422 | -IGNORE_PREFIX = |
4423 | - |
4424 | -#--------------------------------------------------------------------------- |
4425 | -# configuration options related to the HTML output |
4426 | -#--------------------------------------------------------------------------- |
4427 | - |
4428 | -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
4429 | -# generate HTML output. |
4430 | - |
4431 | -GENERATE_HTML = YES |
4432 | - |
4433 | -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
4434 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4435 | -# put in front of it. If left blank `html' will be used as the default path. |
4436 | - |
4437 | -HTML_OUTPUT = html |
4438 | - |
4439 | -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
4440 | -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
4441 | -# doxygen will generate files with .html extension. |
4442 | - |
4443 | -HTML_FILE_EXTENSION = .html |
4444 | - |
4445 | -# The HTML_HEADER tag can be used to specify a personal HTML header for |
4446 | -# each generated HTML page. If it is left blank doxygen will generate a |
4447 | -# standard header. |
4448 | - |
4449 | -HTML_HEADER = |
4450 | - |
4451 | -# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
4452 | -# each generated HTML page. If it is left blank doxygen will generate a |
4453 | -# standard footer. |
4454 | - |
4455 | -HTML_FOOTER = |
4456 | - |
4457 | -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
4458 | -# style sheet that is used by each HTML page. It can be used to |
4459 | -# fine-tune the look of the HTML output. If the tag is left blank doxygen |
4460 | -# will generate a default style sheet. Note that doxygen will try to copy |
4461 | -# the style sheet file to the HTML output directory, so don't put your own |
4462 | -# stylesheet in the HTML output directory as well, or it will be erased! |
4463 | - |
4464 | -HTML_STYLESHEET = |
4465 | - |
4466 | -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
4467 | -# Doxygen will adjust the colors in the stylesheet and background images |
4468 | -# according to this color. Hue is specified as an angle on a colorwheel, |
4469 | -# see http://en.wikipedia.org/wiki/Hue for more information. |
4470 | -# For instance the value 0 represents red, 60 is yellow, 120 is green, |
4471 | -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. |
4472 | -# The allowed range is 0 to 359. |
4473 | - |
4474 | -HTML_COLORSTYLE_HUE = 220 |
4475 | - |
4476 | -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of |
4477 | -# the colors in the HTML output. For a value of 0 the output will use |
4478 | -# grayscales only. A value of 255 will produce the most vivid colors. |
4479 | - |
4480 | -HTML_COLORSTYLE_SAT = 100 |
4481 | - |
4482 | -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to |
4483 | -# the luminance component of the colors in the HTML output. Values below |
4484 | -# 100 gradually make the output lighter, whereas values above 100 make |
4485 | -# the output darker. The value divided by 100 is the actual gamma applied, |
4486 | -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, |
4487 | -# and 100 does not change the gamma. |
4488 | - |
4489 | -HTML_COLORSTYLE_GAMMA = 80 |
4490 | - |
4491 | -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
4492 | -# page will contain the date and time when the page was generated. Setting |
4493 | -# this to NO can help when comparing the output of multiple runs. |
4494 | - |
4495 | -HTML_TIMESTAMP = NO |
4496 | - |
4497 | -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
4498 | -# files or namespaces will be aligned in HTML using tables. If set to |
4499 | -# NO a bullet list will be used. |
4500 | - |
4501 | -HTML_ALIGN_MEMBERS = YES |
4502 | - |
4503 | -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
4504 | -# documentation will contain sections that can be hidden and shown after the |
4505 | -# page has loaded. For this to work a browser that supports |
4506 | -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
4507 | -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
4508 | - |
4509 | -HTML_DYNAMIC_SECTIONS = NO |
4510 | - |
4511 | -# If the GENERATE_DOCSET tag is set to YES, additional index files |
4512 | -# will be generated that can be used as input for Apple's Xcode 3 |
4513 | -# integrated development environment, introduced with OSX 10.5 (Leopard). |
4514 | -# To create a documentation set, doxygen will generate a Makefile in the |
4515 | -# HTML output directory. Running make will produce the docset in that |
4516 | -# directory and running "make install" will install the docset in |
4517 | -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
4518 | -# it at startup. |
4519 | -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
4520 | -# for more information. |
4521 | - |
4522 | -GENERATE_DOCSET = NO |
4523 | - |
4524 | -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
4525 | -# feed. A documentation feed provides an umbrella under which multiple |
4526 | -# documentation sets from a single provider (such as a company or product suite) |
4527 | -# can be grouped. |
4528 | - |
4529 | -DOCSET_FEEDNAME = "Doxygen generated docs" |
4530 | - |
4531 | -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
4532 | -# should uniquely identify the documentation set bundle. This should be a |
4533 | -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
4534 | -# will append .docset to the name. |
4535 | - |
4536 | -DOCSET_BUNDLE_ID = org.doxygen.Project |
4537 | - |
4538 | -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify |
4539 | -# the documentation publisher. This should be a reverse domain-name style |
4540 | -# string, e.g. com.mycompany.MyDocSet.documentation. |
4541 | - |
4542 | -DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
4543 | - |
4544 | -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. |
4545 | - |
4546 | -DOCSET_PUBLISHER_NAME = Publisher |
4547 | - |
4548 | -# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
4549 | -# will be generated that can be used as input for tools like the |
4550 | -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
4551 | -# of the generated HTML documentation. |
4552 | - |
4553 | -GENERATE_HTMLHELP = NO |
4554 | - |
4555 | -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
4556 | -# be used to specify the file name of the resulting .chm file. You |
4557 | -# can add a path in front of the file if the result should not be |
4558 | -# written to the html output directory. |
4559 | - |
4560 | -CHM_FILE = |
4561 | - |
4562 | -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
4563 | -# be used to specify the location (absolute path including file name) of |
4564 | -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
4565 | -# the HTML help compiler on the generated index.hhp. |
4566 | - |
4567 | -HHC_LOCATION = |
4568 | - |
4569 | -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
4570 | -# controls if a separate .chi index file is generated (YES) or that |
4571 | -# it should be included in the master .chm file (NO). |
4572 | - |
4573 | -GENERATE_CHI = NO |
4574 | - |
4575 | -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
4576 | -# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
4577 | -# content. |
4578 | - |
4579 | -CHM_INDEX_ENCODING = |
4580 | - |
4581 | -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
4582 | -# controls whether a binary table of contents is generated (YES) or a |
4583 | -# normal table of contents (NO) in the .chm file. |
4584 | - |
4585 | -BINARY_TOC = NO |
4586 | - |
4587 | -# The TOC_EXPAND flag can be set to YES to add extra items for group members |
4588 | -# to the contents of the HTML help documentation and to the tree view. |
4589 | - |
4590 | -TOC_EXPAND = NO |
4591 | - |
4592 | -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
4593 | -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
4594 | -# that can be used as input for Qt's qhelpgenerator to generate a |
4595 | -# Qt Compressed Help (.qch) of the generated HTML documentation. |
4596 | - |
4597 | -GENERATE_QHP = NO |
4598 | - |
4599 | -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
4600 | -# be used to specify the file name of the resulting .qch file. |
4601 | -# The path specified is relative to the HTML output folder. |
4602 | - |
4603 | -QCH_FILE = |
4604 | - |
4605 | -# The QHP_NAMESPACE tag specifies the namespace to use when generating |
4606 | -# Qt Help Project output. For more information please see |
4607 | -# http://doc.trolltech.com/qthelpproject.html#namespace |
4608 | - |
4609 | -QHP_NAMESPACE = org.doxygen.Project |
4610 | - |
4611 | -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
4612 | -# Qt Help Project output. For more information please see |
4613 | -# http://doc.trolltech.com/qthelpproject.html#virtual-folders |
4614 | - |
4615 | -QHP_VIRTUAL_FOLDER = doc |
4616 | - |
4617 | -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
4618 | -# add. For more information please see |
4619 | -# http://doc.trolltech.com/qthelpproject.html#custom-filters |
4620 | - |
4621 | -QHP_CUST_FILTER_NAME = |
4622 | - |
4623 | -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
4624 | -# custom filter to add. For more information please see |
4625 | -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
4626 | -# Qt Help Project / Custom Filters</a>. |
4627 | - |
4628 | -QHP_CUST_FILTER_ATTRS = |
4629 | - |
4630 | -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
4631 | -# project's |
4632 | -# filter section matches. |
4633 | -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
4634 | -# Qt Help Project / Filter Attributes</a>. |
4635 | - |
4636 | -QHP_SECT_FILTER_ATTRS = |
4637 | - |
4638 | -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
4639 | -# be used to specify the location of Qt's qhelpgenerator. |
4640 | -# If non-empty doxygen will try to run qhelpgenerator on the generated |
4641 | -# .qhp file. |
4642 | - |
4643 | -QHG_LOCATION = |
4644 | - |
4645 | -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files |
4646 | -# will be generated, which together with the HTML files, form an Eclipse help |
4647 | -# plugin. To install this plugin and make it available under the help contents |
4648 | -# menu in Eclipse, the contents of the directory containing the HTML and XML |
4649 | -# files needs to be copied into the plugins directory of eclipse. The name of |
4650 | -# the directory within the plugins directory should be the same as |
4651 | -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
4652 | -# the help appears. |
4653 | - |
4654 | -GENERATE_ECLIPSEHELP = NO |
4655 | - |
4656 | -# A unique identifier for the eclipse help plugin. When installing the plugin |
4657 | -# the directory name containing the HTML and XML files should also have |
4658 | -# this name. |
4659 | - |
4660 | -ECLIPSE_DOC_ID = org.doxygen.Project |
4661 | - |
4662 | -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
4663 | -# top of each HTML page. The value NO (the default) enables the index and |
4664 | -# the value YES disables it. |
4665 | - |
4666 | -DISABLE_INDEX = NO |
4667 | - |
4668 | -# This tag can be used to set the number of enum values (range [1..20]) |
4669 | -# that doxygen will group on one line in the generated HTML documentation. |
4670 | - |
4671 | -ENUM_VALUES_PER_LINE = 4 |
4672 | - |
4673 | -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
4674 | -# structure should be generated to display hierarchical information. |
4675 | -# If the tag value is set to YES, a side panel will be generated |
4676 | -# containing a tree-like index structure (just like the one that |
4677 | -# is generated for HTML Help). For this to work a browser that supports |
4678 | -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
4679 | -# Windows users are probably better off using the HTML help feature. |
4680 | - |
4681 | -GENERATE_TREEVIEW = NO |
4682 | - |
4683 | -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
4684 | -# and Class Hierarchy pages using a tree view instead of an ordered list. |
4685 | - |
4686 | -USE_INLINE_TREES = NO |
4687 | - |
4688 | -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
4689 | -# used to set the initial width (in pixels) of the frame in which the tree |
4690 | -# is shown. |
4691 | - |
4692 | -TREEVIEW_WIDTH = 250 |
4693 | - |
4694 | -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open |
4695 | -# links to external symbols imported via tag files in a separate window. |
4696 | - |
4697 | -EXT_LINKS_IN_WINDOW = NO |
4698 | - |
4699 | -# Use this tag to change the font size of Latex formulas included |
4700 | -# as images in the HTML documentation. The default is 10. Note that |
4701 | -# when you change the font size after a successful doxygen run you need |
4702 | -# to manually remove any form_*.png images from the HTML output directory |
4703 | -# to force them to be regenerated. |
4704 | - |
4705 | -FORMULA_FONTSIZE = 10 |
4706 | - |
4707 | -# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
4708 | -# generated for formulas are transparent PNGs. Transparent PNGs are |
4709 | -# not supported properly for IE 6.0, but are supported on all modern browsers. |
4710 | -# Note that when changing this option you need to delete any form_*.png files |
4711 | -# in the HTML output before the changes have effect. |
4712 | - |
4713 | -FORMULA_TRANSPARENT = YES |
4714 | - |
4715 | -# When the SEARCHENGINE tag is enabled doxygen will generate a search box |
4716 | -# for the HTML output. The underlying search engine uses javascript |
4717 | -# and DHTML and should work on any modern browser. Note that when using |
4718 | -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
4719 | -# (GENERATE_DOCSET) there is already a search function so this one should |
4720 | -# typically be disabled. For large projects the javascript based search engine |
4721 | -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
4722 | - |
4723 | -SEARCHENGINE = NO |
4724 | - |
4725 | -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
4726 | -# implemented using a PHP enabled web server instead of at the web client |
4727 | -# using Javascript. Doxygen will generate the search PHP script and index |
4728 | -# file to put on the web server. The advantage of the server |
4729 | -# based approach is that it scales better to large projects and allows |
4730 | -# full text search. The disadvances is that it is more difficult to setup |
4731 | -# and does not have live searching capabilities. |
4732 | - |
4733 | -SERVER_BASED_SEARCH = NO |
4734 | - |
4735 | -#--------------------------------------------------------------------------- |
4736 | -# configuration options related to the LaTeX output |
4737 | -#--------------------------------------------------------------------------- |
4738 | - |
4739 | -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
4740 | -# generate Latex output. |
4741 | - |
4742 | -GENERATE_LATEX = NO |
4743 | - |
4744 | -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
4745 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4746 | -# put in front of it. If left blank `latex' will be used as the default path. |
4747 | - |
4748 | -LATEX_OUTPUT = latex |
4749 | - |
4750 | -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
4751 | -# invoked. If left blank `latex' will be used as the default command name. |
4752 | -# Note that when enabling USE_PDFLATEX this option is only used for |
4753 | -# generating bitmaps for formulas in the HTML output, but not in the |
4754 | -# Makefile that is written to the output directory. |
4755 | - |
4756 | -LATEX_CMD_NAME = latex |
4757 | - |
4758 | -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
4759 | -# generate index for LaTeX. If left blank `makeindex' will be used as the |
4760 | -# default command name. |
4761 | - |
4762 | -MAKEINDEX_CMD_NAME = makeindex |
4763 | - |
4764 | -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
4765 | -# LaTeX documents. This may be useful for small projects and may help to |
4766 | -# save some trees in general. |
4767 | - |
4768 | -COMPACT_LATEX = NO |
4769 | - |
4770 | -# The PAPER_TYPE tag can be used to set the paper type that is used |
4771 | -# by the printer. Possible values are: a4, a4wide, letter, legal and |
4772 | -# executive. If left blank a4wide will be used. |
4773 | - |
4774 | -PAPER_TYPE = a4wide |
4775 | - |
4776 | -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
4777 | -# packages that should be included in the LaTeX output. |
4778 | - |
4779 | -EXTRA_PACKAGES = |
4780 | - |
4781 | -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
4782 | -# the generated latex document. The header should contain everything until |
4783 | -# the first chapter. If it is left blank doxygen will generate a |
4784 | -# standard header. Notice: only use this tag if you know what you are doing! |
4785 | - |
4786 | -LATEX_HEADER = |
4787 | - |
4788 | -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
4789 | -# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
4790 | -# contain links (just like the HTML output) instead of page references |
4791 | -# This makes the output suitable for online browsing using a pdf viewer. |
4792 | - |
4793 | -PDF_HYPERLINKS = YES |
4794 | - |
4795 | -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
4796 | -# plain latex in the generated Makefile. Set this option to YES to get a |
4797 | -# higher quality PDF documentation. |
4798 | - |
4799 | -USE_PDFLATEX = YES |
4800 | - |
4801 | -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
4802 | -# command to the generated LaTeX files. This will instruct LaTeX to keep |
4803 | -# running if errors occur, instead of asking the user for help. |
4804 | -# This option is also used when generating formulas in HTML. |
4805 | - |
4806 | -LATEX_BATCHMODE = NO |
4807 | - |
4808 | -# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
4809 | -# include the index chapters (such as File Index, Compound Index, etc.) |
4810 | -# in the output. |
4811 | - |
4812 | -LATEX_HIDE_INDICES = NO |
4813 | - |
4814 | -# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
4815 | -# source code with syntax highlighting in the LaTeX output. |
4816 | -# Note that which sources are shown also depends on other settings |
4817 | -# such as SOURCE_BROWSER. |
4818 | - |
4819 | -LATEX_SOURCE_CODE = NO |
4820 | - |
4821 | -#--------------------------------------------------------------------------- |
4822 | -# configuration options related to the RTF output |
4823 | -#--------------------------------------------------------------------------- |
4824 | - |
4825 | -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
4826 | -# The RTF output is optimized for Word 97 and may not look very pretty with |
4827 | -# other RTF readers or editors. |
4828 | - |
4829 | -GENERATE_RTF = NO |
4830 | - |
4831 | -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
4832 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4833 | -# put in front of it. If left blank `rtf' will be used as the default path. |
4834 | - |
4835 | -RTF_OUTPUT = rtf |
4836 | - |
4837 | -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
4838 | -# RTF documents. This may be useful for small projects and may help to |
4839 | -# save some trees in general. |
4840 | - |
4841 | -COMPACT_RTF = NO |
4842 | - |
4843 | -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
4844 | -# will contain hyperlink fields. The RTF file will |
4845 | -# contain links (just like the HTML output) instead of page references. |
4846 | -# This makes the output suitable for online browsing using WORD or other |
4847 | -# programs which support those fields. |
4848 | -# Note: wordpad (write) and others do not support links. |
4849 | - |
4850 | -RTF_HYPERLINKS = NO |
4851 | - |
4852 | -# Load stylesheet definitions from file. Syntax is similar to doxygen's |
4853 | -# config file, i.e. a series of assignments. You only have to provide |
4854 | -# replacements, missing definitions are set to their default value. |
4855 | - |
4856 | -RTF_STYLESHEET_FILE = |
4857 | - |
4858 | -# Set optional variables used in the generation of an rtf document. |
4859 | -# Syntax is similar to doxygen's config file. |
4860 | - |
4861 | -RTF_EXTENSIONS_FILE = |
4862 | - |
4863 | -#--------------------------------------------------------------------------- |
4864 | -# configuration options related to the man page output |
4865 | -#--------------------------------------------------------------------------- |
4866 | - |
4867 | -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
4868 | -# generate man pages |
4869 | - |
4870 | -GENERATE_MAN = NO |
4871 | - |
4872 | -# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
4873 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4874 | -# put in front of it. If left blank `man' will be used as the default path. |
4875 | - |
4876 | -MAN_OUTPUT = man |
4877 | - |
4878 | -# The MAN_EXTENSION tag determines the extension that is added to |
4879 | -# the generated man pages (default is the subroutine's section .3) |
4880 | - |
4881 | -MAN_EXTENSION = .3 |
4882 | - |
4883 | -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
4884 | -# then it will generate one additional man file for each entity |
4885 | -# documented in the real man page(s). These additional files |
4886 | -# only source the real man page, but without them the man command |
4887 | -# would be unable to find the correct page. The default is NO. |
4888 | - |
4889 | -MAN_LINKS = NO |
4890 | - |
4891 | -#--------------------------------------------------------------------------- |
4892 | -# configuration options related to the XML output |
4893 | -#--------------------------------------------------------------------------- |
4894 | - |
4895 | -# If the GENERATE_XML tag is set to YES Doxygen will |
4896 | -# generate an XML file that captures the structure of |
4897 | -# the code including all documentation. |
4898 | - |
4899 | -GENERATE_XML = NO |
4900 | - |
4901 | -# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
4902 | -# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4903 | -# put in front of it. If left blank `xml' will be used as the default path. |
4904 | - |
4905 | -XML_OUTPUT = xml |
4906 | - |
4907 | -# The XML_SCHEMA tag can be used to specify an XML schema, |
4908 | -# which can be used by a validating XML parser to check the |
4909 | -# syntax of the XML files. |
4910 | - |
4911 | -XML_SCHEMA = |
4912 | - |
4913 | -# The XML_DTD tag can be used to specify an XML DTD, |
4914 | -# which can be used by a validating XML parser to check the |
4915 | -# syntax of the XML files. |
4916 | - |
4917 | -XML_DTD = |
4918 | - |
4919 | -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
4920 | -# dump the program listings (including syntax highlighting |
4921 | -# and cross-referencing information) to the XML output. Note that |
4922 | -# enabling this will significantly increase the size of the XML output. |
4923 | - |
4924 | -XML_PROGRAMLISTING = YES |
4925 | - |
4926 | -#--------------------------------------------------------------------------- |
4927 | -# configuration options for the AutoGen Definitions output |
4928 | -#--------------------------------------------------------------------------- |
4929 | - |
4930 | -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
4931 | -# generate an AutoGen Definitions (see autogen.sf.net) file |
4932 | -# that captures the structure of the code including all |
4933 | -# documentation. Note that this feature is still experimental |
4934 | -# and incomplete at the moment. |
4935 | - |
4936 | -GENERATE_AUTOGEN_DEF = NO |
4937 | - |
4938 | -#--------------------------------------------------------------------------- |
4939 | -# configuration options related to the Perl module output |
4940 | -#--------------------------------------------------------------------------- |
4941 | - |
4942 | -# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
4943 | -# generate a Perl module file that captures the structure of |
4944 | -# the code including all documentation. Note that this |
4945 | -# feature is still experimental and incomplete at the |
4946 | -# moment. |
4947 | - |
4948 | -GENERATE_PERLMOD = NO |
4949 | - |
4950 | -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
4951 | -# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
4952 | -# to generate PDF and DVI output from the Perl module output. |
4953 | - |
4954 | -PERLMOD_LATEX = NO |
4955 | - |
4956 | -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
4957 | -# nicely formatted so it can be parsed by a human reader. This is useful |
4958 | -# if you want to understand what is going on. On the other hand, if this |
4959 | -# tag is set to NO the size of the Perl module output will be much smaller |
4960 | -# and Perl will parse it just the same. |
4961 | - |
4962 | -PERLMOD_PRETTY = YES |
4963 | - |
4964 | -# The names of the make variables in the generated doxyrules.make file |
4965 | -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
4966 | -# This is useful so different doxyrules.make files included by the same |
4967 | -# Makefile don't overwrite each other's variables. |
4968 | - |
4969 | -PERLMOD_MAKEVAR_PREFIX = |
4970 | - |
4971 | -#--------------------------------------------------------------------------- |
4972 | -# Configuration options related to the preprocessor |
4973 | -#--------------------------------------------------------------------------- |
4974 | - |
4975 | -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
4976 | -# evaluate all C-preprocessor directives found in the sources and include |
4977 | -# files. |
4978 | - |
4979 | -ENABLE_PREPROCESSING = YES |
4980 | - |
4981 | -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
4982 | -# names in the source code. If set to NO (the default) only conditional |
4983 | -# compilation will be performed. Macro expansion can be done in a controlled |
4984 | -# way by setting EXPAND_ONLY_PREDEF to YES. |
4985 | - |
4986 | -MACRO_EXPANSION = NO |
4987 | - |
4988 | -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
4989 | -# then the macro expansion is limited to the macros specified with the |
4990 | -# PREDEFINED and EXPAND_AS_DEFINED tags. |
4991 | - |
4992 | -EXPAND_ONLY_PREDEF = NO |
4993 | - |
4994 | -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
4995 | -# in the INCLUDE_PATH (see below) will be search if a #include is found. |
4996 | - |
4997 | -SEARCH_INCLUDES = YES |
4998 | - |
4999 | -# The INCLUDE_PATH tag can be used to specify one or more directories that |
5000 | -# contain include files that are not input files but should be processed by |
The diff has been truncated for viewing.
Thanks for your work!