Merge lp:~gordallott/unity/unity.optional-doxygen into lp:unity
- unity.optional-doxygen
- Merge into trunk
Proposed by
Gord Allott
Status: | Merged |
---|---|
Merged at revision: | 1220 |
Proposed branch: | lp:~gordallott/unity/unity.optional-doxygen |
Merge into: | lp:unity |
Diff against target: |
1287 lines (+1275/-0) 2 files modified
CMakeLists.txt (+39/-0) Doxyfile.in (+1236/-0) |
To merge this branch: | bzr merge lp:~gordallott/unity/unity.optional-doxygen |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Neil J. Patel (community) | Approve | ||
Review via email: mp+62712@code.launchpad.net |
Commit message
Description of the change
optional doxygen building, unity shouldn't depend on it (check that you can build without installing doxygen) - make doxygen will build the docs and put them in api-doc/
To post a comment you must log in.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'CMakeLists.txt' |
2 | --- CMakeLists.txt 2011-04-27 08:07:58 +0000 |
3 | +++ CMakeLists.txt 2011-05-27 16:48:31 +0000 |
4 | @@ -142,3 +142,42 @@ |
5 | configure_file (${CMAKE_SOURCE_DIR}/${UNITY_SCHEMAS} ${CMAKE_BINARY_DIR}/settings/${UNITY_SCHEMAS}) |
6 | execute_process (COMMAND ${_glib_comple_schemas} ${CMAKE_BINARY_DIR}/settings) |
7 | |
8 | +# |
9 | +# docs |
10 | +# |
11 | + |
12 | +# check if doxygen is even installed |
13 | +find_package(Doxygen) |
14 | +if (DOXYGEN_FOUND STREQUAL "NO") |
15 | + message(FATAL_ERROR "Doxygen not found. Please get a copy http://www.doxygen.org or apt-get install doxygen") |
16 | +endif (DOXYGEN_FOUND STREQUAL "NO") |
17 | + |
18 | +set(TOP_SRCDIR ${CMAKE_CURRENT_SOURCE_DIR}) |
19 | + |
20 | +# prepare doxygen configuration file |
21 | +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) |
22 | + |
23 | + |
24 | + |
25 | +# add doxygen as target |
26 | +add_custom_target(doxygen ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) |
27 | + |
28 | +# cleanup $build/api-doc on "make clean" |
29 | +set_property(DIRECTORY APPEND PROPERTY |
30 | + ADDITIONAL_MAKE_CLEAN_FILES api-doc) |
31 | + |
32 | +# add doxygen as dependency to doc-target |
33 | +# actually don't because didrocks would kill me |
34 | +#get_target_property(DOC_TARGET doc TYPE) |
35 | +#if(NOT DOC_TARGET) |
36 | +# add_custom_target(doc) |
37 | +#endif() |
38 | +#add_dependencies(doc doxygen) |
39 | + |
40 | +# install HTML API documentation and manual pages |
41 | +set(DOC_PATH "share/doc/${CPACK_PACKAGE_NAME}-${VERSION}") |
42 | + |
43 | +install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api-doc/html |
44 | + DESTINATION ${DOC_PATH} |
45 | + ) |
46 | + |
47 | |
48 | === added file 'Doxyfile.in' |
49 | --- Doxyfile.in 1970-01-01 00:00:00 +0000 |
50 | +++ Doxyfile.in 2011-05-27 16:48:31 +0000 |
51 | @@ -0,0 +1,1236 @@ |
52 | +# Doxyfile 1.4.7-4 |
53 | + |
54 | +# This file describes the settings to be used by the documentation system |
55 | +# doxygen (www.doxygen.org) for a project |
56 | +# |
57 | +# All text after a hash (#) is considered a comment and will be ignored |
58 | +# The format is: |
59 | +# TAG = value [value, ...] |
60 | +# For lists items can also be appended using: |
61 | +# TAG += value [value, ...] |
62 | +# Values that contain spaces should be placed between quotes (" ") |
63 | + |
64 | +#--------------------------------------------------------------------------- |
65 | +# Project related configuration options |
66 | +#--------------------------------------------------------------------------- |
67 | + |
68 | +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
69 | +# by quotes) that should identify the project. |
70 | + |
71 | +PROJECT_NAME = @PROJECT_NAME@ - @UNITY_API_VERSION@ |
72 | + |
73 | +# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
74 | +# This could be handy for archiving the generated documentation or |
75 | +# if some version control system is used. |
76 | + |
77 | +PROJECT_NUMBER = @VERSION@ |
78 | + |
79 | +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
80 | +# base path where the generated documentation will be put. |
81 | +# If a relative path is entered, it will be relative to the location |
82 | +# where doxygen was started. If left blank the current directory will be used. |
83 | + |
84 | +OUTPUT_DIRECTORY = api-doc |
85 | + |
86 | +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
87 | +# 4096 sub-directories (in 2 levels) under the output directory of each output |
88 | +# format and will distribute the generated files over these directories. |
89 | +# Enabling this option can be useful when feeding doxygen a huge amount of |
90 | +# source files, where putting all generated files in the same directory would |
91 | +# otherwise cause performance problems for the file system. |
92 | + |
93 | +CREATE_SUBDIRS = NO |
94 | + |
95 | +# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
96 | +# documentation generated by doxygen is written. Doxygen will use this |
97 | +# information to generate all constant output in the proper language. |
98 | +# The default language is English, other supported languages are: |
99 | +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
100 | +# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, |
101 | +# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, |
102 | +# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, |
103 | +# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
104 | + |
105 | +OUTPUT_LANGUAGE = English |
106 | + |
107 | +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
108 | +# include brief member descriptions after the members that are listed in |
109 | +# the file and class documentation (similar to JavaDoc). |
110 | +# Set to NO to disable this. |
111 | + |
112 | +BRIEF_MEMBER_DESC = YES |
113 | + |
114 | +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
115 | +# the brief description of a member or function before the detailed description. |
116 | +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
117 | +# brief descriptions will be completely suppressed. |
118 | + |
119 | +REPEAT_BRIEF = YES |
120 | + |
121 | +# This tag implements a quasi-intelligent brief description abbreviator |
122 | +# that is used to form the text in various listings. Each string |
123 | +# in this list, if found as the leading text of the brief description, will be |
124 | +# stripped from the text and the result after processing the whole list, is |
125 | +# used as the annotated text. Otherwise, the brief description is used as-is. |
126 | +# If left blank, the following values are used ("$name" is automatically |
127 | +# replaced with the name of the entity): "The $name class" "The $name widget" |
128 | +# "The $name file" "is" "provides" "specifies" "contains" |
129 | +# "represents" "a" "an" "the" |
130 | + |
131 | +ABBREVIATE_BRIEF = |
132 | + |
133 | +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
134 | +# Doxygen will generate a detailed section even if there is only a brief |
135 | +# description. |
136 | + |
137 | +ALWAYS_DETAILED_SEC = NO |
138 | + |
139 | +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
140 | +# inherited members of a class in the documentation of that class as if those |
141 | +# members were ordinary class members. Constructors, destructors and assignment |
142 | +# operators of the base classes will not be shown. |
143 | + |
144 | +INLINE_INHERITED_MEMB = NO |
145 | + |
146 | +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
147 | +# path before files name in the file list and in the header files. If set |
148 | +# to NO the shortest path that makes the file name unique will be used. |
149 | + |
150 | +FULL_PATH_NAMES = NO |
151 | + |
152 | +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
153 | +# can be used to strip a user-defined part of the path. Stripping is |
154 | +# only done if one of the specified strings matches the left-hand part of |
155 | +# the path. The tag can be used to show relative paths in the file list. |
156 | +# If left blank the directory from which doxygen is run is used as the |
157 | +# path to strip. |
158 | + |
159 | +STRIP_FROM_PATH = |
160 | + |
161 | +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
162 | +# the path mentioned in the documentation of a class, which tells |
163 | +# the reader which header file to include in order to use a class. |
164 | +# If left blank only the name of the header file containing the class |
165 | +# definition is used. Otherwise one should specify the include paths that |
166 | +# are normally passed to the compiler using the -I flag. |
167 | + |
168 | +STRIP_FROM_INC_PATH = |
169 | + |
170 | +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
171 | +# (but less readable) file names. This can be useful is your file systems |
172 | +# doesn't support long names like on DOS, Mac, or CD-ROM. |
173 | + |
174 | +SHORT_NAMES = NO |
175 | + |
176 | +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
177 | +# will interpret the first line (until the first dot) of a JavaDoc-style |
178 | +# comment as the brief description. If set to NO, the JavaDoc |
179 | +# comments will behave just like the Qt-style comments (thus requiring an |
180 | +# explicit @brief command for a brief description. |
181 | + |
182 | +JAVADOC_AUTOBRIEF = NO |
183 | + |
184 | +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
185 | +# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
186 | +# comments) as a brief description. This used to be the default behaviour. |
187 | +# The new default is to treat a multi-line C++ comment block as a detailed |
188 | +# description. Set this tag to YES if you prefer the old behaviour instead. |
189 | + |
190 | +MULTILINE_CPP_IS_BRIEF = NO |
191 | + |
192 | + |
193 | +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
194 | +# member inherits the documentation from any documented member that it |
195 | +# re-implements. |
196 | + |
197 | +INHERIT_DOCS = YES |
198 | + |
199 | +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
200 | +# a new page for each member. If set to NO, the documentation of a member will |
201 | +# be part of the file/class/namespace that contains it. |
202 | + |
203 | +SEPARATE_MEMBER_PAGES = NO |
204 | + |
205 | +# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
206 | +# Doxygen uses this value to replace tabs by spaces in code fragments. |
207 | + |
208 | +TAB_SIZE = 2 |
209 | + |
210 | +# This tag can be used to specify a number of aliases that acts |
211 | +# as commands in the documentation. An alias has the form "name=value". |
212 | +# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
213 | +# put the command \sideeffect (or @sideeffect) in the documentation, which |
214 | +# will result in a user-defined paragraph with heading "Side Effects:". |
215 | +# You can put \n's in the value part of an alias to insert newlines. |
216 | + |
217 | +ALIASES = |
218 | + |
219 | +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
220 | +# sources only. Doxygen will then generate output that is more tailored for C. |
221 | +# For instance, some of the names that are used will be different. The list |
222 | +# of all members will be omitted, etc. |
223 | + |
224 | +OPTIMIZE_OUTPUT_FOR_C = NO |
225 | + |
226 | +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
227 | +# sources only. Doxygen will then generate output that is more tailored for Java. |
228 | +# For instance, namespaces will be presented as packages, qualified scopes |
229 | +# will look different, etc. |
230 | + |
231 | +OPTIMIZE_OUTPUT_JAVA = NO |
232 | + |
233 | +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to |
234 | +# include (a tag file for) the STL sources as input, then you should |
235 | +# set this tag to YES in order to let doxygen match functions declarations and |
236 | +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
237 | +# func(std::string) {}). This also make the inheritance and collaboration |
238 | +# diagrams that involve STL classes more complete and accurate. |
239 | + |
240 | +BUILTIN_STL_SUPPORT = YES |
241 | + |
242 | +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
243 | +# tag is set to YES, then doxygen will reuse the documentation of the first |
244 | +# member in the group (if any) for the other members of the group. By default |
245 | +# all members of a group must be documented explicitly. |
246 | + |
247 | +DISTRIBUTE_GROUP_DOC = NO |
248 | + |
249 | +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
250 | +# the same type (for instance a group of public functions) to be put as a |
251 | +# subgroup of that type (e.g. under the Public Functions section). Set it to |
252 | +# NO to prevent subgrouping. Alternatively, this can be done per class using |
253 | +# the \nosubgrouping command. |
254 | + |
255 | +SUBGROUPING = YES |
256 | + |
257 | +#--------------------------------------------------------------------------- |
258 | +# Build related configuration options |
259 | +#--------------------------------------------------------------------------- |
260 | + |
261 | +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
262 | +# documentation are documented, even if no documentation was available. |
263 | +# Private class members and static file members will be hidden unless |
264 | +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
265 | + |
266 | +EXTRACT_ALL = YES |
267 | + |
268 | +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
269 | +# will be included in the documentation. |
270 | + |
271 | +EXTRACT_PRIVATE = YES |
272 | + |
273 | +# If the EXTRACT_STATIC tag is set to YES all static members of a file |
274 | +# will be included in the documentation. |
275 | + |
276 | +EXTRACT_STATIC = YES |
277 | + |
278 | +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
279 | +# defined locally in source files will be included in the documentation. |
280 | +# If set to NO only classes defined in header files are included. |
281 | + |
282 | +EXTRACT_LOCAL_CLASSES = YES |
283 | + |
284 | +# This flag is only useful for Objective-C code. When set to YES local |
285 | +# methods, which are defined in the implementation section but not in |
286 | +# the interface are included in the documentation. |
287 | +# If set to NO (the default) only methods in the interface are included. |
288 | + |
289 | +EXTRACT_LOCAL_METHODS = NO |
290 | + |
291 | +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
292 | +# undocumented members of documented classes, files or namespaces. |
293 | +# If set to NO (the default) these members will be included in the |
294 | +# various overviews, but no documentation section is generated. |
295 | +# This option has no effect if EXTRACT_ALL is enabled. |
296 | + |
297 | +HIDE_UNDOC_MEMBERS = NO |
298 | + |
299 | +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
300 | +# undocumented classes that are normally visible in the class hierarchy. |
301 | +# If set to NO (the default) these classes will be included in the various |
302 | +# overviews. This option has no effect if EXTRACT_ALL is enabled. |
303 | + |
304 | +HIDE_UNDOC_CLASSES = NO |
305 | + |
306 | +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
307 | +# friend (class|struct|union) declarations. |
308 | +# If set to NO (the default) these declarations will be included in the |
309 | +# documentation. |
310 | + |
311 | +HIDE_FRIEND_COMPOUNDS = NO |
312 | + |
313 | +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
314 | +# documentation blocks found inside the body of a function. |
315 | +# If set to NO (the default) these blocks will be appended to the |
316 | +# function's detailed documentation block. |
317 | + |
318 | +HIDE_IN_BODY_DOCS = NO |
319 | + |
320 | +# The INTERNAL_DOCS tag determines if documentation |
321 | +# that is typed after a \internal command is included. If the tag is set |
322 | +# to NO (the default) then the documentation will be excluded. |
323 | +# Set it to YES to include the internal documentation. |
324 | + |
325 | +INTERNAL_DOCS = YES |
326 | + |
327 | +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
328 | +# file names in lower-case letters. If set to YES upper-case letters are also |
329 | +# allowed. This is useful if you have classes or files whose names only differ |
330 | +# in case and if your file system supports case sensitive file names. Windows |
331 | +# and Mac users are advised to set this option to NO. |
332 | + |
333 | +CASE_SENSE_NAMES = YES |
334 | + |
335 | +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
336 | +# will show members with their full class and namespace scopes in the |
337 | +# documentation. If set to YES the scope will be hidden. |
338 | + |
339 | +HIDE_SCOPE_NAMES = NO |
340 | + |
341 | +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
342 | +# will put a list of the files that are included by a file in the documentation |
343 | +# of that file. |
344 | + |
345 | +SHOW_INCLUDE_FILES = YES |
346 | + |
347 | +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
348 | +# is inserted in the documentation for inline members. |
349 | + |
350 | +INLINE_INFO = YES |
351 | + |
352 | +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
353 | +# will sort the (detailed) documentation of file and class members |
354 | +# alphabetically by member name. If set to NO the members will appear in |
355 | +# declaration order. |
356 | + |
357 | +SORT_MEMBER_DOCS = NO |
358 | + |
359 | +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
360 | +# brief documentation of file, namespace and class members alphabetically |
361 | +# by member name. If set to NO (the default) the members will appear in |
362 | +# declaration order. |
363 | + |
364 | +SORT_BRIEF_DOCS = NO |
365 | + |
366 | +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
367 | +# sorted by fully-qualified names, including namespaces. If set to |
368 | +# NO (the default), the class list will be sorted only by class name, |
369 | +# not including the namespace part. |
370 | +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
371 | +# Note: This option applies only to the class list, not to the |
372 | +# alphabetical list. |
373 | + |
374 | +SORT_BY_SCOPE_NAME = NO |
375 | + |
376 | +# The GENERATE_TODOLIST tag can be used to enable (YES) or |
377 | +# disable (NO) the todo list. This list is created by putting \todo |
378 | +# commands in the documentation. |
379 | + |
380 | +GENERATE_TODOLIST = YES |
381 | + |
382 | +# The GENERATE_TESTLIST tag can be used to enable (YES) or |
383 | +# disable (NO) the test list. This list is created by putting \test |
384 | +# commands in the documentation. |
385 | + |
386 | +GENERATE_TESTLIST = YES |
387 | + |
388 | +# The GENERATE_BUGLIST tag can be used to enable (YES) or |
389 | +# disable (NO) the bug list. This list is created by putting \bug |
390 | +# commands in the documentation. |
391 | + |
392 | +GENERATE_BUGLIST = YES |
393 | + |
394 | +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
395 | +# disable (NO) the deprecated list. This list is created by putting |
396 | +# \deprecated commands in the documentation. |
397 | + |
398 | +GENERATE_DEPRECATEDLIST= YES |
399 | + |
400 | +# The ENABLED_SECTIONS tag can be used to enable conditional |
401 | +# documentation sections, marked by \if sectionname ... \endif. |
402 | + |
403 | +ENABLED_SECTIONS = |
404 | + |
405 | +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
406 | +# the initial value of a variable or define consists of for it to appear in |
407 | +# the documentation. If the initializer consists of more lines than specified |
408 | +# here it will be hidden. Use a value of 0 to hide initializers completely. |
409 | +# The appearance of the initializer of individual variables and defines in the |
410 | +# documentation can be controlled using \showinitializer or \hideinitializer |
411 | +# command in the documentation regardless of this setting. |
412 | + |
413 | +MAX_INITIALIZER_LINES = 30 |
414 | + |
415 | +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
416 | +# at the bottom of the documentation of classes and structs. If set to YES the |
417 | +# list will mention the files that were used to generate the documentation. |
418 | + |
419 | +SHOW_USED_FILES = YES |
420 | + |
421 | +# If the sources in your project are distributed over multiple directories |
422 | +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
423 | +# in the documentation. The default is NO. |
424 | + |
425 | +SHOW_DIRECTORIES = YES |
426 | + |
427 | +# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
428 | +# doxygen should invoke to get the current version for each file (typically from the |
429 | +# version control system). Doxygen will invoke the program by executing (via |
430 | +# popen()) the command <command> <input-file>, where <command> is the value of |
431 | +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
432 | +# provided by doxygen. Whatever the program writes to standard output |
433 | +# is used as the file version. See the manual for examples. |
434 | + |
435 | +FILE_VERSION_FILTER = |
436 | + |
437 | +#--------------------------------------------------------------------------- |
438 | +# configuration options related to warning and progress messages |
439 | +#--------------------------------------------------------------------------- |
440 | + |
441 | +# The QUIET tag can be used to turn on/off the messages that are generated |
442 | +# by doxygen. Possible values are YES and NO. If left blank NO is used. |
443 | + |
444 | +QUIET = YES |
445 | + |
446 | +# The WARNINGS tag can be used to turn on/off the warning messages that are |
447 | +# generated by doxygen. Possible values are YES and NO. If left blank |
448 | +# NO is used. |
449 | + |
450 | +WARNINGS = YES |
451 | + |
452 | +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
453 | +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
454 | +# automatically be disabled. |
455 | + |
456 | +WARN_IF_UNDOCUMENTED = YES |
457 | + |
458 | +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
459 | +# potential errors in the documentation, such as not documenting some |
460 | +# parameters in a documented function, or documenting parameters that |
461 | +# don't exist or using markup commands wrongly. |
462 | + |
463 | +WARN_IF_DOC_ERROR = YES |
464 | + |
465 | +# This WARN_NO_PARAMDOC option can be abled to get warnings for |
466 | +# functions that are documented, but have no documentation for their parameters |
467 | +# or return value. If set to NO (the default) doxygen will only warn about |
468 | +# wrong or incomplete parameter documentation, but not about the absence of |
469 | +# documentation. |
470 | + |
471 | +WARN_NO_PARAMDOC = NO |
472 | + |
473 | +# The WARN_FORMAT tag determines the format of the warning messages that |
474 | +# doxygen can produce. The string should contain the $file, $line, and $text |
475 | +# tags, which will be replaced by the file and line number from which the |
476 | +# warning originated and the warning text. Optionally the format may contain |
477 | +# $version, which will be replaced by the version of the file (if it could |
478 | +# be obtained via FILE_VERSION_FILTER) |
479 | + |
480 | +WARN_FORMAT = "$file:$line: $text" |
481 | + |
482 | +# The WARN_LOGFILE tag can be used to specify a file to which warning |
483 | +# and error messages should be written. If left blank the output is written |
484 | +# to stderr. |
485 | + |
486 | +WARN_LOGFILE = doxygen-warnings.log |
487 | + |
488 | +#--------------------------------------------------------------------------- |
489 | +# configuration options related to the input files |
490 | +#--------------------------------------------------------------------------- |
491 | + |
492 | +# The INPUT tag can be used to specify the files and/or directories that contain |
493 | +# documented source files. You may enter file names like "myfile.cpp" or |
494 | +# directories like "/usr/src/myproject". Separate the files or directories |
495 | +# with spaces. |
496 | + |
497 | +INPUT = @TOP_SRCDIR@/src @TOP_SRCDIR@/tests @TOP_SRCDIR@/services |
498 | + |
499 | +# If the value of the INPUT tag contains directories, you can use the |
500 | +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
501 | +# and *.h) to filter out the source-files in the directories. If left |
502 | +# blank the following patterns are tested: |
503 | +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
504 | +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py |
505 | + |
506 | +FILE_PATTERNS = |
507 | + |
508 | +# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
509 | +# should be searched for input files as well. Possible values are YES and NO. |
510 | +# If left blank NO is used. |
511 | + |
512 | +RECURSIVE = YES |
513 | + |
514 | +# The EXCLUDE tag can be used to specify files and/or directories that should |
515 | +# excluded from the INPUT source files. This way you can easily exclude a |
516 | +# subdirectory from a directory tree whose root is specified with the INPUT tag. |
517 | + |
518 | +EXCLUDE = |
519 | + |
520 | +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
521 | +# directories that are symbolic links (a Unix filesystem feature) are excluded |
522 | +# from the input. |
523 | + |
524 | +EXCLUDE_SYMLINKS = NO |
525 | + |
526 | +# If the value of the INPUT tag contains directories, you can use the |
527 | +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
528 | +# certain files from those directories. Note that the wildcards are matched |
529 | +# against the file with absolute path, so to exclude all test directories |
530 | +# for example use the pattern */test/* |
531 | + |
532 | +EXCLUDE_PATTERNS = |
533 | + |
534 | +# The EXAMPLE_PATH tag can be used to specify one or more files or |
535 | +# directories that contain example code fragments that are included (see |
536 | +# the \include command). |
537 | + |
538 | +EXAMPLE_PATH = @top_srcdir@/examples |
539 | + |
540 | +# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
541 | +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
542 | +# and *.h) to filter out the source-files in the directories. If left |
543 | +# blank all files are included. |
544 | + |
545 | +EXAMPLE_PATTERNS = |
546 | + |
547 | +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
548 | +# searched for input files to be used with the \include or \dontinclude |
549 | +# commands irrespective of the value of the RECURSIVE tag. |
550 | +# Possible values are YES and NO. If left blank NO is used. |
551 | + |
552 | +EXAMPLE_RECURSIVE = NO |
553 | + |
554 | +# The IMAGE_PATH tag can be used to specify one or more files or |
555 | +# directories that contain image that are included in the documentation (see |
556 | +# the \image command). |
557 | + |
558 | +IMAGE_PATH = |
559 | + |
560 | +# The INPUT_FILTER tag can be used to specify a program that doxygen should |
561 | +# invoke to filter for each input file. Doxygen will invoke the filter program |
562 | +# by executing (via popen()) the command <filter> <input-file>, where <filter> |
563 | +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
564 | +# input file. Doxygen will then use the output that the filter program writes |
565 | +# to standard output. If FILTER_PATTERNS is specified, this tag will be |
566 | +# ignored. |
567 | + |
568 | +INPUT_FILTER = |
569 | + |
570 | +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
571 | +# basis. Doxygen will compare the file name with each pattern and apply the |
572 | +# filter if there is a match. The filters are a list of the form: |
573 | +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
574 | +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
575 | +# is applied to all files. |
576 | + |
577 | +FILTER_PATTERNS = |
578 | + |
579 | +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
580 | +# INPUT_FILTER) will be used to filter the input files when producing source |
581 | +# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
582 | + |
583 | +FILTER_SOURCE_FILES = NO |
584 | + |
585 | +#--------------------------------------------------------------------------- |
586 | +# configuration options related to source browsing |
587 | +#--------------------------------------------------------------------------- |
588 | + |
589 | +# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
590 | +# be generated. Documented entities will be cross-referenced with these sources. |
591 | +# Note: To get rid of all source code in the generated output, make sure also |
592 | +# VERBATIM_HEADERS is set to NO. |
593 | + |
594 | +SOURCE_BROWSER = YES |
595 | + |
596 | +# Setting the INLINE_SOURCES tag to YES will include the body |
597 | +# of functions and classes directly in the documentation. |
598 | + |
599 | +INLINE_SOURCES = YES |
600 | + |
601 | +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
602 | +# doxygen to hide any special comment blocks from generated source code |
603 | +# fragments. Normal C and C++ comments will always remain visible. |
604 | + |
605 | +STRIP_CODE_COMMENTS = YES |
606 | + |
607 | +# If the REFERENCED_BY_RELATION tag is set to YES (the default) |
608 | +# then for each documented function all documented |
609 | +# functions referencing it will be listed. |
610 | + |
611 | +REFERENCED_BY_RELATION = YES |
612 | + |
613 | +# If the REFERENCES_RELATION tag is set to YES (the default) |
614 | +# then for each documented function all documented entities |
615 | +# called/used by that function will be listed. |
616 | + |
617 | +REFERENCES_RELATION = YES |
618 | + |
619 | +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
620 | +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
621 | +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
622 | +# link to the source code. Otherwise they will link to the documentstion. |
623 | + |
624 | +REFERENCES_LINK_SOURCE = YES |
625 | + |
626 | +# If the USE_HTAGS tag is set to YES then the references to source code |
627 | +# will point to the HTML generated by the htags(1) tool instead of doxygen |
628 | +# built-in source browser. The htags tool is part of GNU's global source |
629 | +# tagging system (see http://www.gnu.org/software/global/global.html). You |
630 | +# will need version 4.8.6 or higher. |
631 | + |
632 | +USE_HTAGS = NO |
633 | + |
634 | +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
635 | +# will generate a verbatim copy of the header file for each class for |
636 | +# which an include is specified. Set to NO to disable this. |
637 | + |
638 | +VERBATIM_HEADERS = YES |
639 | + |
640 | +#--------------------------------------------------------------------------- |
641 | +# configuration options related to the alphabetical class index |
642 | +#--------------------------------------------------------------------------- |
643 | + |
644 | +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
645 | +# of all compounds will be generated. Enable this if the project |
646 | +# contains a lot of classes, structs, unions or interfaces. |
647 | + |
648 | +ALPHABETICAL_INDEX = NO |
649 | + |
650 | +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
651 | +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
652 | +# in which this list will be split (can be a number in the range [1..20]) |
653 | + |
654 | +COLS_IN_ALPHA_INDEX = 5 |
655 | + |
656 | +# In case all classes in a project start with a common prefix, all |
657 | +# classes will be put under the same header in the alphabetical index. |
658 | +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
659 | +# should be ignored while generating the index headers. |
660 | + |
661 | +IGNORE_PREFIX = |
662 | + |
663 | +#--------------------------------------------------------------------------- |
664 | +# configuration options related to the HTML output |
665 | +#--------------------------------------------------------------------------- |
666 | + |
667 | +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
668 | +# generate HTML output. |
669 | + |
670 | +GENERATE_HTML = YES |
671 | + |
672 | +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
673 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
674 | +# put in front of it. If left blank `html' will be used as the default path. |
675 | + |
676 | +HTML_OUTPUT = html |
677 | + |
678 | +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
679 | +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
680 | +# doxygen will generate files with .html extension. |
681 | + |
682 | +HTML_FILE_EXTENSION = .html |
683 | + |
684 | +# The HTML_HEADER tag can be used to specify a personal HTML header for |
685 | +# each generated HTML page. If it is left blank doxygen will generate a |
686 | +# standard header. |
687 | + |
688 | +HTML_HEADER = |
689 | + |
690 | +# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
691 | +# each generated HTML page. If it is left blank doxygen will generate a |
692 | +# standard footer. |
693 | + |
694 | +HTML_FOOTER = |
695 | + |
696 | +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
697 | +# style sheet that is used by each HTML page. It can be used to |
698 | +# fine-tune the look of the HTML output. If the tag is left blank doxygen |
699 | +# will generate a default style sheet. Note that doxygen will try to copy |
700 | +# the style sheet file to the HTML output directory, so don't put your own |
701 | +# stylesheet in the HTML output directory as well, or it will be erased! |
702 | + |
703 | +HTML_STYLESHEET = |
704 | + |
705 | +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
706 | +# files or namespaces will be aligned in HTML using tables. If set to |
707 | +# NO a bullet list will be used. |
708 | + |
709 | +HTML_ALIGN_MEMBERS = YES |
710 | + |
711 | +# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
712 | +# will be generated that can be used as input for tools like the |
713 | +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
714 | +# of the generated HTML documentation. |
715 | + |
716 | +GENERATE_HTMLHELP = NO |
717 | + |
718 | +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
719 | +# be used to specify the file name of the resulting .chm file. You |
720 | +# can add a path in front of the file if the result should not be |
721 | +# written to the html output directory. |
722 | + |
723 | +CHM_FILE = |
724 | + |
725 | +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
726 | +# be used to specify the location (absolute path including file name) of |
727 | +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
728 | +# the HTML help compiler on the generated index.hhp. |
729 | + |
730 | +HHC_LOCATION = |
731 | + |
732 | +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
733 | +# controls if a separate .chi index file is generated (YES) or that |
734 | +# it should be included in the master .chm file (NO). |
735 | + |
736 | +GENERATE_CHI = NO |
737 | + |
738 | +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
739 | +# controls whether a binary table of contents is generated (YES) or a |
740 | +# normal table of contents (NO) in the .chm file. |
741 | + |
742 | +BINARY_TOC = NO |
743 | + |
744 | +# The TOC_EXPAND flag can be set to YES to add extra items for group members |
745 | +# to the contents of the HTML help documentation and to the tree view. |
746 | + |
747 | +TOC_EXPAND = NO |
748 | + |
749 | +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
750 | +# top of each HTML page. The value NO (the default) enables the index and |
751 | +# the value YES disables it. |
752 | + |
753 | +DISABLE_INDEX = NO |
754 | + |
755 | +# This tag can be used to set the number of enum values (range [1..20]) |
756 | +# that doxygen will group on one line in the generated HTML documentation. |
757 | + |
758 | +ENUM_VALUES_PER_LINE = 4 |
759 | + |
760 | +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
761 | +# generated containing a tree-like index structure (just like the one that |
762 | +# is generated for HTML Help). For this to work a browser that supports |
763 | +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
764 | +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
765 | +# probably better off using the HTML help feature. |
766 | + |
767 | +GENERATE_TREEVIEW = YES |
768 | + |
769 | +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
770 | +# used to set the initial width (in pixels) of the frame in which the tree |
771 | +# is shown. |
772 | + |
773 | +TREEVIEW_WIDTH = 320 |
774 | + |
775 | +#--------------------------------------------------------------------------- |
776 | +# configuration options related to the LaTeX output |
777 | +#--------------------------------------------------------------------------- |
778 | + |
779 | +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
780 | +# generate Latex output. |
781 | + |
782 | +GENERATE_LATEX = NO |
783 | + |
784 | +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
785 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
786 | +# put in front of it. If left blank `latex' will be used as the default path. |
787 | + |
788 | +LATEX_OUTPUT = latex |
789 | + |
790 | +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
791 | +# invoked. If left blank `latex' will be used as the default command name. |
792 | + |
793 | +LATEX_CMD_NAME = latex |
794 | + |
795 | +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
796 | +# generate index for LaTeX. If left blank `makeindex' will be used as the |
797 | +# default command name. |
798 | + |
799 | +MAKEINDEX_CMD_NAME = makeindex |
800 | + |
801 | +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
802 | +# LaTeX documents. This may be useful for small projects and may help to |
803 | +# save some trees in general. |
804 | + |
805 | +COMPACT_LATEX = NO |
806 | + |
807 | +# The PAPER_TYPE tag can be used to set the paper type that is used |
808 | +# by the printer. Possible values are: a4, a4wide, letter, legal and |
809 | +# executive. If left blank a4wide will be used. |
810 | + |
811 | +PAPER_TYPE = a4wide |
812 | + |
813 | +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
814 | +# packages that should be included in the LaTeX output. |
815 | + |
816 | +EXTRA_PACKAGES = |
817 | + |
818 | +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
819 | +# the generated latex document. The header should contain everything until |
820 | +# the first chapter. If it is left blank doxygen will generate a |
821 | +# standard header. Notice: only use this tag if you know what you are doing! |
822 | + |
823 | +LATEX_HEADER = |
824 | + |
825 | +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
826 | +# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
827 | +# contain links (just like the HTML output) instead of page references |
828 | +# This makes the output suitable for online browsing using a pdf viewer. |
829 | + |
830 | +PDF_HYPERLINKS = NO |
831 | + |
832 | +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
833 | +# plain latex in the generated Makefile. Set this option to YES to get a |
834 | +# higher quality PDF documentation. |
835 | + |
836 | +USE_PDFLATEX = NO |
837 | + |
838 | +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
839 | +# command to the generated LaTeX files. This will instruct LaTeX to keep |
840 | +# running if errors occur, instead of asking the user for help. |
841 | +# This option is also used when generating formulas in HTML. |
842 | + |
843 | +LATEX_BATCHMODE = NO |
844 | + |
845 | +# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
846 | +# include the index chapters (such as File Index, Compound Index, etc.) |
847 | +# in the output. |
848 | + |
849 | +LATEX_HIDE_INDICES = NO |
850 | + |
851 | +#--------------------------------------------------------------------------- |
852 | +# configuration options related to the RTF output |
853 | +#--------------------------------------------------------------------------- |
854 | + |
855 | +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
856 | +# The RTF output is optimized for Word 97 and may not look very pretty with |
857 | +# other RTF readers or editors. |
858 | + |
859 | +GENERATE_RTF = NO |
860 | + |
861 | +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
862 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
863 | +# put in front of it. If left blank `rtf' will be used as the default path. |
864 | + |
865 | +RTF_OUTPUT = rtf |
866 | + |
867 | +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
868 | +# RTF documents. This may be useful for small projects and may help to |
869 | +# save some trees in general. |
870 | + |
871 | +COMPACT_RTF = NO |
872 | + |
873 | +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
874 | +# will contain hyperlink fields. The RTF file will |
875 | +# contain links (just like the HTML output) instead of page references. |
876 | +# This makes the output suitable for online browsing using WORD or other |
877 | +# programs which support those fields. |
878 | +# Note: wordpad (write) and others do not support links. |
879 | + |
880 | +RTF_HYPERLINKS = NO |
881 | + |
882 | +# Load stylesheet definitions from file. Syntax is similar to doxygen's |
883 | +# config file, i.e. a series of assignments. You only have to provide |
884 | +# replacements, missing definitions are set to their default value. |
885 | + |
886 | +RTF_STYLESHEET_FILE = |
887 | + |
888 | +# Set optional variables used in the generation of an rtf document. |
889 | +# Syntax is similar to doxygen's config file. |
890 | + |
891 | +RTF_EXTENSIONS_FILE = |
892 | + |
893 | +#--------------------------------------------------------------------------- |
894 | +# configuration options related to the man page output |
895 | +#--------------------------------------------------------------------------- |
896 | + |
897 | +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
898 | +# generate man pages |
899 | + |
900 | +GENERATE_MAN = NO |
901 | + |
902 | +# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
903 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
904 | +# put in front of it. If left blank `man' will be used as the default path. |
905 | + |
906 | +MAN_OUTPUT = man |
907 | + |
908 | +# The MAN_EXTENSION tag determines the extension that is added to |
909 | +# the generated man pages (default is the subroutine's section .3) |
910 | + |
911 | +MAN_EXTENSION = .3 |
912 | + |
913 | +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
914 | +# then it will generate one additional man file for each entity |
915 | +# documented in the real man page(s). These additional files |
916 | +# only source the real man page, but without them the man command |
917 | +# would be unable to find the correct page. The default is NO. |
918 | + |
919 | +MAN_LINKS = NO |
920 | + |
921 | +#--------------------------------------------------------------------------- |
922 | +# configuration options related to the XML output |
923 | +#--------------------------------------------------------------------------- |
924 | + |
925 | +# If the GENERATE_XML tag is set to YES Doxygen will |
926 | +# generate an XML file that captures the structure of |
927 | +# the code including all documentation. |
928 | + |
929 | +GENERATE_XML = NO |
930 | + |
931 | +# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
932 | +# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
933 | +# put in front of it. If left blank `xml' will be used as the default path. |
934 | + |
935 | +XML_OUTPUT = xml |
936 | + |
937 | +# The XML_SCHEMA tag can be used to specify an XML schema, |
938 | +# which can be used by a validating XML parser to check the |
939 | +# syntax of the XML files. |
940 | + |
941 | +XML_SCHEMA = |
942 | + |
943 | +# The XML_DTD tag can be used to specify an XML DTD, |
944 | +# which can be used by a validating XML parser to check the |
945 | +# syntax of the XML files. |
946 | + |
947 | +XML_DTD = |
948 | + |
949 | +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
950 | +# dump the program listings (including syntax highlighting |
951 | +# and cross-referencing information) to the XML output. Note that |
952 | +# enabling this will significantly increase the size of the XML output. |
953 | + |
954 | +XML_PROGRAMLISTING = YES |
955 | + |
956 | +#--------------------------------------------------------------------------- |
957 | +# configuration options for the AutoGen Definitions output |
958 | +#--------------------------------------------------------------------------- |
959 | + |
960 | +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
961 | +# generate an AutoGen Definitions (see autogen.sf.net) file |
962 | +# that captures the structure of the code including all |
963 | +# documentation. Note that this feature is still experimental |
964 | +# and incomplete at the moment. |
965 | + |
966 | +GENERATE_AUTOGEN_DEF = NO |
967 | + |
968 | +#--------------------------------------------------------------------------- |
969 | +# configuration options related to the Perl module output |
970 | +#--------------------------------------------------------------------------- |
971 | + |
972 | +# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
973 | +# generate a Perl module file that captures the structure of |
974 | +# the code including all documentation. Note that this |
975 | +# feature is still experimental and incomplete at the |
976 | +# moment. |
977 | + |
978 | +GENERATE_PERLMOD = NO |
979 | + |
980 | +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
981 | +# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
982 | +# to generate PDF and DVI output from the Perl module output. |
983 | + |
984 | +PERLMOD_LATEX = NO |
985 | + |
986 | +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
987 | +# nicely formatted so it can be parsed by a human reader. This is useful |
988 | +# if you want to understand what is going on. On the other hand, if this |
989 | +# tag is set to NO the size of the Perl module output will be much smaller |
990 | +# and Perl will parse it just the same. |
991 | + |
992 | +PERLMOD_PRETTY = YES |
993 | + |
994 | +# The names of the make variables in the generated doxyrules.make file |
995 | +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
996 | +# This is useful so different doxyrules.make files included by the same |
997 | +# Makefile don't overwrite each other's variables. |
998 | + |
999 | +PERLMOD_MAKEVAR_PREFIX = |
1000 | + |
1001 | +#--------------------------------------------------------------------------- |
1002 | +# Configuration options related to the preprocessor |
1003 | +#--------------------------------------------------------------------------- |
1004 | + |
1005 | +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
1006 | +# evaluate all C-preprocessor directives found in the sources and include |
1007 | +# files. |
1008 | + |
1009 | +ENABLE_PREPROCESSING = YES |
1010 | + |
1011 | +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1012 | +# names in the source code. If set to NO (the default) only conditional |
1013 | +# compilation will be performed. Macro expansion can be done in a controlled |
1014 | +# way by setting EXPAND_ONLY_PREDEF to YES. |
1015 | + |
1016 | +MACRO_EXPANSION = NO |
1017 | + |
1018 | +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
1019 | +# then the macro expansion is limited to the macros specified with the |
1020 | +# PREDEFINED and EXPAND_AS_DEFINED tags. |
1021 | + |
1022 | +EXPAND_ONLY_PREDEF = NO |
1023 | + |
1024 | +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
1025 | +# in the INCLUDE_PATH (see below) will be search if a #include is found. |
1026 | + |
1027 | +SEARCH_INCLUDES = YES |
1028 | + |
1029 | +# The INCLUDE_PATH tag can be used to specify one or more directories that |
1030 | +# contain include files that are not input files but should be processed by |
1031 | +# the preprocessor. |
1032 | + |
1033 | +INCLUDE_PATH = |
1034 | + |
1035 | +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
1036 | +# patterns (like *.h and *.hpp) to filter out the header-files in the |
1037 | +# directories. If left blank, the patterns specified with FILE_PATTERNS will |
1038 | +# be used. |
1039 | + |
1040 | +INCLUDE_FILE_PATTERNS = |
1041 | + |
1042 | +# The PREDEFINED tag can be used to specify one or more macro names that |
1043 | +# are defined before the preprocessor is started (similar to the -D option of |
1044 | +# gcc). The argument of the tag is a list of macros of the form: name |
1045 | +# or name=definition (no spaces). If the definition and the = are |
1046 | +# omitted =1 is assumed. To prevent a macro definition from being |
1047 | +# undefined via #undef or recursively expanded use the := operator |
1048 | +# instead of the = operator. |
1049 | + |
1050 | +PREDEFINED = LIBFTDI_LINUX_ASYNC_MODE |
1051 | + |
1052 | +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
1053 | +# this tag can be used to specify a list of macro names that should be expanded. |
1054 | +# The macro definition that is found in the sources will be used. |
1055 | +# Use the PREDEFINED tag if you want to use a different macro definition. |
1056 | + |
1057 | +EXPAND_AS_DEFINED = |
1058 | + |
1059 | +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
1060 | +# doxygen's preprocessor will remove all function-like macros that are alone |
1061 | +# on a line, have an all uppercase name, and do not end with a semicolon. Such |
1062 | +# function macros are typically used for boiler-plate code, and will confuse |
1063 | +# the parser if not removed. |
1064 | + |
1065 | +SKIP_FUNCTION_MACROS = YES |
1066 | + |
1067 | +#--------------------------------------------------------------------------- |
1068 | +# Configuration::additions related to external references |
1069 | +#--------------------------------------------------------------------------- |
1070 | + |
1071 | +# The TAGFILES option can be used to specify one or more tagfiles. |
1072 | +# Optionally an initial location of the external documentation |
1073 | +# can be added for each tagfile. The format of a tag file without |
1074 | +# this location is as follows: |
1075 | +# TAGFILES = file1 file2 ... |
1076 | +# Adding location for the tag files is done as follows: |
1077 | +# TAGFILES = file1=loc1 "file2 = loc2" ... |
1078 | +# where "loc1" and "loc2" can be relative or absolute paths or |
1079 | +# URLs. If a location is present for each tag, the installdox tool |
1080 | +# does not have to be run to correct the links. |
1081 | +# Note that each tag file must have a unique name |
1082 | +# (where the name does NOT include the path) |
1083 | +# If a tag file is not located in the directory in which doxygen |
1084 | +# is run, you must also specify the path to the tagfile here. |
1085 | + |
1086 | +TAGFILES = |
1087 | + |
1088 | +# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
1089 | +# a tag file that is based on the input files it reads. |
1090 | + |
1091 | +GENERATE_TAGFILE = |
1092 | + |
1093 | +# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
1094 | +# in the class index. If set to NO only the inherited external classes |
1095 | +# will be listed. |
1096 | + |
1097 | +ALLEXTERNALS = NO |
1098 | + |
1099 | +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
1100 | +# in the modules index. If set to NO, only the current project's groups will |
1101 | +# be listed. |
1102 | + |
1103 | +EXTERNAL_GROUPS = YES |
1104 | + |
1105 | +# The PERL_PATH should be the absolute path and name of the perl script |
1106 | +# interpreter (i.e. the result of `which perl'). |
1107 | + |
1108 | +PERL_PATH = /usr/bin/perl |
1109 | + |
1110 | +#--------------------------------------------------------------------------- |
1111 | +# Configuration options related to the dot tool |
1112 | +#--------------------------------------------------------------------------- |
1113 | + |
1114 | +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1115 | +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1116 | +# or super classes. Setting the tag to NO turns the diagrams off. Note that |
1117 | +# this option is superseded by the HAVE_DOT option below. This is only a |
1118 | +# fallback. It is recommended to install and use dot, since it yields more |
1119 | +# powerful graphs. |
1120 | + |
1121 | +CLASS_DIAGRAMS = YES |
1122 | + |
1123 | +# If set to YES, the inheritance and collaboration graphs will hide |
1124 | +# inheritance and usage relations if the target is undocumented |
1125 | +# or is not a class. |
1126 | + |
1127 | +HIDE_UNDOC_RELATIONS = YES |
1128 | + |
1129 | +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
1130 | +# available from the path. This tool is part of Graphviz, a graph visualization |
1131 | +# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
1132 | +# have no effect if this option is set to NO (the default) |
1133 | + |
1134 | +HAVE_DOT = NO |
1135 | + |
1136 | +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1137 | +# will generate a graph for each documented class showing the direct and |
1138 | +# indirect inheritance relations. Setting this tag to YES will force the |
1139 | +# the CLASS_DIAGRAMS tag to NO. |
1140 | + |
1141 | +CLASS_GRAPH = YES |
1142 | + |
1143 | +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1144 | +# will generate a graph for each documented class showing the direct and |
1145 | +# indirect implementation dependencies (inheritance, containment, and |
1146 | +# class references variables) of the class with other documented classes. |
1147 | + |
1148 | +COLLABORATION_GRAPH = YES |
1149 | + |
1150 | +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1151 | +# will generate a graph for groups, showing the direct groups dependencies |
1152 | + |
1153 | +GROUP_GRAPHS = YES |
1154 | + |
1155 | +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1156 | +# collaboration diagrams in a style similar to the OMG's Unified Modeling |
1157 | +# Language. |
1158 | + |
1159 | +UML_LOOK = NO |
1160 | + |
1161 | +# If set to YES, the inheritance and collaboration graphs will show the |
1162 | +# relations between templates and their instances. |
1163 | + |
1164 | +TEMPLATE_RELATIONS = NO |
1165 | + |
1166 | +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
1167 | +# tags are set to YES then doxygen will generate a graph for each documented |
1168 | +# file showing the direct and indirect include dependencies of the file with |
1169 | +# other documented files. |
1170 | + |
1171 | +INCLUDE_GRAPH = YES |
1172 | + |
1173 | +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
1174 | +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
1175 | +# documented header file showing the documented files that directly or |
1176 | +# indirectly include this file. |
1177 | + |
1178 | +INCLUDED_BY_GRAPH = YES |
1179 | + |
1180 | +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
1181 | +# generate a call dependency graph for every global function or class method. |
1182 | +# Note that enabling this option will significantly increase the time of a run. |
1183 | +# So in most cases it will be better to enable call graphs for selected |
1184 | +# functions only using the \callgraph command. |
1185 | + |
1186 | +CALL_GRAPH = NO |
1187 | + |
1188 | +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
1189 | +# generate a caller dependency graph for every global function or class method. |
1190 | +# Note that enabling this option will significantly increase the time of a run. |
1191 | +# So in most cases it will be better to enable caller graphs for selected |
1192 | +# functions only using the \callergraph command. |
1193 | + |
1194 | +CALLER_GRAPH = NO |
1195 | + |
1196 | +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1197 | +# will graphical hierarchy of all classes instead of a textual one. |
1198 | + |
1199 | +GRAPHICAL_HIERARCHY = YES |
1200 | + |
1201 | +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
1202 | +# then doxygen will show the dependencies a directory has on other directories |
1203 | +# in a graphical way. The dependency relations are determined by the #include |
1204 | +# relations between the files in the directories. |
1205 | + |
1206 | +DIRECTORY_GRAPH = YES |
1207 | + |
1208 | +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1209 | +# generated by dot. Possible values are png, jpg, or gif |
1210 | +# If left blank png will be used. |
1211 | + |
1212 | +DOT_IMAGE_FORMAT = png |
1213 | + |
1214 | +# The tag DOT_PATH can be used to specify the path where the dot tool can be |
1215 | +# found. If left blank, it is assumed the dot tool can be found in the path. |
1216 | + |
1217 | +DOT_PATH = |
1218 | + |
1219 | +# The DOTFILE_DIRS tag can be used to specify one or more directories that |
1220 | +# contain dot files that are included in the documentation (see the |
1221 | +# \dotfile command). |
1222 | + |
1223 | +DOTFILE_DIRS = |
1224 | + |
1225 | +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1226 | +# graphs generated by dot. A depth value of 3 means that only nodes reachable |
1227 | +# from the root by following a path via at most 3 edges will be shown. Nodes |
1228 | +# that lay further from the root node will be omitted. Note that setting this |
1229 | +# option to 1 or 2 may greatly reduce the computation time needed for large |
1230 | +# code bases. Also note that a graph may be further truncated if the graph's |
1231 | +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH |
1232 | +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), |
1233 | +# the graph is not depth-constrained. |
1234 | + |
1235 | +MAX_DOT_GRAPH_DEPTH = 0 |
1236 | + |
1237 | +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1238 | +# background. This is disabled by default, which results in a white background. |
1239 | +# Warning: Depending on the platform used, enabling this option may lead to |
1240 | +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
1241 | +# read). |
1242 | + |
1243 | +DOT_TRANSPARENT = NO |
1244 | + |
1245 | +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
1246 | +# files in one run (i.e. multiple -o and -T options on the command line). This |
1247 | +# makes dot run faster, but since only newer versions of dot (>1.8.10) |
1248 | +# support this, this feature is disabled by default. |
1249 | + |
1250 | +DOT_MULTI_TARGETS = NO |
1251 | + |
1252 | +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1253 | +# generate a legend page explaining the meaning of the various boxes and |
1254 | +# arrows in the dot generated graphs. |
1255 | + |
1256 | +GENERATE_LEGEND = YES |
1257 | + |
1258 | +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
1259 | +# remove the intermediate dot files that are used to generate |
1260 | +# the various graphs. |
1261 | + |
1262 | +DOT_CLEANUP = YES |
1263 | + |
1264 | +#--------------------------------------------------------------------------- |
1265 | +# Configuration::additions related to the search engine |
1266 | +#--------------------------------------------------------------------------- |
1267 | + |
1268 | +# When the SEARCHENGINE tag is enabled doxygen will generate a search box |
1269 | +# for the HTML output. The underlying search engine uses javascript |
1270 | +# and DHTML and should work on any modern browser. Note that when using |
1271 | +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
1272 | +# (GENERATE_DOCSET) there is already a search function so this one should |
1273 | +# typically be disabled. For large projects the javascript based search engine |
1274 | +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
1275 | + |
1276 | +SEARCHENGINE = YES |
1277 | + |
1278 | +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
1279 | +# implemented using a PHP enabled web server instead of at the web client |
1280 | +# using Javascript. Doxygen will generate the search PHP script and index |
1281 | +# file to put on the web server. The advantage of the server |
1282 | +# based approach is that it scales better to large projects and allows |
1283 | +# full text search. The disadvances is that it is more difficult to setup |
1284 | +# and does not have live searching capabilities. |
1285 | + |
1286 | +SERVER_BASED_SEARCH = NO |
1287 | + |
Awesome work dude!