21 |
21 |
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
23 # This could be handy for archiving the generated documentation or |
23 # This could be handy for archiving the generated documentation or |
24 # if some version control system is used. |
24 # if some version control system is used. |
25 |
25 |
26 PROJECT_NUMBER = 0.2 |
26 PROJECT_NUMBER = 0.3 |
27 |
27 |
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
29 # base path where the generated documentation will be put. |
29 # base path where the generated documentation will be put. |
30 # If a relative path is entered, it will be relative to the location |
30 # If a relative path is entered, it will be relative to the location |
31 # where doxygen was started. If left blank the current directory will be used. |
31 # where doxygen was started. If left blank the current directory will be used. |
32 |
32 |
33 OUTPUT_DIRECTORY = |
33 OUTPUT_DIRECTORY = |
34 |
34 |
|
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
|
36 # 4096 sub-directories (in 2 levels) under the output directory of each output |
|
37 # format and will distribute the generated files over these directories. |
|
38 # Enabling this option can be useful when feeding doxygen a huge amount of source |
|
39 # files, where putting all generated files in the same directory would otherwise |
|
40 # cause performance problems for the file system. |
|
41 |
|
42 CREATE_SUBDIRS = NO |
|
43 |
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
36 # documentation generated by doxygen is written. Doxygen will use this |
45 # documentation generated by doxygen is written. Doxygen will use this |
37 # information to generate all constant output in the proper language. |
46 # information to generate all constant output in the proper language. |
38 # The default language is English, other supported languages are: |
47 # The default language is English, other supported languages are: |
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, |
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, |
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en |
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, |
41 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, |
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, |
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, |
|
52 # Swedish, and Ukrainian. |
43 |
53 |
44 OUTPUT_LANGUAGE = English |
54 OUTPUT_LANGUAGE = English |
45 |
55 |
46 # This tag can be used to specify the encoding used in the generated output. |
56 # This tag can be used to specify the encoding used in the generated output. |
47 # The encoding is not always determined by the language that is chosen, |
57 # The encoding is not always determined by the language that is chosen, |
93 |
103 |
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
95 # path before files name in the file list and in the header files. If set |
105 # path before files name in the file list and in the header files. If set |
96 # to NO the shortest path that makes the file name unique will be used. |
106 # to NO the shortest path that makes the file name unique will be used. |
97 |
107 |
98 FULL_PATH_NAMES = NO |
108 FULL_PATH_NAMES = YES |
99 |
109 |
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
101 # can be used to strip a user-defined part of the path. Stripping is |
111 # can be used to strip a user-defined part of the path. Stripping is |
102 # only done if one of the specified strings matches the left-hand part of |
112 # only done if one of the specified strings matches the left-hand part of |
103 # the path. It is allowed to use relative paths in the argument list. |
113 # the path. The tag can be used to show relative paths in the file list. |
104 # If left blank the directory from which doxygen is run is used as the |
114 # If left blank the directory from which doxygen is run is used as the |
105 # path to strip. |
115 # path to strip. |
106 |
116 |
107 STRIP_FROM_PATH = |
117 STRIP_FROM_PATH = ../src |
|
118 |
|
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
|
120 # the path mentioned in the documentation of a class, which tells |
|
121 # the reader which header file to include in order to use a class. |
|
122 # If left blank only the name of the header file containing the class |
|
123 # definition is used. Otherwise one should specify the include paths that |
|
124 # are normally passed to the compiler using the -I flag. |
|
125 |
|
126 STRIP_FROM_INC_PATH = ../src |
108 |
127 |
109 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
110 # (but less readable) file names. This can be useful is your file systems |
129 # (but less readable) file names. This can be useful is your file systems |
111 # doesn't support long names like on DOS, Mac, or CD-ROM. |
130 # doesn't support long names like on DOS, Mac, or CD-ROM. |
112 |
131 |
209 # defined locally in source files will be included in the documentation. |
228 # defined locally in source files will be included in the documentation. |
210 # If set to NO only classes defined in header files are included. |
229 # If set to NO only classes defined in header files are included. |
211 |
230 |
212 EXTRACT_LOCAL_CLASSES = YES |
231 EXTRACT_LOCAL_CLASSES = YES |
213 |
232 |
|
233 # This flag is only useful for Objective-C code. When set to YES local |
|
234 # methods, which are defined in the implementation section but not in |
|
235 # the interface are included in the documentation. |
|
236 # If set to NO (the default) only methods in the interface are included. |
|
237 |
|
238 EXTRACT_LOCAL_METHODS = NO |
|
239 |
214 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
240 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
215 # undocumented members of documented classes, files or namespaces. |
241 # undocumented members of documented classes, files or namespaces. |
216 # If set to NO (the default) these members will be included in the |
242 # If set to NO (the default) these members will be included in the |
217 # various overviews, but no documentation section is generated. |
243 # various overviews, but no documentation section is generated. |
218 # This option has no effect if EXTRACT_ALL is enabled. |
244 # This option has no effect if EXTRACT_ALL is enabled. |
249 |
275 |
250 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
276 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
251 # file names in lower-case letters. If set to YES upper-case letters are also |
277 # file names in lower-case letters. If set to YES upper-case letters are also |
252 # allowed. This is useful if you have classes or files whose names only differ |
278 # allowed. This is useful if you have classes or files whose names only differ |
253 # in case and if your file system supports case sensitive file names. Windows |
279 # in case and if your file system supports case sensitive file names. Windows |
254 # users are advised to set this option to NO. |
280 # and Mac users are advised to set this option to NO. |
255 |
281 |
256 CASE_SENSE_NAMES = YES |
282 CASE_SENSE_NAMES = YES |
257 |
283 |
258 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
284 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
259 # will show members with their full class and namespace scopes in the |
285 # will show members with their full class and namespace scopes in the |
339 # at the bottom of the documentation of classes and structs. If set to YES the |
365 # at the bottom of the documentation of classes and structs. If set to YES the |
340 # list will mention the files that were used to generate the documentation. |
366 # list will mention the files that were used to generate the documentation. |
341 |
367 |
342 SHOW_USED_FILES = YES |
368 SHOW_USED_FILES = YES |
343 |
369 |
|
370 # If the sources in your project are distributed over multiple directories |
|
371 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
|
372 # in the documentation. |
|
373 |
|
374 SHOW_DIRECTORIES = YES |
|
375 |
344 #--------------------------------------------------------------------------- |
376 #--------------------------------------------------------------------------- |
345 # configuration options related to warning and progress messages |
377 # configuration options related to warning and progress messages |
346 #--------------------------------------------------------------------------- |
378 #--------------------------------------------------------------------------- |
347 |
379 |
348 # The QUIET tag can be used to turn on/off the messages that are generated |
380 # The QUIET tag can be used to turn on/off the messages that are generated |
404 # If the value of the INPUT tag contains directories, you can use the |
436 # If the value of the INPUT tag contains directories, you can use the |
405 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
437 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
406 # and *.h) to filter out the source-files in the directories. If left |
438 # and *.h) to filter out the source-files in the directories. If left |
407 # blank the following patterns are tested: |
439 # blank the following patterns are tested: |
408 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
440 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
409 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc |
441 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm |
410 |
442 |
411 FILE_PATTERNS = |
443 FILE_PATTERNS = |
412 |
444 |
413 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
445 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
414 # should be searched for input files as well. Possible values are YES and NO. |
446 # should be searched for input files as well. Possible values are YES and NO. |
462 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
494 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
463 # invoke to filter for each input file. Doxygen will invoke the filter program |
495 # invoke to filter for each input file. Doxygen will invoke the filter program |
464 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
496 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
465 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
497 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
466 # input file. Doxygen will then use the output that the filter program writes |
498 # input file. Doxygen will then use the output that the filter program writes |
467 # to standard output. |
499 # to standard output. If FILTER_PATTERNS is specified, this tag will be |
|
500 # ignored. |
468 |
501 |
469 INPUT_FILTER = |
502 INPUT_FILTER = |
|
503 |
|
504 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
|
505 # basis. Doxygen will compare the file name with each pattern and apply the |
|
506 # filter if there is a match. The filters are a list of the form: |
|
507 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
|
508 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
|
509 # is applied to all files. |
|
510 |
|
511 FILTER_PATTERNS = |
470 |
512 |
471 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
513 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
472 # INPUT_FILTER) will be used to filter the input files when producing source |
514 # INPUT_FILTER) will be used to filter the input files when producing source |
473 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
515 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
474 |
516 |
918 |
960 |
919 # The PREDEFINED tag can be used to specify one or more macro names that |
961 # The PREDEFINED tag can be used to specify one or more macro names that |
920 # are defined before the preprocessor is started (similar to the -D option of |
962 # are defined before the preprocessor is started (similar to the -D option of |
921 # gcc). The argument of the tag is a list of macros of the form: name |
963 # gcc). The argument of the tag is a list of macros of the form: name |
922 # or name=definition (no spaces). If the definition and the = are |
964 # or name=definition (no spaces). If the definition and the = are |
923 # omitted =1 is assumed. |
965 # omitted =1 is assumed. To prevent a macro definition from being |
|
966 # undefined via #undef or recursively expanded use the := operator |
|
967 # instead of the = operator. |
924 |
968 |
925 PREDEFINED = DOXYGEN |
969 PREDEFINED = DOXYGEN |
926 |
970 |
927 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
971 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
928 # this tag can be used to specify a list of macro names that should be expanded. |
972 # this tag can be used to specify a list of macro names that should be expanded. |