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