Mercurial > hg > orthanc
annotate OrthancServer/Resources/OrthancPlugin.doxygen @ 4802:6a23cd1fc66b
fix news
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Tue, 19 Oct 2021 17:00:23 +0200 |
| parents | 19a2f1d2b816 |
| children | 3b7fb32ecbb0 |
| rev | line source |
|---|---|
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1 # Doxyfile 1.8.7 |
| 0 | 2 |
| 3 # This file describes the settings to be used by the documentation system | |
| 4 # doxygen (www.doxygen.org) for a project. | |
| 5 # | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
6 # All text after a double hash (##) is considered a comment and is placed in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
7 # front of the TAG it is preceding. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
8 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
9 # All text after a single hash (#) is considered a comment and will be ignored. |
| 0 | 10 # The format is: |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
11 # TAG = value [value, ...] |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
12 # For lists, items can also be appended using: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
13 # TAG += value [value, ...] |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
14 # Values that contain spaces should be placed between quotes (\" \"). |
| 0 | 15 |
| 16 #--------------------------------------------------------------------------- | |
| 17 # Project related configuration options | |
| 18 #--------------------------------------------------------------------------- | |
| 19 | |
| 20 # This tag specifies the encoding used for all characters in the config file | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
21 # that follow. The default is UTF-8 which is also the encoding used for all text |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
24 # for the list of possible encodings. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
25 # The default value is: UTF-8. |
| 0 | 26 |
| 27 DOXYFILE_ENCODING = UTF-8 | |
| 28 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
30 # double-quotes, unless you are using Doxywizard) that should identify the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
31 # project for which the documentation is generated. This name is used in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
32 # title of most generated pages and in a few other places. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
33 # The default value is: My Project. |
| 0 | 34 |
| 900 | 35 PROJECT_NAME = "Orthanc Plugin SDK" |
| 0 | 36 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
38 # could be handy for archiving the generated documentation or if some version |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
39 # control system is used. |
| 0 | 40 |
|
2155
86089e777691
version in doxygen
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1430
diff
changeset
|
41 PROJECT_NUMBER = @ORTHANC_VERSION@ |
| 0 | 42 |
| 43 # Using the PROJECT_BRIEF tag one can provide an optional one line description | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
44 # for a project that appears at the top of each page and should give viewer a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
45 # quick idea about the purpose of the project. Keep the description short. |
| 0 | 46 |
| 900 | 47 PROJECT_BRIEF = "Documentation of the plugin interface of Orthanc" |
| 0 | 48 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
50 # the documentation. The maximum height of the logo should not exceed 55 pixels |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
52 # to the output directory. |
| 0 | 53 |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4072
diff
changeset
|
54 PROJECT_LOGO = @CMAKE_SOURCE_DIR@/Resources/OrthancLogoDocumentation.png |
| 0 | 55 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
57 # into which the generated documentation will be written. If a relative path is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
58 # entered, it will be relative to the location where doxygen was started. If |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
59 # left blank the current directory will be used. |
| 0 | 60 |
| 900 | 61 OUTPUT_DIRECTORY = OrthancPluginDocumentation |
| 0 | 62 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
64 # directories (in 2 levels) under the output directory of each output format and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
65 # will distribute the generated files over these directories. Enabling this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
66 # option can be useful when feeding doxygen a huge amount of source files, where |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
67 # putting all generated files in the same directory would otherwise causes |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
68 # performance problems for the file system. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
69 # The default value is: NO. |
| 0 | 70 |
| 71 CREATE_SUBDIRS = NO | |
| 72 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
74 # characters to appear in the names of generated files. If set to NO, non-ASCII |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
76 # U+3044. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
77 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
78 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
79 ALLOW_UNICODE_NAMES = NO |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
80 |
| 0 | 81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| 82 # documentation generated by doxygen is written. Doxygen will use this | |
| 83 # information to generate all constant output in the proper language. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
91 # Ukrainian and Vietnamese. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
92 # The default value is: English. |
| 0 | 93 |
| 94 OUTPUT_LANGUAGE = English | |
| 95 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
97 # descriptions after the members that are listed in the file and class |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
98 # documentation (similar to Javadoc). Set to NO to disable this. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
99 # The default value is: YES. |
| 0 | 100 |
| 101 BRIEF_MEMBER_DESC = YES | |
| 102 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
104 # description of a member or function before the detailed description |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
105 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| 0 | 107 # brief descriptions will be completely suppressed. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
108 # The default value is: YES. |
| 0 | 109 |
| 573 | 110 REPEAT_BRIEF = NO |
| 0 | 111 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
112 # This tag implements a quasi-intelligent brief description abbreviator that is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
113 # used to form the text in various listings. Each string in this list, if found |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
114 # as the leading text of the brief description, will be stripped from the text |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
115 # and the result, after processing the whole list, is used as the annotated |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
116 # text. Otherwise, the brief description is used as-is. If left blank, the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
117 # following values are used ($name is automatically replaced with the name of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
118 # the entity):The $name class, The $name widget, The $name file, is, provides, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
119 # specifies, contains, represents, a, an and the. |
| 0 | 120 |
| 121 ABBREVIATE_BRIEF = | |
| 122 | |
| 123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
124 # doxygen will generate a detailed section even if there is only a brief |
| 0 | 125 # description. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
126 # The default value is: NO. |
| 0 | 127 |
| 128 ALWAYS_DETAILED_SEC = NO | |
| 129 | |
| 130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | |
| 131 # inherited members of a class in the documentation of that class as if those | |
| 132 # members were ordinary class members. Constructors, destructors and assignment | |
| 133 # operators of the base classes will not be shown. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
134 # The default value is: NO. |
| 0 | 135 |
| 136 INLINE_INHERITED_MEMB = NO | |
| 137 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
139 # before files name in the file list and in the header files. If set to NO the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
140 # shortest path that makes the file name unique will be used |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
141 # The default value is: YES. |
| 0 | 142 |
|
593
9d2592c08919
documentation completed
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
591
diff
changeset
|
143 FULL_PATH_NAMES = NO |
| 0 | 144 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
146 # Stripping is only done if one of the specified strings matches the left-hand |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
147 # part of the path. The tag can be used to show relative paths in the file list. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
148 # If left blank the directory from which doxygen is run is used as the path to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
149 # strip. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
150 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
151 # Note that you can specify absolute paths here, but also relative paths, which |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
152 # will be relative from the directory where doxygen is started. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES. |
| 0 | 154 |
| 155 STRIP_FROM_PATH = | |
| 156 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
158 # path mentioned in the documentation of a class, which tells the reader which |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
159 # header file to include in order to use a class. If left blank only the name of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
160 # the header file containing the class definition is used. Otherwise one should |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
161 # specify the list of include paths that are normally passed to the compiler |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
162 # using the -I flag. |
| 0 | 163 |
| 164 STRIP_FROM_INC_PATH = | |
| 165 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
167 # less readable) file names. This can be useful is your file systems doesn't |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
168 # support long names like on DOS, Mac, or CD-ROM. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
169 # The default value is: NO. |
| 0 | 170 |
| 171 SHORT_NAMES = NO | |
| 172 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
174 # first line (until the first dot) of a Javadoc-style comment as the brief |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
176 # style comments (thus requiring an explicit @brief command for a brief |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
177 # description.) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
178 # The default value is: NO. |
| 0 | 179 |
| 180 JAVADOC_AUTOBRIEF = NO | |
| 181 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
183 # line (until the first dot) of a Qt-style comment as the brief description. If |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
185 # requiring an explicit \brief command for a brief description.) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
186 # The default value is: NO. |
| 0 | 187 |
| 188 QT_AUTOBRIEF = NO | |
| 189 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
192 # a brief description. This used to be the default behavior. The new default is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
193 # to treat a multi-line C++ comment block as a detailed description. Set this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
194 # tag to YES if you prefer the old behavior instead. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
195 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
196 # Note that setting this tag to YES also means that rational rose comments are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
197 # not recognized any more. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
198 # The default value is: NO. |
| 0 | 199 |
| 200 MULTILINE_CPP_IS_BRIEF = NO | |
| 201 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
203 # documentation from any documented member that it re-implements. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
204 # The default value is: YES. |
| 0 | 205 |
| 206 INHERIT_DOCS = YES | |
| 207 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
209 # new page for each member. If set to NO, the documentation of a member will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
210 # part of the file/class/namespace that contains it. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
211 # The default value is: NO. |
| 0 | 212 |
| 213 SEPARATE_MEMBER_PAGES = NO | |
| 214 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
216 # uses this value to replace tabs by spaces in code fragments. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
217 # Minimum value: 1, maximum value: 16, default value: 4. |
| 0 | 218 |
| 219 TAB_SIZE = 8 | |
| 220 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
221 # This tag can be used to specify a number of aliases that act as commands in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
222 # the documentation. An alias has the form: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
223 # name=value |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
224 # For example adding |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
225 # "sideeffect=@par Side Effects:\n" |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
226 # will allow you to put the command \sideeffect (or @sideeffect) in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
227 # documentation, which will result in a user-defined paragraph with heading |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
228 # "Side Effects:". You can put \n's in the value part of an alias to insert |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
229 # newlines. |
| 0 | 230 |
| 231 ALIASES = | |
| 232 | |
| 660 | 233 # This tag can be used to specify a number of word-keyword mappings (TCL only). |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
234 # A mapping has the form "name=value". For example adding "class=itcl::class" |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
235 # will allow you to use the command class in the itcl::class meaning. |
| 660 | 236 |
| 237 TCL_SUBST = | |
| 238 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
240 # only. Doxygen will then generate output that is more tailored for C. For |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
241 # instance, some of the names that are used will be different. The list of all |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
242 # members will be omitted, etc. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
243 # The default value is: NO. |
| 0 | 244 |
| 245 OPTIMIZE_OUTPUT_FOR_C = NO | |
| 246 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
248 # Python sources only. Doxygen will then generate output that is more tailored |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
249 # for that language. For instance, namespaces will be presented as packages, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
250 # qualified scopes will look different, etc. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
251 # The default value is: NO. |
| 0 | 252 |
| 253 OPTIMIZE_OUTPUT_JAVA = NO | |
| 254 | |
| 255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
256 # sources. Doxygen will then generate output that is tailored for Fortran. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
257 # The default value is: NO. |
| 0 | 258 |
| 259 OPTIMIZE_FOR_FORTRAN = NO | |
| 260 | |
| 261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
262 # sources. Doxygen will then generate output that is tailored for VHDL. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
263 # The default value is: NO. |
| 0 | 264 |
| 265 OPTIMIZE_OUTPUT_VHDL = NO | |
| 266 | |
| 267 # Doxygen selects the parser to use depending on the extension of the files it | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
268 # parses. With this tag you can assign which parser to use for a given |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
269 # extension. Doxygen has a built-in mapping, but you can override or extend it |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
270 # using this tag. The format is ext=language, where ext is a file extension, and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
274 # Fortran. In the later case the parser tries to guess whether the code is fixed |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
275 # or free formatted code, this is the default for Fortran type files), VHDL. For |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
276 # instance to make doxygen treat .inc files as Fortran files (default is PHP), |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
277 # and .f files as C (default is Fortran), use: inc=Fortran f=C. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
278 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
279 # Note For files without extension you can use no_extension as a placeholder. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
280 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
282 # the files are not read by doxygen. |
| 0 | 283 |
| 284 EXTENSION_MAPPING = | |
| 285 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
287 # according to the Markdown format, which allows for more readable |
| 660 | 288 # documentation. See http://daringfireball.net/projects/markdown/ for details. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
289 # The output of markdown processing is further processed by doxygen, so you can |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
291 # case of backward compatibilities issues. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
292 # The default value is: YES. |
| 660 | 293 |
| 294 MARKDOWN_SUPPORT = YES | |
| 295 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
296 # When enabled doxygen tries to link words that correspond to documented |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
297 # classes, or namespaces to their corresponding documentation. Such a link can |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
298 # be prevented in individual cases by by putting a % sign in front of the word |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
299 # or globally by setting AUTOLINK_SUPPORT to NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
300 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
301 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
302 AUTOLINK_SUPPORT = YES |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
303 |
| 0 | 304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
305 # to include (a tag file for) the STL sources as input, then you should set this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
306 # tag to YES in order to let doxygen match functions declarations and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
307 # definitions whose arguments contain STL classes (e.g. func(std::string); |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
308 # versus func(std::string) {}). This also make the inheritance and collaboration |
| 0 | 309 # diagrams that involve STL classes more complete and accurate. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
310 # The default value is: NO. |
| 0 | 311 |
| 312 BUILTIN_STL_SUPPORT = YES | |
| 313 | |
| 314 # If you use Microsoft's C++/CLI language, you should set this option to YES to | |
| 315 # enable parsing support. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
316 # The default value is: NO. |
| 0 | 317 |
| 318 CPP_CLI_SUPPORT = NO | |
| 319 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
322 # will parse them like normal C++ but will assume all classes use public instead |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
323 # of private inheritance when no explicit protection keyword is present. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
324 # The default value is: NO. |
| 0 | 325 |
| 326 SIP_SUPPORT = NO | |
| 327 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
328 # For Microsoft's IDL there are propget and propput attributes to indicate |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
329 # getter and setter methods for a property. Setting this option to YES will make |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
330 # doxygen to replace the get and set methods by a property in the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
331 # This will only work if the methods are indeed getting or setting a simple |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
332 # type. If this is not the case, or you want to show the methods anyway, you |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
333 # should set this option to NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
334 # The default value is: YES. |
| 0 | 335 |
| 336 IDL_PROPERTY_SUPPORT = YES | |
| 337 | |
| 338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
| 339 # tag is set to YES, then doxygen will reuse the documentation of the first | |
| 340 # member in the group (if any) for the other members of the group. By default | |
| 341 # all members of a group must be documented explicitly. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
342 # The default value is: NO. |
| 0 | 343 |
| 344 DISTRIBUTE_GROUP_DOC = NO | |
| 345 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
347 # (for instance a group of public functions) to be put as a subgroup of that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
348 # type (e.g. under the Public Functions section). Set it to NO to prevent |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
349 # subgrouping. Alternatively, this can be done per class using the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
350 # \nosubgrouping command. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
351 # The default value is: YES. |
| 0 | 352 |
| 353 SUBGROUPING = YES | |
| 354 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
356 # are shown inside the group in which they are included (e.g. using \ingroup) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
358 # and RTF). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
359 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
360 # Note that this feature does not work in combination with |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
361 # SEPARATE_MEMBER_PAGES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
362 # The default value is: NO. |
| 0 | 363 |
| 364 INLINE_GROUPED_CLASSES = NO | |
| 365 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
367 # with only public data fields or simple typedef fields will be shown inline in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
368 # the documentation of the scope in which they are defined (i.e. file, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
369 # namespace, or group documentation), provided this scope is documented. If set |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
371 # Man pages) or section (for LaTeX and RTF). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
372 # The default value is: NO. |
| 660 | 373 |
| 374 INLINE_SIMPLE_STRUCTS = NO | |
| 375 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
377 # enum is documented as struct, union, or enum with the name of the typedef. So |
| 0 | 378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
| 379 # with name TypeT. When disabled the typedef will appear as a member of a file, | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
380 # namespace, or class. And the struct will be named TypeS. This can typically be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
381 # useful for C code in case the coding convention dictates that all compound |
| 0 | 382 # types are typedef'ed and only the typedef is referenced, never the tag name. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
383 # The default value is: NO. |
| 0 | 384 |
| 385 TYPEDEF_HIDES_STRUCT = NO | |
| 386 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
388 # cache is used to resolve symbols given their name and scope. Since this can be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
389 # an expensive process and often the same symbol appears multiple times in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
391 # doxygen will become slower. If the cache is too large, memory is wasted. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
394 # symbols. At the end of a run doxygen will report the cache usage and suggest |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
395 # the optimal cache size from a speed point of view. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
396 # Minimum value: 0, maximum value: 9, default value: 0. |
| 660 | 397 |
| 398 LOOKUP_CACHE_SIZE = 0 | |
| 399 | |
| 0 | 400 #--------------------------------------------------------------------------- |
| 401 # Build related configuration options | |
| 402 #--------------------------------------------------------------------------- | |
| 403 | |
| 404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
405 # documentation are documented, even if no documentation was available. Private |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
406 # class members and static file members will be hidden unless the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
408 # Note: This will also disable the warnings about undocumented members that are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
409 # normally produced when WARNINGS is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
410 # The default value is: NO. |
| 0 | 411 |
| 591 | 412 EXTRACT_ALL = NO |
| 0 | 413 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
415 # be included in the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
416 # The default value is: NO. |
| 0 | 417 |
| 418 EXTRACT_PRIVATE = NO | |
| 419 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
421 # scope will be included in the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
422 # The default value is: NO. |
| 660 | 423 |
| 424 EXTRACT_PACKAGE = NO | |
| 425 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
427 # included in the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
428 # The default value is: NO. |
| 0 | 429 |
| 430 EXTRACT_STATIC = NO | |
| 431 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
433 # locally in source files will be included in the documentation. If set to NO |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
434 # only classes defined in header files are included. Does not have any effect |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
435 # for Java sources. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
436 # The default value is: YES. |
| 0 | 437 |
| 438 EXTRACT_LOCAL_CLASSES = YES | |
| 439 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
440 # This flag is only useful for Objective-C code. When set to YES local methods, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
441 # which are defined in the implementation section but not in the interface are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
442 # included in the documentation. If set to NO only methods in the interface are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
443 # included. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
444 # The default value is: NO. |
| 0 | 445 |
| 446 EXTRACT_LOCAL_METHODS = NO | |
| 447 | |
| 448 # If this flag is set to YES, the members of anonymous namespaces will be | |
| 449 # extracted and appear in the documentation as a namespace called | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
450 # 'anonymous_namespace{file}', where file will be replaced with the base name of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
451 # the file that contains the anonymous namespace. By default anonymous namespace |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
452 # are hidden. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
453 # The default value is: NO. |
| 0 | 454 |
| 455 EXTRACT_ANON_NSPACES = NO | |
| 456 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
458 # undocumented members inside documented classes or files. If set to NO these |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
459 # members will be included in the various overviews, but no documentation |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
460 # section is generated. This option has no effect if EXTRACT_ALL is enabled. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
461 # The default value is: NO. |
| 0 | 462 |
| 463 HIDE_UNDOC_MEMBERS = NO | |
| 464 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
466 # undocumented classes that are normally visible in the class hierarchy. If set |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
467 # to NO these classes will be included in the various overviews. This option has |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
468 # no effect if EXTRACT_ALL is enabled. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
469 # The default value is: NO. |
| 0 | 470 |
| 471 HIDE_UNDOC_CLASSES = NO | |
| 472 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
474 # (class|struct|union) declarations. If set to NO these declarations will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
475 # included in the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
476 # The default value is: NO. |
| 0 | 477 |
| 573 | 478 HIDE_FRIEND_COMPOUNDS = YES |
| 0 | 479 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
481 # documentation blocks found inside the body of a function. If set to NO these |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
482 # blocks will be appended to the function's detailed documentation block. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
483 # The default value is: NO. |
| 0 | 484 |
| 485 HIDE_IN_BODY_DOCS = NO | |
| 486 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
488 # \internal command is included. If the tag is set to NO then the documentation |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
489 # will be excluded. Set it to YES to include the internal documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
490 # The default value is: NO. |
| 0 | 491 |
| 492 INTERNAL_DOCS = NO | |
| 493 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
495 # names in lower-case letters. If set to YES upper-case letters are also |
| 0 | 496 # allowed. This is useful if you have classes or files whose names only differ |
| 497 # in case and if your file system supports case sensitive file names. Windows | |
| 498 # and Mac users are advised to set this option to NO. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
499 # The default value is: system dependent. |
| 0 | 500 |
| 501 CASE_SENSE_NAMES = YES | |
| 502 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
504 # their full class and namespace scopes in the documentation. If set to YES the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
505 # scope will be hidden. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
506 # The default value is: NO. |
| 0 | 507 |
| 508 HIDE_SCOPE_NAMES = NO | |
| 509 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
511 # the files that are included by a file in the documentation of that file. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
512 # The default value is: YES. |
| 0 | 513 |
| 514 SHOW_INCLUDE_FILES = YES | |
| 515 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
517 # grouped member an include statement to the documentation, telling the reader |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
518 # which file to include in order to use the member. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
519 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
520 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
521 SHOW_GROUPED_MEMB_INC = NO |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
522 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
524 # files with double quotes in the documentation rather than with sharp brackets. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
525 # The default value is: NO. |
| 0 | 526 |
| 527 FORCE_LOCAL_INCLUDES = NO | |
| 528 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
530 # documentation for inline members. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
531 # The default value is: YES. |
| 0 | 532 |
| 533 INLINE_INFO = YES | |
| 534 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
535 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
536 # (detailed) documentation of file and class members alphabetically by member |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
537 # name. If set to NO the members will appear in declaration order. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
538 # The default value is: YES. |
| 0 | 539 |
| 540 SORT_MEMBER_DOCS = YES | |
| 541 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
543 # descriptions of file, namespace and class members alphabetically by member |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
544 # name. If set to NO the members will appear in declaration order. Note that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
545 # this will also influence the order of the classes in the class list. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
546 # The default value is: NO. |
| 0 | 547 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2693
diff
changeset
|
548 SORT_BRIEF_DOCS = YES |
| 0 | 549 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
550 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
551 # (brief and detailed) documentation of class members so that constructors and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
552 # destructors are listed first. If set to NO the constructors will appear in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
553 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
554 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
555 # member documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
556 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
557 # detailed member documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
558 # The default value is: NO. |
| 0 | 559 |
| 560 SORT_MEMBERS_CTORS_1ST = NO | |
| 561 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
562 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
563 # of group names into alphabetical order. If set to NO the group names will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
564 # appear in their defined order. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
565 # The default value is: NO. |
| 0 | 566 |
| 567 SORT_GROUP_NAMES = NO | |
| 568 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
569 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
570 # fully-qualified names, including namespaces. If set to NO, the class list will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
571 # be sorted only by class name, not including the namespace part. |
| 0 | 572 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
573 # Note: This option applies only to the class list, not to the alphabetical |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
574 # list. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
575 # The default value is: NO. |
| 0 | 576 |
| 577 SORT_BY_SCOPE_NAME = NO | |
| 578 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
579 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
580 # type resolution of all parameters of a function it will reject a match between |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
581 # the prototype and the implementation of a member function even if there is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
582 # only one candidate or it is obvious which candidate to choose by doing a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
583 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
584 # accept a match between prototype and implementation in such cases. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
585 # The default value is: NO. |
| 0 | 586 |
| 587 STRICT_PROTO_MATCHING = NO | |
| 588 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
590 # todo list. This list is created by putting \todo commands in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
591 # documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
592 # The default value is: YES. |
| 0 | 593 |
| 594 GENERATE_TODOLIST = YES | |
| 595 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
597 # test list. This list is created by putting \test commands in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
598 # documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
599 # The default value is: YES. |
| 0 | 600 |
| 601 GENERATE_TESTLIST = YES | |
| 602 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
604 # list. This list is created by putting \bug commands in the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
605 # The default value is: YES. |
| 0 | 606 |
| 607 GENERATE_BUGLIST = YES | |
| 608 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
610 # the deprecated list. This list is created by putting \deprecated commands in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
611 # the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
612 # The default value is: YES. |
| 0 | 613 |
| 614 GENERATE_DEPRECATEDLIST= YES | |
| 615 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
616 # The ENABLED_SECTIONS tag can be used to enable conditional documentation |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
617 # sections, marked by \if <section_label> ... \endif and \cond <section_label> |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
618 # ... \endcond blocks. |
| 0 | 619 |
| 620 ENABLED_SECTIONS = | |
| 621 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
622 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
623 # initial value of a variable or macro / define can have for it to appear in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
624 # documentation. If the initializer consists of more lines than specified here |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
625 # it will be hidden. Use a value of 0 to hide initializers completely. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
626 # appearance of the value of individual variables and macros / defines can be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
627 # controlled using \showinitializer or \hideinitializer command in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
628 # documentation regardless of this setting. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
629 # Minimum value: 0, maximum value: 10000, default value: 30. |
| 0 | 630 |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
631 MAX_INITIALIZER_LINES = 0 |
| 0 | 632 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
633 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
634 # the bottom of the documentation of classes and structs. If set to YES the list |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
635 # will mention the files that were used to generate the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
636 # The default value is: YES. |
| 0 | 637 |
| 638 SHOW_USED_FILES = YES | |
| 639 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
640 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
641 # will remove the Files entry from the Quick Index and from the Folder Tree View |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
642 # (if specified). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
643 # The default value is: YES. |
| 0 | 644 |
| 645 SHOW_FILES = YES | |
| 646 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
647 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
648 # page. This will remove the Namespaces entry from the Quick Index and from the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
649 # Folder Tree View (if specified). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
650 # The default value is: YES. |
| 0 | 651 |
| 652 SHOW_NAMESPACES = YES | |
| 653 | |
| 654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that | |
| 655 # doxygen should invoke to get the current version for each file (typically from | |
| 656 # the version control system). Doxygen will invoke the program by executing (via | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
657 # popen()) the command command input-file, where command is the value of the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
658 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
659 # by doxygen. Whatever the program writes to standard output is used as the file |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
660 # version. For an example see the documentation. |
| 0 | 661 |
| 662 FILE_VERSION_FILTER = | |
| 663 | |
| 664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | |
| 665 # by doxygen. The layout file controls the global structure of the generated | |
| 660 | 666 # output files in an output format independent way. To create the layout file |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
667 # that represents doxygen's defaults, run doxygen with the -l option. You can |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
669 # will be used as the name of the layout file. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
670 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
671 # Note that if you run doxygen from a directory containing a file called |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
672 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
673 # tag is left empty. |
| 0 | 674 |
| 675 LAYOUT_FILE = | |
| 676 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
677 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
678 # the reference definitions. This must be a list of .bib files. The .bib |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
679 # extension is automatically appended if omitted. This requires the bibtex tool |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
680 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
681 # For LaTeX the style of the bibliography can be controlled using |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
683 # search path. Do not use file names with spaces, bibtex cannot handle them. See |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
684 # also \cite for info how to create references. |
| 660 | 685 |
| 686 CITE_BIB_FILES = | |
| 687 | |
| 0 | 688 #--------------------------------------------------------------------------- |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
689 # Configuration options related to warning and progress messages |
| 0 | 690 #--------------------------------------------------------------------------- |
| 691 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
692 # The QUIET tag can be used to turn on/off the messages that are generated to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
693 # standard output by doxygen. If QUIET is set to YES this implies that the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
694 # messages are off. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
695 # The default value is: NO. |
| 0 | 696 |
| 697 QUIET = NO | |
| 698 | |
| 699 # The WARNINGS tag can be used to turn on/off the warning messages that are | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
701 # this implies that the warnings are on. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
702 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
703 # Tip: Turn warnings on while writing the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
704 # The default value is: YES. |
| 0 | 705 |
| 706 WARNINGS = YES | |
| 707 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
710 # will automatically be disabled. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
711 # The default value is: YES. |
| 0 | 712 |
| 713 WARN_IF_UNDOCUMENTED = YES | |
| 714 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
716 # potential errors in the documentation, such as not documenting some parameters |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
717 # in a documented function, or documenting parameters that don't exist or using |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
718 # markup commands wrongly. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
719 # The default value is: YES. |
| 0 | 720 |
| 721 WARN_IF_DOC_ERROR = YES | |
| 722 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
724 # are documented, but have no documentation for their parameters or return |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
726 # documentation, but not about the absence of documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
727 # The default value is: NO. |
| 0 | 728 |
| 591 | 729 WARN_NO_PARAMDOC = YES |
| 0 | 730 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
732 # can produce. The string should contain the $file, $line, and $text tags, which |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
733 # will be replaced by the file and line number from which the warning originated |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
734 # and the warning text. Optionally the format may contain $version, which will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
735 # be replaced by the version of the file (if it could be obtained via |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
736 # FILE_VERSION_FILTER) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
737 # The default value is: $file:$line: $text. |
| 0 | 738 |
| 739 WARN_FORMAT = "$file:$line: $text" | |
| 740 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
742 # messages should be written. If left blank the output is written to standard |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
743 # error (stderr). |
| 0 | 744 |
| 745 WARN_LOGFILE = | |
| 746 | |
| 747 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
748 # Configuration options related to the input files |
| 0 | 749 #--------------------------------------------------------------------------- |
| 750 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
751 # The INPUT tag is used to specify the files and/or directories that contain |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
752 # documented source files. You may enter file names like myfile.cpp or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
753 # directories like /usr/src/myproject. Separate the files or directories with |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
754 # spaces. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
755 # Note: If this tag is empty the current directory is searched. |
| 0 | 756 |
|
4091
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4072
diff
changeset
|
757 INPUT = @CMAKE_SOURCE_DIR@/Plugins/Include/orthanc/OrthancCPlugin.h \ |
|
19a2f1d2b816
moved CMakeLists.txt for the server to the OrthancServer folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4072
diff
changeset
|
758 @CMAKE_SOURCE_DIR@/Plugins/Include/orthanc/OrthancCDatabasePlugin.h |
| 0 | 759 |
| 760 # This tag can be used to specify the character encoding of the source files | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
761 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
762 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
763 # documentation (see: http://www.gnu.org/software/libiconv) for the list of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
764 # possible encodings. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
765 # The default value is: UTF-8. |
| 0 | 766 |
| 767 INPUT_ENCODING = UTF-8 | |
| 768 | |
| 769 # If the value of the INPUT tag contains directories, you can use the | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
770 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
771 # *.h) to filter out the source-files in the directories. If left blank the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
772 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
773 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
774 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
775 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
776 # *.qsf, *.as and *.js. |
| 0 | 777 |
| 778 FILE_PATTERNS = *.h | |
| 779 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
780 # The RECURSIVE tag can be used to specify whether or not subdirectories should |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
781 # be searched for input files as well. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
782 # The default value is: NO. |
| 0 | 783 |
| 784 RECURSIVE = YES | |
| 785 | |
| 660 | 786 # The EXCLUDE tag can be used to specify files and/or directories that should be |
| 0 | 787 # excluded from the INPUT source files. This way you can easily exclude a |
| 788 # subdirectory from a directory tree whose root is specified with the INPUT tag. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
789 # |
| 660 | 790 # Note that relative paths are relative to the directory from which doxygen is |
| 791 # run. | |
| 0 | 792 |
| 793 EXCLUDE = | |
| 794 | |
| 660 | 795 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
| 0 | 796 # directories that are symbolic links (a Unix file system feature) are excluded |
| 797 # from the input. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
798 # The default value is: NO. |
| 0 | 799 |
| 800 EXCLUDE_SYMLINKS = NO | |
| 801 | |
| 802 # If the value of the INPUT tag contains directories, you can use the | |
| 803 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
804 # certain files from those directories. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
805 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
806 # Note that the wildcards are matched against the file with absolute path, so to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
807 # exclude all test directories for example use the pattern */test/* |
| 0 | 808 |
| 809 EXCLUDE_PATTERNS = | |
| 810 | |
| 811 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | |
| 812 # (namespaces, classes, functions, etc.) that should be excluded from the | |
| 813 # output. The symbol name can be a fully qualified name, a word, or if the | |
| 814 # wildcard * is used, a substring. Examples: ANamespace, AClass, | |
| 815 # AClass::ANamespace, ANamespace::*Test | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
816 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
817 # Note that the wildcards are matched against the file with absolute path, so to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
818 # exclude all test directories use the pattern */test/* |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
819 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
820 EXCLUDE_SYMBOLS = _OrthancPlugin* \ |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
821 OrthancPluginGetName |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
822 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
823 # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
824 # that contain example code fragments that are included (see the \include |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
825 # command). |
| 0 | 826 |
| 827 EXAMPLE_PATH = | |
| 828 | |
| 829 # If the value of the EXAMPLE_PATH tag contains directories, you can use the | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
830 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
831 # *.h) to filter out the source-files in the directories. If left blank all |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
832 # files are included. |
| 0 | 833 |
| 834 EXAMPLE_PATTERNS = | |
| 835 | |
| 836 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
837 # searched for input files to be used with the \include or \dontinclude commands |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
838 # irrespective of the value of the RECURSIVE tag. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
839 # The default value is: NO. |
| 0 | 840 |
| 841 EXAMPLE_RECURSIVE = NO | |
| 842 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
843 # The IMAGE_PATH tag can be used to specify one or more files or directories |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
844 # that contain images that are to be included in the documentation (see the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
845 # \image command). |
| 0 | 846 |
| 847 IMAGE_PATH = | |
| 848 | |
| 849 # The INPUT_FILTER tag can be used to specify a program that doxygen should | |
| 850 # invoke to filter for each input file. Doxygen will invoke the filter program | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
851 # by executing (via popen()) the command: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
852 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
853 # <filter> <input-file> |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
854 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
855 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
856 # name of an input file. Doxygen will then use the output that the filter |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
857 # program writes to standard output. If FILTER_PATTERNS is specified, this tag |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
858 # will be ignored. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
859 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
860 # Note that the filter must not add or remove lines; it is applied before the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
861 # code is scanned, but not when the output code is generated. If lines are added |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
862 # or removed, the anchors will not be placed correctly. |
| 0 | 863 |
| 864 INPUT_FILTER = | |
| 865 | |
| 866 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
867 # basis. Doxygen will compare the file name with each pattern and apply the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
868 # filter if there is a match. The filters are a list of the form: pattern=filter |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
869 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
870 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
871 # patterns match the file name, INPUT_FILTER is applied. |
| 0 | 872 |
| 873 FILTER_PATTERNS = | |
| 874 | |
| 875 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
876 # INPUT_FILTER ) will also be used to filter the input files that are used for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
877 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
878 # The default value is: NO. |
| 0 | 879 |
| 880 FILTER_SOURCE_FILES = NO | |
| 881 | |
| 882 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
883 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
884 # it is also possible to disable source filtering for a specific pattern using |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
885 # *.ext= (so without naming a filter). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
886 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
| 0 | 887 |
| 888 FILTER_SOURCE_PATTERNS = | |
| 889 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
890 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
891 # is part of the input, its contents will be placed on the main page |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
892 # (index.html). This can be useful if you have a project on for instance GitHub |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
893 # and want to reuse the introduction page also for the doxygen output. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
894 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
895 USE_MDFILE_AS_MAINPAGE = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
896 |
| 0 | 897 #--------------------------------------------------------------------------- |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
898 # Configuration options related to source browsing |
| 0 | 899 #--------------------------------------------------------------------------- |
| 900 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
901 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
902 # generated. Documented entities will be cross-referenced with these sources. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
903 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
904 # Note: To get rid of all source code in the generated output, make sure that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
905 # also VERBATIM_HEADERS is set to NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
906 # The default value is: NO. |
| 0 | 907 |
| 908 SOURCE_BROWSER = NO | |
| 909 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
910 # Setting the INLINE_SOURCES tag to YES will include the body of functions, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
911 # classes and enums directly into the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
912 # The default value is: NO. |
| 0 | 913 |
| 914 INLINE_SOURCES = NO | |
| 915 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
916 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
917 # special comment blocks from generated source code fragments. Normal C, C++ and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
918 # Fortran comments will always remain visible. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
919 # The default value is: YES. |
| 0 | 920 |
| 921 STRIP_CODE_COMMENTS = YES | |
| 922 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
923 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
924 # function all documented functions referencing it will be listed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
925 # The default value is: NO. |
| 0 | 926 |
| 927 REFERENCED_BY_RELATION = NO | |
| 928 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
929 # If the REFERENCES_RELATION tag is set to YES then for each documented function |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
930 # all documented entities called/used by that function will be listed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
931 # The default value is: NO. |
| 0 | 932 |
| 933 REFERENCES_RELATION = NO | |
| 934 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
935 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
936 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
937 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
938 # link to the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
939 # The default value is: YES. |
| 0 | 940 |
| 941 REFERENCES_LINK_SOURCE = YES | |
| 942 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
943 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
944 # source code will show a tooltip with additional information such as prototype, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
945 # brief description and links to the definition and documentation. Since this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
946 # will make the HTML file larger and loading of large files a bit slower, you |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
947 # can opt to disable this feature. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
948 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
949 # This tag requires that the tag SOURCE_BROWSER is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
950 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
951 SOURCE_TOOLTIPS = YES |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
952 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
953 # If the USE_HTAGS tag is set to YES then the references to source code will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
954 # point to the HTML generated by the htags(1) tool instead of doxygen built-in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
955 # source browser. The htags tool is part of GNU's global source tagging system |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
956 # (see http://www.gnu.org/software/global/global.html). You will need version |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
957 # 4.8.6 or higher. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
958 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
959 # To use it do the following: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
960 # - Install the latest version of global |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
961 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
962 # - Make sure the INPUT points to the root of the source tree |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
963 # - Run doxygen as normal |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
964 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
965 # Doxygen will invoke htags (and that will in turn invoke gtags), so these |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
966 # tools must be available from the command line (i.e. in the search path). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
967 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
968 # The result: instead of the source browser generated by doxygen, the links to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
969 # source code will now point to the output of htags. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
970 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
971 # This tag requires that the tag SOURCE_BROWSER is set to YES. |
| 0 | 972 |
| 973 USE_HTAGS = NO | |
| 974 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
975 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
976 # verbatim copy of the header file for each class for which an include is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
977 # specified. Set to NO to disable this. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
978 # See also: Section \class. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
979 # The default value is: YES. |
| 0 | 980 |
| 981 VERBATIM_HEADERS = YES | |
| 982 | |
| 983 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
984 # Configuration options related to the alphabetical class index |
| 0 | 985 #--------------------------------------------------------------------------- |
| 986 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
987 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
988 # compounds will be generated. Enable this if the project contains a lot of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
989 # classes, structs, unions or interfaces. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
990 # The default value is: YES. |
| 0 | 991 |
| 992 ALPHABETICAL_INDEX = YES | |
| 993 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
994 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
995 # which the alphabetical index list will be split. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
996 # Minimum value: 1, maximum value: 20, default value: 5. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
997 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| 0 | 998 |
| 999 COLS_IN_ALPHA_INDEX = 5 | |
| 1000 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1001 # In case all classes in a project start with a common prefix, all classes will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1002 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1003 # can be used to specify a prefix (or a list of prefixes) that should be ignored |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1004 # while generating the index headers. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1005 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| 0 | 1006 |
| 1007 IGNORE_PREFIX = | |
| 1008 | |
| 1009 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1010 # Configuration options related to the HTML output |
| 0 | 1011 #--------------------------------------------------------------------------- |
| 1012 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1013 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1014 # The default value is: YES. |
| 0 | 1015 |
| 1016 GENERATE_HTML = YES | |
| 1017 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1018 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1019 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1020 # it. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1021 # The default directory is: html. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1022 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1023 |
| 1024 HTML_OUTPUT = doc | |
| 1025 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1026 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1027 # generated HTML page (for example: .htm, .php, .asp). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1028 # The default value is: .html. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1029 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1030 |
| 1031 HTML_FILE_EXTENSION = .html | |
| 1032 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1033 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1034 # each generated HTML page. If the tag is left blank doxygen will generate a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1035 # standard header. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1036 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1037 # To get valid HTML the header file that includes any scripts and style sheets |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1038 # that doxygen needs, which is dependent on the configuration options used (e.g. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1039 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1040 # default header using |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1041 # doxygen -w html new_header.html new_footer.html new_stylesheet.css |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1042 # YourConfigFile |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1043 # and then modify the file new_header.html. See also section "Doxygen usage" |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1044 # for information on how to generate the default header that doxygen normally |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1045 # uses. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1046 # Note: The header is subject to change so you typically have to regenerate the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1047 # default header when upgrading to a newer version of doxygen. For a description |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1048 # of the possible markers and block names see the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1049 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1050 |
| 1051 HTML_HEADER = | |
| 1052 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1053 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1054 # generated HTML page. If the tag is left blank doxygen will generate a standard |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1055 # footer. See HTML_HEADER for more information on how to generate a default |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1056 # footer and what special commands can be used inside the footer. See also |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1057 # section "Doxygen usage" for information on how to generate the default footer |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1058 # that doxygen normally uses. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1059 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1060 |
| 1061 HTML_FOOTER = | |
| 1062 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1063 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1064 # sheet that is used by each HTML page. It can be used to fine-tune the look of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1065 # the HTML output. If left blank doxygen will generate a default style sheet. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1066 # See also section "Doxygen usage" for information on how to generate the style |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1067 # sheet that doxygen normally uses. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1068 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1069 # it is more robust and this tag (HTML_STYLESHEET) will in the future become |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1070 # obsolete. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1071 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1072 |
| 1073 HTML_STYLESHEET = | |
| 1074 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1075 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1076 # defined cascading style sheet that is included after the standard style sheets |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1077 # created by doxygen. Using this option one can overrule certain style aspects. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1078 # This is preferred over using HTML_STYLESHEET since it does not replace the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1079 # standard style sheet and is therefor more robust against future updates. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1080 # Doxygen will copy the style sheet file to the output directory. For an example |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1081 # see the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1082 # This tag requires that the tag GENERATE_HTML is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1083 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1084 HTML_EXTRA_STYLESHEET = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1085 |
| 0 | 1086 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
| 1087 # other source files which should be copied to the HTML output directory. Note | |
| 1088 # that these files will be copied to the base HTML output directory. Use the | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1089 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1090 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1091 # files will be copied as-is; there are no commands or markers available. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1092 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1093 |
| 1094 HTML_EXTRA_FILES = | |
| 1095 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1096 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1097 # will adjust the colors in the stylesheet and background images according to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1098 # this color. Hue is specified as an angle on a colorwheel, see |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1099 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1100 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1101 # purple, and 360 is red again. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1102 # Minimum value: 0, maximum value: 359, default value: 220. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1103 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1104 |
| 1105 HTML_COLORSTYLE_HUE = 220 | |
| 1106 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1107 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1108 # in the HTML output. For a value of 0 the output will use grayscales only. A |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1109 # value of 255 will produce the most vivid colors. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1110 # Minimum value: 0, maximum value: 255, default value: 100. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1111 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1112 |
| 1113 HTML_COLORSTYLE_SAT = 100 | |
| 1114 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1115 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1116 # luminance component of the colors in the HTML output. Values below 100 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1117 # gradually make the output lighter, whereas values above 100 make the output |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1118 # darker. The value divided by 100 is the actual gamma applied, so 80 represents |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1119 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1120 # change the gamma. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1121 # Minimum value: 40, maximum value: 240, default value: 80. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1122 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1123 |
| 1124 HTML_COLORSTYLE_GAMMA = 80 | |
| 1125 | |
| 1126 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1127 # page will contain the date and time when the page was generated. Setting this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1128 # to NO can help when comparing the output of multiple runs. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1129 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1130 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1131 |
|
1327
6ed49334d5c1
removal of timestamps in Doxgen documentation for build reproducibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1312
diff
changeset
|
1132 HTML_TIMESTAMP = NO |
| 0 | 1133 |
| 1134 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | |
| 1135 # documentation will contain sections that can be hidden and shown after the | |
| 660 | 1136 # page has loaded. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1137 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1138 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1139 |
| 1140 HTML_DYNAMIC_SECTIONS = NO | |
| 1141 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1142 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1143 # shown in the various tree structured indices initially; the user can expand |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1144 # and collapse entries dynamically later on. Doxygen will expand the tree to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1145 # such a level that at most the specified number of entries are visible (unless |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1146 # a fully collapsed tree already exceeds this amount). So setting the number of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1147 # entries 1 will produce a full collapsed tree by default. 0 is a special value |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1148 # representing an infinite number of entries and will result in a full expanded |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1149 # tree by default. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1150 # Minimum value: 0, maximum value: 9999, default value: 100. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1151 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 660 | 1152 |
| 1153 HTML_INDEX_NUM_ENTRIES = 100 | |
| 1154 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1155 # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1156 # generated that can be used as input for Apple's Xcode 3 integrated development |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1157 # environment (see: http://developer.apple.com/tools/xcode/), introduced with |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1158 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1159 # Makefile in the HTML output directory. Running make will produce the docset in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1160 # that directory and running make install will install the docset in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1161 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1162 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
| 0 | 1163 # for more information. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1164 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1165 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1166 |
| 1167 GENERATE_DOCSET = NO | |
| 1168 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1169 # This tag determines the name of the docset feed. A documentation feed provides |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1170 # an umbrella under which multiple documentation sets from a single provider |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1171 # (such as a company or product suite) can be grouped. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1172 # The default value is: Doxygen generated docs. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1173 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| 0 | 1174 |
| 1175 DOCSET_FEEDNAME = "Doxygen generated docs" | |
| 1176 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1177 # This tag specifies a string that should uniquely identify the documentation |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1178 # set bundle. This should be a reverse domain-name style string, e.g. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1179 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1180 # The default value is: org.doxygen.Project. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1181 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| 0 | 1182 |
| 1183 DOCSET_BUNDLE_ID = org.doxygen.Project | |
| 1184 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1185 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify |
| 0 | 1186 # the documentation publisher. This should be a reverse domain-name style |
| 1187 # string, e.g. com.mycompany.MyDocSet.documentation. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1188 # The default value is: org.doxygen.Publisher. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1189 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| 0 | 1190 |
| 1191 DOCSET_PUBLISHER_ID = org.doxygen.Publisher | |
| 1192 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1193 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1194 # The default value is: Publisher. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1195 # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| 0 | 1196 |
| 1197 DOCSET_PUBLISHER_NAME = Publisher | |
| 1198 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1199 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1200 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1201 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1202 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1203 # Windows. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1204 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1205 # The HTML Help Workshop contains a compiler that can convert all HTML output |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1206 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1207 # files are now used as the Windows 98 help format, and will replace the old |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1208 # Windows help format (.hlp) on all Windows platforms in the future. Compressed |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1209 # HTML files also contain an index, a table of contents, and you can search for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1210 # words in the documentation. The HTML workshop also contains a viewer for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1211 # compressed HTML files. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1212 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1213 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1214 |
| 1215 GENERATE_HTMLHELP = NO | |
| 1216 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1217 # The CHM_FILE tag can be used to specify the file name of the resulting .chm |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1218 # file. You can add a path in front of the file if the result should not be |
| 0 | 1219 # written to the html output directory. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1220 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 0 | 1221 |
| 1222 CHM_FILE = | |
| 1223 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1224 # The HHC_LOCATION tag can be used to specify the location (absolute path |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1225 # including file name) of the HTML help compiler ( hhc.exe). If non-empty |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1226 # doxygen will try to run the HTML help compiler on the generated index.hhp. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1227 # The file has to be specified with full path. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1228 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 0 | 1229 |
| 1230 HHC_LOCATION = | |
| 1231 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1232 # The GENERATE_CHI flag controls if a separate .chi index file is generated ( |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1233 # YES) or that it should be included in the master .chm file ( NO). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1234 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1235 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 0 | 1236 |
| 1237 GENERATE_CHI = NO | |
| 1238 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1239 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1240 # and project file content. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1241 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 0 | 1242 |
| 1243 CHM_INDEX_ENCODING = | |
| 1244 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1245 # The BINARY_TOC flag controls whether a binary table of contents is generated ( |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1246 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1247 # enables the Previous and Next buttons. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1248 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1249 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 0 | 1250 |
| 1251 BINARY_TOC = NO | |
| 1252 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1253 # The TOC_EXPAND flag can be set to YES to add extra items for group members to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1254 # the table of contents of the HTML help documentation and to the tree view. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1255 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1256 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 0 | 1257 |
| 1258 TOC_EXPAND = NO | |
| 1259 | |
| 1260 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1261 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1262 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1263 # (.qch) of the generated HTML documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1264 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1265 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1266 |
| 1267 GENERATE_QHP = NO | |
| 1268 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1269 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1270 # the file name of the resulting .qch file. The path specified is relative to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1271 # the HTML output folder. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1272 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1273 |
| 1274 QCH_FILE = | |
| 1275 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1276 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1277 # Project output. For more information please see Qt Help Project / Namespace |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1278 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1279 # The default value is: org.doxygen.Project. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1280 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1281 |
| 1282 QHP_NAMESPACE = org.doxygen.Project | |
| 1283 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1284 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1285 # Help Project output. For more information please see Qt Help Project / Virtual |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1286 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1287 # folders). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1288 # The default value is: doc. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1289 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1290 |
| 1291 QHP_VIRTUAL_FOLDER = doc | |
| 1292 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1293 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1294 # filter to add. For more information please see Qt Help Project / Custom |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1295 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1296 # filters). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1297 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1298 |
| 1299 QHP_CUST_FILTER_NAME = | |
| 1300 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1301 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1302 # custom filter to add. For more information please see Qt Help Project / Custom |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1303 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1304 # filters). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1305 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1306 |
| 1307 QHP_CUST_FILTER_ATTRS = | |
| 1308 | |
| 1309 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1310 # project's filter section matches. Qt Help Project / Filter Attributes (see: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1311 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1312 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1313 |
| 1314 QHP_SECT_FILTER_ATTRS = | |
| 1315 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1316 # The QHG_LOCATION tag can be used to specify the location of Qt's |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1317 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1318 # generated .qhp file. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1319 # This tag requires that the tag GENERATE_QHP is set to YES. |
| 0 | 1320 |
| 1321 QHG_LOCATION = | |
| 1322 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1323 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1324 # generated, together with the HTML files, they form an Eclipse help plugin. To |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1325 # install this plugin and make it available under the help contents menu in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1326 # Eclipse, the contents of the directory containing the HTML and XML files needs |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1327 # to be copied into the plugins directory of eclipse. The name of the directory |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1328 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1329 # After copying Eclipse needs to be restarted before the help appears. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1330 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1331 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1332 |
| 1333 GENERATE_ECLIPSEHELP = NO | |
| 1334 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1335 # A unique identifier for the Eclipse help plugin. When installing the plugin |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1336 # the directory name containing the HTML and XML files should also have this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1337 # name. Each documentation set should have its own identifier. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1338 # The default value is: org.doxygen.Project. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1339 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. |
| 0 | 1340 |
| 1341 ECLIPSE_DOC_ID = org.doxygen.Project | |
| 1342 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1343 # If you want full control over the layout of the generated HTML pages it might |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1344 # be necessary to disable the index and replace it with your own. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1345 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1346 # of each HTML page. A value of NO enables the index and the value YES disables |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1347 # it. Since the tabs in the index contain the same information as the navigation |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1348 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1349 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1350 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1351 |
| 1352 DISABLE_INDEX = NO | |
| 1353 | |
| 1354 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1355 # structure should be generated to display hierarchical information. If the tag |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1356 # value is set to YES, a side panel will be generated containing a tree-like |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1357 # index structure (just like the one that is generated for HTML Help). For this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1358 # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1359 # (i.e. any modern browser). Windows users are probably better off using the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1360 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1361 # further fine-tune the look of the index. As an example, the default style |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1362 # sheet generated by doxygen has an example that shows how to put an image at |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1363 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1364 # the same information as the tab index, you could consider setting |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1365 # DISABLE_INDEX to YES when enabling this option. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1366 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1367 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1368 |
| 1369 GENERATE_TREEVIEW = NO | |
| 1370 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1371 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1372 # doxygen will group on one line in the generated HTML documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1373 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1374 # Note that a value of 0 will completely suppress the enum values from appearing |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1375 # in the overview section. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1376 # Minimum value: 0, maximum value: 20, default value: 4. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1377 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1378 |
| 660 | 1379 ENUM_VALUES_PER_LINE = 1 |
| 0 | 1380 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1381 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1382 # to set the initial width (in pixels) of the frame in which the tree is shown. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1383 # Minimum value: 0, maximum value: 1500, default value: 250. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1384 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1385 |
| 1386 TREEVIEW_WIDTH = 250 | |
| 1387 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1388 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1389 # external symbols imported via tag files in a separate window. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1390 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1391 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1392 |
| 1393 EXT_LINKS_IN_WINDOW = NO | |
| 1394 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1395 # Use this tag to change the font size of LaTeX formulas included as images in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1396 # the HTML documentation. When you change the font size after a successful |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1397 # doxygen run you need to manually remove any form_*.png images from the HTML |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1398 # output directory to force them to be regenerated. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1399 # Minimum value: 8, maximum value: 50, default value: 10. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1400 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1401 |
| 1402 FORMULA_FONTSIZE = 10 | |
| 1403 | |
| 1404 # Use the FORMULA_TRANPARENT tag to determine whether or not the images | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1405 # generated for formulas are transparent PNGs. Transparent PNGs are not |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1406 # supported properly for IE 6.0, but are supported on all modern browsers. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1407 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1408 # Note that when changing this option you need to delete any form_*.png files in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1409 # the HTML output directory before the changes have effect. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1410 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1411 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1412 |
| 1413 FORMULA_TRANSPARENT = YES | |
| 1414 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1415 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1416 # http://www.mathjax.org) which uses client side Javascript for the rendering |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1417 # instead of using prerendered bitmaps. Use this if you do not have LaTeX |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1418 # installed or if you want to formulas look prettier in the HTML output. When |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1419 # enabled you may also need to install MathJax separately and configure the path |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1420 # to it using the MATHJAX_RELPATH option. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1421 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1422 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1423 |
| 1424 USE_MATHJAX = NO | |
| 1425 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1426 # When MathJax is enabled you can set the default output format to be used for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1427 # the MathJax output. See the MathJax site (see: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1428 # http://docs.mathjax.org/en/latest/output.html) for more details. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1429 # Possible values are: HTML-CSS (which is slower, but has the best |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1430 # compatibility), NativeMML (i.e. MathML) and SVG. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1431 # The default value is: HTML-CSS. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1432 # This tag requires that the tag USE_MATHJAX is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1433 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1434 MATHJAX_FORMAT = HTML-CSS |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1435 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1436 # When MathJax is enabled you need to specify the location relative to the HTML |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1437 # output directory using the MATHJAX_RELPATH option. The destination directory |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1438 # should contain the MathJax.js script. For instance, if the mathjax directory |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1439 # is located at the same level as the HTML output directory, then |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1440 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1441 # Content Delivery Network so you can quickly see the result without installing |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1442 # MathJax. However, it is strongly recommended to install a local copy of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1443 # MathJax from http://www.mathjax.org before deployment. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1444 # The default value is: http://cdn.mathjax.org/mathjax/latest. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1445 # This tag requires that the tag USE_MATHJAX is set to YES. |
| 0 | 1446 |
| 1447 MATHJAX_RELPATH = http://www.mathjax.org/mathjax | |
| 1448 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1449 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1450 # extension names that should be enabled during MathJax rendering. For example |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1451 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1452 # This tag requires that the tag USE_MATHJAX is set to YES. |
| 660 | 1453 |
| 1454 MATHJAX_EXTENSIONS = | |
| 1455 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1456 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1457 # of code that will be used on startup of the MathJax code. See the MathJax site |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1458 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1459 # example see the documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1460 # This tag requires that the tag USE_MATHJAX is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1461 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1462 MATHJAX_CODEFILE = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1463 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1464 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1465 # the HTML output. The underlying search engine uses javascript and DHTML and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1466 # should work on any modern browser. Note that when using HTML help |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1467 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1468 # there is already a search function so this one should typically be disabled. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1469 # For large projects the javascript based search engine can be slow, then |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1470 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1471 # search using the keyboard; to jump to the search box use <access key> + S |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1472 # (what the <access key> is depends on the OS and browser, but it is typically |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1473 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1474 # key> to jump into the search results window, the results can be navigated |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1475 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1476 # the search. The filter options can be selected when the cursor is inside the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1477 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1478 # to select a filter and <Enter> or <escape> to activate or cancel the filter |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1479 # option. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1480 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1481 # This tag requires that the tag GENERATE_HTML is set to YES. |
| 0 | 1482 |
|
673
ca528c365a39
turning off Doxygen search engine by default
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
1483 SEARCHENGINE = NO |
| 0 | 1484 |
| 1485 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1486 # implemented using a web server instead of a web client using Javascript. There |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1487 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1488 # setting. When disabled, doxygen will generate a PHP script for searching and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1489 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1490 # and searching needs to be provided by external tools. See the section |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1491 # "External Indexing and Searching" for details. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1492 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1493 # This tag requires that the tag SEARCHENGINE is set to YES. |
| 0 | 1494 |
| 1495 SERVER_BASED_SEARCH = NO | |
| 1496 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1497 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1498 # script for searching. Instead the search results are written to an XML file |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1499 # which needs to be processed by an external indexer. Doxygen will invoke an |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1500 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1501 # search results. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1502 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1503 # Doxygen ships with an example indexer ( doxyindexer) and search engine |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1504 # (doxysearch.cgi) which are based on the open source search engine library |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1505 # Xapian (see: http://xapian.org/). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1506 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1507 # See the section "External Indexing and Searching" for details. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1508 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1509 # This tag requires that the tag SEARCHENGINE is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1510 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1511 EXTERNAL_SEARCH = NO |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1512 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1513 # The SEARCHENGINE_URL should point to a search engine hosted by a web server |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1514 # which will return the search results when EXTERNAL_SEARCH is enabled. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1515 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1516 # Doxygen ships with an example indexer ( doxyindexer) and search engine |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1517 # (doxysearch.cgi) which are based on the open source search engine library |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1518 # Xapian (see: http://xapian.org/). See the section "External Indexing and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1519 # Searching" for details. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1520 # This tag requires that the tag SEARCHENGINE is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1521 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1522 SEARCHENGINE_URL = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1523 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1524 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1525 # search data is written to a file for indexing by an external tool. With the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1526 # SEARCHDATA_FILE tag the name of this file can be specified. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1527 # The default file is: searchdata.xml. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1528 # This tag requires that the tag SEARCHENGINE is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1529 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1530 SEARCHDATA_FILE = searchdata.xml |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1531 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1532 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1533 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1534 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1535 # projects and redirect the results back to the right project. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1536 # This tag requires that the tag SEARCHENGINE is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1537 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1538 EXTERNAL_SEARCH_ID = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1539 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1540 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1541 # projects other than the one defined by this configuration file, but that are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1542 # all added to the same external search index. Each project needs to have a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1543 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1544 # to a relative location where the documentation can be found. The format is: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1545 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1546 # This tag requires that the tag SEARCHENGINE is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1547 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1548 EXTRA_SEARCH_MAPPINGS = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1549 |
| 0 | 1550 #--------------------------------------------------------------------------- |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1551 # Configuration options related to the LaTeX output |
| 0 | 1552 #--------------------------------------------------------------------------- |
| 1553 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1554 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1555 # The default value is: YES. |
| 0 | 1556 |
| 1557 GENERATE_LATEX = NO | |
| 1558 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1559 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1560 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1561 # it. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1562 # The default directory is: latex. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1563 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1564 |
| 1565 LATEX_OUTPUT = latex | |
| 1566 | |
| 1567 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1568 # invoked. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1569 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1570 # Note that when enabling USE_PDFLATEX this option is only used for generating |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1571 # bitmaps for formulas in the HTML output, but not in the Makefile that is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1572 # written to the output directory. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1573 # The default file is: latex. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1574 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1575 |
| 1576 LATEX_CMD_NAME = latex | |
| 1577 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1578 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1579 # index for LaTeX. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1580 # The default file is: makeindex. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1581 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1582 |
| 1583 MAKEINDEX_CMD_NAME = makeindex | |
| 1584 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1585 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1586 # documents. This may be useful for small projects and may help to save some |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1587 # trees in general. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1588 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1589 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1590 |
| 1591 COMPACT_LATEX = NO | |
| 1592 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1593 # The PAPER_TYPE tag can be used to set the paper type that is used by the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1594 # printer. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1595 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1596 # 14 inches) and executive (7.25 x 10.5 inches). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1597 # The default value is: a4. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1598 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1599 |
| 1600 PAPER_TYPE = a4 | |
| 1601 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1602 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1603 # that should be included in the LaTeX output. To get the times font for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1604 # instance you can specify |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1605 # EXTRA_PACKAGES=times |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1606 # If left blank no extra packages will be included. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1607 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1608 |
| 1609 EXTRA_PACKAGES = | |
| 1610 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1611 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1612 # generated LaTeX document. The header should contain everything until the first |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1613 # chapter. If it is left blank doxygen will generate a standard header. See |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1614 # section "Doxygen usage" for information on how to let doxygen write the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1615 # default header to a separate file. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1616 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1617 # Note: Only use a user-defined header if you know what you are doing! The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1618 # following commands have a special meaning inside the header: $title, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1619 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1620 # replace them by respectively the title of the page, the current date and time, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1621 # only the current date, the version number of doxygen, the project name (see |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1622 # PROJECT_NAME), or the project number (see PROJECT_NUMBER). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1623 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1624 |
| 1625 LATEX_HEADER = | |
| 1626 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1627 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1628 # generated LaTeX document. The footer should contain everything after the last |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1629 # chapter. If it is left blank doxygen will generate a standard footer. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1630 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1631 # Note: Only use a user-defined footer if you know what you are doing! |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1632 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1633 |
| 1634 LATEX_FOOTER = | |
| 1635 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1636 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1637 # other source files which should be copied to the LATEX_OUTPUT output |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1638 # directory. Note that the files will be copied as-is; there are no commands or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1639 # markers available. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1640 # This tag requires that the tag GENERATE_LATEX is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1641 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1642 LATEX_EXTRA_FILES = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1643 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1644 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1645 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1646 # contain links (just like the HTML output) instead of page references. This |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1647 # makes the output suitable for online browsing using a PDF viewer. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1648 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1649 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1650 |
| 1651 PDF_HYPERLINKS = YES | |
| 1652 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1653 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1654 # the PDF file directly from the LaTeX files. Set this option to YES to get a |
| 0 | 1655 # higher quality PDF documentation. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1656 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1657 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1658 |
| 1659 USE_PDFLATEX = YES | |
| 1660 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1661 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1662 # command to the generated LaTeX files. This will instruct LaTeX to keep running |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1663 # if errors occur, instead of asking the user for help. This option is also used |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1664 # when generating formulas in HTML. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1665 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1666 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1667 |
| 1668 LATEX_BATCHMODE = NO | |
| 1669 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1670 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1671 # index chapters (such as File Index, Compound Index, etc.) in the output. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1672 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1673 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1674 |
| 1675 LATEX_HIDE_INDICES = NO | |
| 1676 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1677 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1678 # code with syntax highlighting in the LaTeX output. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1679 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1680 # Note that which sources are shown also depends on other settings such as |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1681 # SOURCE_BROWSER. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1682 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1683 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 0 | 1684 |
| 1685 LATEX_SOURCE_CODE = NO | |
| 1686 | |
| 660 | 1687 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1688 # bibliography, e.g. plainnat, or ieeetr. See |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1689 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1690 # The default value is: plain. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1691 # This tag requires that the tag GENERATE_LATEX is set to YES. |
| 660 | 1692 |
| 1693 LATEX_BIB_STYLE = plain | |
| 1694 | |
| 0 | 1695 #--------------------------------------------------------------------------- |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1696 # Configuration options related to the RTF output |
| 0 | 1697 #--------------------------------------------------------------------------- |
| 1698 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1699 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1700 # RTF output is optimized for Word 97 and may not look too pretty with other RTF |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1701 # readers/editors. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1702 # The default value is: NO. |
| 0 | 1703 |
| 1704 GENERATE_RTF = NO | |
| 1705 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1706 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1707 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1708 # it. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1709 # The default directory is: rtf. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1710 # This tag requires that the tag GENERATE_RTF is set to YES. |
| 0 | 1711 |
| 1712 RTF_OUTPUT = rtf | |
| 1713 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1714 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1715 # documents. This may be useful for small projects and may help to save some |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1716 # trees in general. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1717 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1718 # This tag requires that the tag GENERATE_RTF is set to YES. |
| 0 | 1719 |
| 1720 COMPACT_RTF = NO | |
| 1721 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1722 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1723 # contain hyperlink fields. The RTF file will contain links (just like the HTML |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1724 # output) instead of page references. This makes the output suitable for online |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1725 # browsing using Word or some other Word compatible readers that support those |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1726 # fields. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1727 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1728 # Note: WordPad (write) and others do not support links. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1729 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1730 # This tag requires that the tag GENERATE_RTF is set to YES. |
| 0 | 1731 |
| 1732 RTF_HYPERLINKS = NO | |
| 1733 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1734 # Load stylesheet definitions from file. Syntax is similar to doxygen's config |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1735 # file, i.e. a series of assignments. You only have to provide replacements, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1736 # missing definitions are set to their default value. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1737 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1738 # See also section "Doxygen usage" for information on how to generate the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1739 # default style sheet that doxygen normally uses. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1740 # This tag requires that the tag GENERATE_RTF is set to YES. |
| 0 | 1741 |
| 1742 RTF_STYLESHEET_FILE = | |
| 1743 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1744 # Set optional variables used in the generation of an RTF document. Syntax is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1745 # similar to doxygen's config file. A template extensions file can be generated |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1746 # using doxygen -e rtf extensionFile. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1747 # This tag requires that the tag GENERATE_RTF is set to YES. |
| 0 | 1748 |
| 1749 RTF_EXTENSIONS_FILE = | |
| 1750 | |
| 1751 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1752 # Configuration options related to the man page output |
| 0 | 1753 #--------------------------------------------------------------------------- |
| 1754 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1755 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1756 # classes and files. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1757 # The default value is: NO. |
| 0 | 1758 |
| 1759 GENERATE_MAN = NO | |
| 1760 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1761 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1762 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1763 # it. A directory man3 will be created inside the directory specified by |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1764 # MAN_OUTPUT. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1765 # The default directory is: man. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1766 # This tag requires that the tag GENERATE_MAN is set to YES. |
| 0 | 1767 |
| 1768 MAN_OUTPUT = man | |
| 1769 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1770 # The MAN_EXTENSION tag determines the extension that is added to the generated |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1771 # man pages. In case the manual section does not start with a number, the number |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1772 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1773 # optional. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1774 # The default value is: .3. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1775 # This tag requires that the tag GENERATE_MAN is set to YES. |
| 0 | 1776 |
| 1777 MAN_EXTENSION = .3 | |
| 1778 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1779 # The MAN_SUBDIR tag determines the name of the directory created within |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1780 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1781 # MAN_EXTENSION with the initial . removed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1782 # This tag requires that the tag GENERATE_MAN is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1783 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1784 MAN_SUBDIR = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1785 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1786 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1787 # will generate one additional man file for each entity documented in the real |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1788 # man page(s). These additional files only source the real man page, but without |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1789 # them the man command would be unable to find the correct page. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1790 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1791 # This tag requires that the tag GENERATE_MAN is set to YES. |
| 0 | 1792 |
| 1793 MAN_LINKS = NO | |
| 1794 | |
| 1795 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1796 # Configuration options related to the XML output |
| 0 | 1797 #--------------------------------------------------------------------------- |
| 1798 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1799 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1800 # captures the structure of the code including all documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1801 # The default value is: NO. |
| 0 | 1802 |
| 1803 GENERATE_XML = NO | |
| 1804 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1805 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1806 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1807 # it. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1808 # The default directory is: xml. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1809 # This tag requires that the tag GENERATE_XML is set to YES. |
| 0 | 1810 |
| 1811 XML_OUTPUT = xml | |
| 1812 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1813 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1814 # listings (including syntax highlighting and cross-referencing information) to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1815 # the XML output. Note that enabling this will significantly increase the size |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1816 # of the XML output. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1817 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1818 # This tag requires that the tag GENERATE_XML is set to YES. |
| 0 | 1819 |
| 1820 XML_PROGRAMLISTING = YES | |
| 1821 | |
| 1822 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1823 # Configuration options related to the DOCBOOK output |
| 0 | 1824 #--------------------------------------------------------------------------- |
| 1825 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1826 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1827 # that can be used to generate PDF. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1828 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1829 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1830 GENERATE_DOCBOOK = NO |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1831 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1832 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1833 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1834 # front of it. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1835 # The default directory is: docbook. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1836 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1837 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1838 DOCBOOK_OUTPUT = docbook |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1839 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1840 #--------------------------------------------------------------------------- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1841 # Configuration options for the AutoGen Definitions output |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1842 #--------------------------------------------------------------------------- |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1843 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1844 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1845 # Definitions (see http://autogen.sf.net) file that captures the structure of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1846 # the code including all documentation. Note that this feature is still |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1847 # experimental and incomplete at the moment. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1848 # The default value is: NO. |
| 0 | 1849 |
| 1850 GENERATE_AUTOGEN_DEF = NO | |
| 1851 | |
| 1852 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1853 # Configuration options related to the Perl module output |
| 0 | 1854 #--------------------------------------------------------------------------- |
| 1855 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1856 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1857 # file that captures the structure of the code including all documentation. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1858 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1859 # Note that this feature is still experimental and incomplete at the moment. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1860 # The default value is: NO. |
| 0 | 1861 |
| 1862 GENERATE_PERLMOD = NO | |
| 1863 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1864 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1865 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1866 # output from the Perl module output. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1867 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1868 # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| 0 | 1869 |
| 1870 PERLMOD_LATEX = NO | |
| 1871 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1872 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1873 # formatted so it can be parsed by a human reader. This is useful if you want to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1874 # understand what is going on. On the other hand, if this tag is set to NO the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1875 # size of the Perl module output will be much smaller and Perl will parse it |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1876 # just the same. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1877 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1878 # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| 0 | 1879 |
| 1880 PERLMOD_PRETTY = YES | |
| 1881 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1882 # The names of the make variables in the generated doxyrules.make file are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1883 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1884 # so different doxyrules.make files included by the same Makefile don't |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1885 # overwrite each other's variables. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1886 # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| 0 | 1887 |
| 1888 PERLMOD_MAKEVAR_PREFIX = | |
| 1889 | |
| 1890 #--------------------------------------------------------------------------- | |
| 1891 # Configuration options related to the preprocessor | |
| 1892 #--------------------------------------------------------------------------- | |
| 1893 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1894 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1895 # C-preprocessor directives found in the sources and include files. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1896 # The default value is: YES. |
| 0 | 1897 |
| 1898 ENABLE_PREPROCESSING = YES | |
| 1899 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1900 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1901 # in the source code. If set to NO only conditional compilation will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1902 # performed. Macro expansion can be done in a controlled way by setting |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1903 # EXPAND_ONLY_PREDEF to YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1904 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1905 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1906 |
| 907 | 1907 MACRO_EXPANSION = YES |
| 0 | 1908 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1909 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1910 # the macro expansion is limited to the macros specified with the PREDEFINED and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1911 # EXPAND_AS_DEFINED tags. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1912 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1913 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1914 |
| 907 | 1915 EXPAND_ONLY_PREDEF = YES |
| 0 | 1916 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1917 # If the SEARCH_INCLUDES tag is set to YES the includes files in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1918 # INCLUDE_PATH will be searched if a #include is found. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1919 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1920 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1921 |
| 1922 SEARCH_INCLUDES = YES | |
| 1923 | |
| 1924 # The INCLUDE_PATH tag can be used to specify one or more directories that | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1925 # contain include files that are not input files but should be processed by the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1926 # preprocessor. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1927 # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
| 0 | 1928 |
| 1929 INCLUDE_PATH = | |
| 1930 | |
| 1931 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | |
| 1932 # patterns (like *.h and *.hpp) to filter out the header-files in the | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1933 # directories. If left blank, the patterns specified with FILE_PATTERNS will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1934 # used. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1935 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1936 |
| 1937 INCLUDE_FILE_PATTERNS = | |
| 1938 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1939 # The PREDEFINED tag can be used to specify one or more macro names that are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1940 # defined before the preprocessor is started (similar to the -D option of e.g. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1941 # gcc). The argument of the tag is a list of macros of the form: name or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1942 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1943 # is assumed. To prevent a macro definition from being undefined via #undef or |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1944 # recursively expanded use the := operator instead of the = operator. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1945 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1946 |
| 907 | 1947 PREDEFINED = ORTHANC_PLUGIN_INLINE= |
| 0 | 1948 |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1949 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1950 # tag can be used to specify a list of macro names that should be expanded. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1951 # macro definition that is found in the sources will be used. Use the PREDEFINED |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1952 # tag if you want to use a different macro definition that overrules the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1953 # definition found in the source code. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1954 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1955 |
| 1956 EXPAND_AS_DEFINED = | |
| 1957 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1958 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1959 # remove all references to function-like macros that are alone on a line, have |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1960 # an all uppercase name, and do not end with a semicolon. Such function macros |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1961 # are typically used for boiler-plate code, and will confuse the parser if not |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1962 # removed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1963 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1964 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 0 | 1965 |
| 1966 SKIP_FUNCTION_MACROS = YES | |
| 1967 | |
| 1968 #--------------------------------------------------------------------------- | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1969 # Configuration options related to external references |
| 0 | 1970 #--------------------------------------------------------------------------- |
| 1971 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1972 # The TAGFILES tag can be used to specify one or more tag files. For each tag |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1973 # file the location of the external documentation should be added. The format of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1974 # a tag file without this location is as follows: |
| 0 | 1975 # TAGFILES = file1 file2 ... |
| 1976 # Adding location for the tag files is done as follows: | |
| 1977 # TAGFILES = file1=loc1 "file2 = loc2" ... | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1978 # where loc1 and loc2 can be relative or absolute paths or URLs. See the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1979 # section "Linking to external documentation" for more information about the use |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1980 # of tag files. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1981 # Note: Each tag file must have a unique name (where the name does NOT include |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1982 # the path). If a tag file is not located in the directory in which doxygen is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1983 # run, you must also specify the path to the tagfile here. |
| 0 | 1984 |
| 1985 TAGFILES = | |
| 1986 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1987 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1988 # tag file that is based on the input files it reads. See section "Linking to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1989 # external documentation" for more information about the usage of tag files. |
| 0 | 1990 |
| 1991 GENERATE_TAGFILE = | |
| 1992 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1993 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1994 # class index. If set to NO only the inherited external classes will be listed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1995 # The default value is: NO. |
| 0 | 1996 |
| 1997 ALLEXTERNALS = NO | |
| 1998 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
1999 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2000 # the modules index. If set to NO, only the current project's groups will be |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2001 # listed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2002 # The default value is: YES. |
| 0 | 2003 |
| 2004 EXTERNAL_GROUPS = YES | |
| 2005 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2006 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2007 # the related pages index. If set to NO, only the current project's pages will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2008 # be listed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2009 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2010 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2011 EXTERNAL_PAGES = YES |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2012 |
| 0 | 2013 # The PERL_PATH should be the absolute path and name of the perl script |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2014 # interpreter (i.e. the result of 'which perl'). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2015 # The default file (with absolute path) is: /usr/bin/perl. |
| 0 | 2016 |
| 2017 PERL_PATH = /usr/bin/perl | |
| 2018 | |
| 2019 #--------------------------------------------------------------------------- | |
| 2020 # Configuration options related to the dot tool | |
| 2021 #--------------------------------------------------------------------------- | |
| 2022 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2023 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2024 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2025 # NO turns the diagrams off. Note that this option also works with HAVE_DOT |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2026 # disabled, but it is recommended to install and use dot, since it yields more |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2027 # powerful graphs. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2028 # The default value is: YES. |
| 0 | 2029 |
| 2030 CLASS_DIAGRAMS = YES | |
| 2031 | |
| 2032 # You can define message sequence charts within doxygen comments using the \msc | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2033 # command. Doxygen will then run the mscgen tool (see: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2034 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
| 0 | 2035 # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
| 2036 # the mscgen tool resides. If left empty the tool is assumed to be found in the | |
| 2037 # default search path. | |
| 2038 | |
| 2039 MSCGEN_PATH = | |
| 2040 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2041 # You can include diagrams made with dia in doxygen documentation. Doxygen will |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2042 # then run dia to produce the diagram and insert it in the documentation. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2043 # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2044 # If left empty dia is assumed to be found in the default search path. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2045 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2046 DIA_PATH = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2047 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2048 # If set to YES, the inheritance and collaboration graphs will hide inheritance |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2049 # and usage relations if the target is undocumented or is not a class. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2050 # The default value is: YES. |
| 0 | 2051 |
| 2052 HIDE_UNDOC_RELATIONS = YES | |
| 2053 | |
| 2054 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2055 # available from the path. This tool is part of Graphviz (see: |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2056 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2057 # Bell Labs. The other options in this section have no effect if this option is |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2058 # set to NO |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2059 # The default value is: YES. |
| 0 | 2060 |
| 2061 HAVE_DOT = NO | |
| 2062 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2063 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2064 # to run in parallel. When set to 0 doxygen will base this on the number of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2065 # processors available in the system. You can set it explicitly to a value |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2066 # larger than 0 to get control over the balance between CPU load and processing |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2067 # speed. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2068 # Minimum value: 0, maximum value: 32, default value: 0. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2069 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2070 |
| 2071 DOT_NUM_THREADS = 0 | |
| 2072 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2073 # When you want a differently looking font n the dot files that doxygen |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2074 # generates you can specify the font name using DOT_FONTNAME. You need to make |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2075 # sure dot is able to find the font, which can be done by putting it in a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2076 # standard location or by setting the DOTFONTPATH environment variable or by |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2077 # setting DOT_FONTPATH to the directory containing the font. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2078 # The default value is: Helvetica. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2079 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2080 |
| 2081 DOT_FONTNAME = Helvetica | |
| 2082 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2083 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2084 # dot graphs. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2085 # Minimum value: 4, maximum value: 24, default value: 10. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2086 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2087 |
| 2088 DOT_FONTSIZE = 10 | |
| 2089 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2090 # By default doxygen will tell dot to use the default font as specified with |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2091 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2092 # the path where dot can find it using this tag. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2093 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2094 |
| 2095 DOT_FONTPATH = | |
| 2096 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2097 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2098 # each documented class showing the direct and indirect inheritance relations. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2099 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2100 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2101 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2102 |
| 2103 CLASS_GRAPH = YES | |
| 2104 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2105 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2106 # graph for each documented class showing the direct and indirect implementation |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2107 # dependencies (inheritance, containment, and class references variables) of the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2108 # class with other documented classes. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2109 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2110 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2111 |
| 2112 COLLABORATION_GRAPH = YES | |
| 2113 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2114 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2115 # groups, showing the direct groups dependencies. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2116 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2117 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2118 |
| 2119 GROUP_GRAPHS = YES | |
| 2120 | |
| 2121 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | |
| 2122 # collaboration diagrams in a style similar to the OMG's Unified Modeling | |
| 2123 # Language. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2124 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2125 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2126 |
| 2127 UML_LOOK = NO | |
| 2128 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2129 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2130 # class node. If there are many fields or methods and many nodes the graph may |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2131 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2132 # number of items for each type to make the size more manageable. Set this to 0 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2133 # for no limit. Note that the threshold may be exceeded by 50% before the limit |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2134 # is enforced. So when you set the threshold to 10, up to 15 fields may appear, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2135 # but if the number exceeds 15, the total amount of fields shown is limited to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2136 # 10. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2137 # Minimum value: 0, maximum value: 100, default value: 10. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2138 # This tag requires that the tag HAVE_DOT is set to YES. |
| 660 | 2139 |
| 2140 UML_LIMIT_NUM_FIELDS = 10 | |
| 2141 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2142 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2143 # collaboration graphs will show the relations between templates and their |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2144 # instances. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2145 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2146 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2147 |
| 2148 TEMPLATE_RELATIONS = NO | |
| 2149 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2150 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2151 # YES then doxygen will generate a graph for each documented file showing the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2152 # direct and indirect include dependencies of the file with other documented |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2153 # files. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2154 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2155 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2156 |
| 2157 INCLUDE_GRAPH = YES | |
| 2158 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2159 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2160 # set to YES then doxygen will generate a graph for each documented file showing |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2161 # the direct and indirect include dependencies of the file with other documented |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2162 # files. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2163 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2164 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2165 |
| 2166 INCLUDED_BY_GRAPH = YES | |
| 2167 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2168 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2169 # dependency graph for every global function or class method. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2170 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2171 # Note that enabling this option will significantly increase the time of a run. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2172 # So in most cases it will be better to enable call graphs for selected |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2173 # functions only using the \callgraph command. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2174 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2175 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2176 |
| 2177 CALL_GRAPH = NO | |
| 2178 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2179 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2180 # dependency graph for every global function or class method. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2181 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2182 # Note that enabling this option will significantly increase the time of a run. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2183 # So in most cases it will be better to enable caller graphs for selected |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2184 # functions only using the \callergraph command. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2185 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2186 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2187 |
| 2188 CALLER_GRAPH = NO | |
| 2189 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2190 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2191 # hierarchy of all classes instead of a textual one. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2192 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2193 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2194 |
| 2195 GRAPHICAL_HIERARCHY = YES | |
| 2196 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2197 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2198 # dependencies a directory has on other directories in a graphical way. The |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2199 # dependency relations are determined by the #include relations between the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2200 # files in the directories. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2201 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2202 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2203 |
| 2204 DIRECTORY_GRAPH = YES | |
| 2205 | |
| 2206 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2207 # generated by dot. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2208 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2209 # to make the SVG files visible in IE 9+ (other browsers do not have this |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2210 # requirement). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2211 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2212 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2213 # gif:cairo:gd, gif:gd, gif:gd:gd and svg. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2214 # The default value is: png. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2215 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2216 |
| 2217 DOT_IMAGE_FORMAT = png | |
| 2218 | |
| 660 | 2219 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
| 2220 # enable generation of interactive SVG images that allow zooming and panning. | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2221 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2222 # Note that this requires a modern browser other than Internet Explorer. Tested |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2223 # and working are Firefox, Chrome, Safari, and Opera. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2224 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2225 # the SVG files visible. Older versions of IE do not have SVG support. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2226 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2227 # This tag requires that the tag HAVE_DOT is set to YES. |
| 660 | 2228 |
| 2229 INTERACTIVE_SVG = NO | |
| 2230 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2231 # The DOT_PATH tag can be used to specify the path where the dot tool can be |
| 0 | 2232 # found. If left blank, it is assumed the dot tool can be found in the path. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2233 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2234 |
| 2235 DOT_PATH = | |
| 2236 | |
| 2237 # The DOTFILE_DIRS tag can be used to specify one or more directories that | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2238 # contain dot files that are included in the documentation (see the \dotfile |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2239 # command). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2240 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2241 |
| 2242 DOTFILE_DIRS = | |
| 2243 | |
| 2244 # The MSCFILE_DIRS tag can be used to specify one or more directories that | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2245 # contain msc files that are included in the documentation (see the \mscfile |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2246 # command). |
| 0 | 2247 |
| 2248 MSCFILE_DIRS = | |
| 2249 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2250 # The DIAFILE_DIRS tag can be used to specify one or more directories that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2251 # contain dia files that are included in the documentation (see the \diafile |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2252 # command). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2253 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2254 DIAFILE_DIRS = |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2255 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2256 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2257 # that will be shown in the graph. If the number of nodes in a graph becomes |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2258 # larger than this value, doxygen will truncate the graph, which is visualized |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2259 # by representing a node as a red box. Note that doxygen if the number of direct |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2260 # children of the root node in a graph is already larger than |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2261 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2262 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2263 # Minimum value: 0, maximum value: 10000, default value: 50. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2264 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2265 |
| 2266 DOT_GRAPH_MAX_NODES = 50 | |
| 2267 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2268 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2269 # generated by dot. A depth value of 3 means that only nodes reachable from the |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2270 # root by following a path via at most 3 edges will be shown. Nodes that lay |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2271 # further from the root node will be omitted. Note that setting this option to 1 |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2272 # or 2 may greatly reduce the computation time needed for large code bases. Also |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2273 # note that the size of a graph can be further restricted by |
| 0 | 2274 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2275 # Minimum value: 0, maximum value: 1000, default value: 0. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2276 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2277 |
| 2278 MAX_DOT_GRAPH_DEPTH = 0 | |
| 2279 | |
| 2280 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2281 # background. This is disabled by default, because dot on Windows does not seem |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2282 # to support this out of the box. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2283 # |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2284 # Warning: Depending on the platform used, enabling this option may lead to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2285 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2286 # read). |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2287 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2288 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2289 |
| 2290 DOT_TRANSPARENT = NO | |
| 2291 | |
| 2292 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | |
| 2293 # files in one run (i.e. multiple -o and -T options on the command line). This | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2294 # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2295 # this, this feature is disabled by default. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2296 # The default value is: NO. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2297 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2298 |
| 2299 DOT_MULTI_TARGETS = YES | |
| 2300 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2301 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2302 # explaining the meaning of the various boxes and arrows in the dot generated |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2303 # graphs. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2304 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2305 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2306 |
| 2307 GENERATE_LEGEND = YES | |
| 2308 | |
|
2224
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2309 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2310 # files that are used to generate the various graphs. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2311 # The default value is: YES. |
|
87c71bfb4e8a
upgrade doxygen configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2155
diff
changeset
|
2312 # This tag requires that the tag HAVE_DOT is set to YES. |
| 0 | 2313 |
| 2314 DOT_CLEANUP = YES |