diff options
author | Guillaume Friloux <guillaume.friloux@gmail.com> | 2013-12-13 10:29:10 +0100 |
---|---|---|
committer | Guillaume Friloux <guillaume.friloux@gmail.com> | 2013-12-13 10:29:10 +0100 |
commit | 99db593250aa02e957135966f501c8a49d33513f (patch) | |
tree | ff0ad5c83761b4da39d53cb1f6266482b7867686 | |
parent | b248399f418dcec1316ecb9b03e8fd9a4664df86 (diff) |
Remove useless links and change doxyfile
-rw-r--r-- | doc/Doxyfile | 1848 | ||||
-rw-r--r-- | doc/doxygen/data/head.html | 2 |
2 files changed, 988 insertions, 862 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index ed04dea..13aed12 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile | |||
@@ -1,925 +1,1015 @@ | |||
1 | # Doxyfile 1.7.2 | 1 | # Doxyfile 1.8.2 |
2 | 2 | ||
3 | # This file describes the settings to be used by the documentation system | 3 | # This file describes the settings to be used by the documentation system |
4 | # doxygen (www.doxygen.org) for a project | 4 | # doxygen (www.doxygen.org) for a project. |
5 | # | 5 | # |
6 | # All text after a hash (#) is considered a comment and will be ignored | 6 | # All text after a hash (#) is considered a comment and will be ignored. |
7 | # The format is: | 7 | # The format is: |
8 | # TAG = value [value, ...] | 8 | # TAG = value [value, ...] |
9 | # For lists items can also be appended using: | 9 | # For lists items can also be appended using: |
10 | # TAG += value [value, ...] | 10 | # TAG += value [value, ...] |
11 | # Values that contain spaces should be placed between quotes (" ") | 11 | # Values that contain spaces should be placed between quotes (" "). |
12 | 12 | ||
13 | #--------------------------------------------------------------------------- | 13 | #--------------------------------------------------------------------------- |
14 | # Project related configuration options | 14 | # Project related configuration options |
15 | #--------------------------------------------------------------------------- | 15 | #--------------------------------------------------------------------------- |
16 | 16 | ||
17 | # This tag specifies the encoding used for all characters in the config file | 17 | # This tag specifies the encoding used for all characters in the config file |
18 | # that follow. The default is UTF-8 which is also the encoding used for all | 18 | # that follow. The default is UTF-8 which is also the encoding used for all |
19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the | 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the |
20 | # iconv built into libc) for the transcoding. See | 20 | # iconv built into libc) for the transcoding. See |
21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. | 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. |
22 | 22 | ||
23 | DOXYFILE_ENCODING = UTF-8 | 23 | DOXYFILE_ENCODING = UTF-8 |
24 | 24 | ||
25 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded | 25 | # The PROJECT_NAME tag is a single word (or sequence of words) that should |
26 | # by quotes) that should identify the project. | 26 | # identify the project. Note that if you do not use Doxywizard you need |
27 | # to put quotes around the project name if it contains spaces. | ||
27 | 28 | ||
28 | PROJECT_NAME = SMMan | 29 | PROJECT_NAME = "Syslog Message MANager" |
29 | 30 | ||
30 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. | 31 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
31 | # This could be handy for archiving the generated documentation or | 32 | # This could be handy for archiving the generated documentation or |
32 | # if some version control system is used. | 33 | # if some version control system is used. |
33 | 34 | ||
34 | PROJECT_NUMBER = | 35 | PROJECT_NUMBER = |
35 | 36 | ||
36 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | 37 | # Using the PROJECT_BRIEF tag one can provide an optional one line description |
37 | # base path where the generated documentation will be put. | 38 | # for a project that appears at the top of each page and should give viewer |
38 | # If a relative path is entered, it will be relative to the location | 39 | # a quick idea about the purpose of the project. Keep the description short. |
40 | |||
41 | PROJECT_BRIEF = | ||
42 | |||
43 | # With the PROJECT_LOGO tag one can specify an logo or icon that is | ||
44 | # included in the documentation. The maximum height of the logo should not | ||
45 | # exceed 55 pixels and the maximum width should not exceed 200 pixels. | ||
46 | # Doxygen will copy the logo to the output directory. | ||
47 | |||
48 | PROJECT_LOGO = | ||
49 | |||
50 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | ||
51 | # base path where the generated documentation will be put. | ||
52 | # If a relative path is entered, it will be relative to the location | ||
39 | # where doxygen was started. If left blank the current directory will be used. | 53 | # where doxygen was started. If left blank the current directory will be used. |
40 | 54 | ||
41 | OUTPUT_DIRECTORY = ./ | 55 | OUTPUT_DIRECTORY = . |
42 | 56 | ||
43 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | 57 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
44 | # 4096 sub-directories (in 2 levels) under the output directory of each output | 58 | # 4096 sub-directories (in 2 levels) under the output directory of each output |
45 | # format and will distribute the generated files over these directories. | 59 | # format and will distribute the generated files over these directories. |
46 | # Enabling this option can be useful when feeding doxygen a huge amount of | 60 | # Enabling this option can be useful when feeding doxygen a huge amount of |
47 | # source files, where putting all generated files in the same directory would | 61 | # source files, where putting all generated files in the same directory would |
48 | # otherwise cause performance problems for the file system. | 62 | # otherwise cause performance problems for the file system. |
49 | 63 | ||
50 | CREATE_SUBDIRS = NO | 64 | CREATE_SUBDIRS = NO |
51 | 65 | ||
52 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 66 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
53 | # documentation generated by doxygen is written. Doxygen will use this | 67 | # documentation generated by doxygen is written. Doxygen will use this |
54 | # information to generate all constant output in the proper language. | 68 | # information to generate all constant output in the proper language. |
55 | # The default language is English, other supported languages are: | 69 | # The default language is English, other supported languages are: |
56 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, | 70 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
57 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, | 71 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
58 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English | 72 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
59 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, | 73 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
60 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, | 74 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, |
61 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. | 75 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
62 | 76 | ||
63 | OUTPUT_LANGUAGE = English | 77 | OUTPUT_LANGUAGE = English |
64 | 78 | ||
65 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 79 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
66 | # include brief member descriptions after the members that are listed in | 80 | # include brief member descriptions after the members that are listed in |
67 | # the file and class documentation (similar to JavaDoc). | 81 | # the file and class documentation (similar to JavaDoc). |
68 | # Set to NO to disable this. | 82 | # Set to NO to disable this. |
69 | 83 | ||
70 | BRIEF_MEMBER_DESC = YES | 84 | BRIEF_MEMBER_DESC = YES |
71 | 85 | ||
72 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | 86 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
73 | # the brief description of a member or function before the detailed description. | 87 | # the brief description of a member or function before the detailed description. |
74 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | 88 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
75 | # brief descriptions will be completely suppressed. | 89 | # brief descriptions will be completely suppressed. |
76 | 90 | ||
77 | REPEAT_BRIEF = YES | 91 | REPEAT_BRIEF = YES |
78 | 92 | ||
79 | # This tag implements a quasi-intelligent brief description abbreviator | 93 | # This tag implements a quasi-intelligent brief description abbreviator |
80 | # that is used to form the text in various listings. Each string | 94 | # that is used to form the text in various listings. Each string |
81 | # in this list, if found as the leading text of the brief description, will be | 95 | # in this list, if found as the leading text of the brief description, will be |
82 | # stripped from the text and the result after processing the whole list, is | 96 | # stripped from the text and the result after processing the whole list, is |
83 | # used as the annotated text. Otherwise, the brief description is used as-is. | 97 | # used as the annotated text. Otherwise, the brief description is used as-is. |
84 | # If left blank, the following values are used ("$name" is automatically | 98 | # If left blank, the following values are used ("$name" is automatically |
85 | # replaced with the name of the entity): "The $name class" "The $name widget" | 99 | # replaced with the name of the entity): "The $name class" "The $name widget" |
86 | # "The $name file" "is" "provides" "specifies" "contains" | 100 | # "The $name file" "is" "provides" "specifies" "contains" |
87 | # "represents" "a" "an" "the" | 101 | # "represents" "a" "an" "the" |
88 | 102 | ||
89 | ABBREVIATE_BRIEF = "The $name class" \ | 103 | ABBREVIATE_BRIEF = |
90 | "The $name widget" \ | 104 | |
91 | "The $name file" \ | 105 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
92 | is \ | 106 | # Doxygen will generate a detailed section even if there is only a brief |
93 | provides \ | ||
94 | specifies \ | ||
95 | contains \ | ||
96 | represents \ | ||
97 | a \ | ||
98 | an \ | ||
99 | the | ||
100 | |||
101 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | ||
102 | # Doxygen will generate a detailed section even if there is only a brief | ||
103 | # description. | 107 | # description. |
104 | 108 | ||
105 | ALWAYS_DETAILED_SEC = NO | 109 | ALWAYS_DETAILED_SEC = NO |
106 | 110 | ||
107 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all | 111 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
108 | # inherited members of a class in the documentation of that class as if those | 112 | # inherited members of a class in the documentation of that class as if those |
109 | # members were ordinary class members. Constructors, destructors and assignment | 113 | # members were ordinary class members. Constructors, destructors and assignment |
110 | # operators of the base classes will not be shown. | 114 | # operators of the base classes will not be shown. |
111 | 115 | ||
112 | INLINE_INHERITED_MEMB = NO | 116 | INLINE_INHERITED_MEMB = NO |
113 | 117 | ||
114 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | 118 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
115 | # path before files name in the file list and in the header files. If set | 119 | # path before files name in the file list and in the header files. If set |
116 | # to NO the shortest path that makes the file name unique will be used. | 120 | # to NO the shortest path that makes the file name unique will be used. |
117 | 121 | ||
118 | FULL_PATH_NAMES = YES | 122 | FULL_PATH_NAMES = NO |
119 | 123 | ||
120 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | 124 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
121 | # can be used to strip a user-defined part of the path. Stripping is | 125 | # can be used to strip a user-defined part of the path. Stripping is |
122 | # only done if one of the specified strings matches the left-hand part of | 126 | # only done if one of the specified strings matches the left-hand part of |
123 | # the path. The tag can be used to show relative paths in the file list. | 127 | # the path. The tag can be used to show relative paths in the file list. |
124 | # If left blank the directory from which doxygen is run is used as the | 128 | # If left blank the directory from which doxygen is run is used as the |
125 | # path to strip. | 129 | # path to strip. Note that you specify absolute paths here, but also |
130 | # relative paths, which will be relative from the directory where doxygen is | ||
131 | # started. | ||
126 | 132 | ||
127 | STRIP_FROM_PATH = | 133 | STRIP_FROM_PATH = |
128 | 134 | ||
129 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | 135 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
130 | # the path mentioned in the documentation of a class, which tells | 136 | # the path mentioned in the documentation of a class, which tells |
131 | # the reader which header file to include in order to use a class. | 137 | # the reader which header file to include in order to use a class. |
132 | # If left blank only the name of the header file containing the class | 138 | # If left blank only the name of the header file containing the class |
133 | # definition is used. Otherwise one should specify the include paths that | 139 | # definition is used. Otherwise one should specify the include paths that |
134 | # are normally passed to the compiler using the -I flag. | 140 | # are normally passed to the compiler using the -I flag. |
135 | 141 | ||
136 | STRIP_FROM_INC_PATH = | 142 | STRIP_FROM_INC_PATH = |
137 | 143 | ||
138 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | 144 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
139 | # (but less readable) file names. This can be useful if your file system | 145 | # (but less readable) file names. This can be useful if your file system |
140 | # doesn't support long names like on DOS, Mac, or CD-ROM. | 146 | # doesn't support long names like on DOS, Mac, or CD-ROM. |
141 | 147 | ||
142 | SHORT_NAMES = NO | 148 | SHORT_NAMES = NO |
143 | 149 | ||
144 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | 150 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
145 | # will interpret the first line (until the first dot) of a JavaDoc-style | 151 | # will interpret the first line (until the first dot) of a JavaDoc-style |
146 | # comment as the brief description. If set to NO, the JavaDoc | 152 | # comment as the brief description. If set to NO, the JavaDoc |
147 | # comments will behave just like regular Qt-style comments | 153 | # comments will behave just like regular Qt-style comments |
148 | # (thus requiring an explicit @brief command for a brief description.) | 154 | # (thus requiring an explicit @brief command for a brief description.) |
149 | 155 | ||
150 | JAVADOC_AUTOBRIEF = NO | 156 | JAVADOC_AUTOBRIEF = YES |
151 | 157 | ||
152 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will | 158 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
153 | # interpret the first line (until the first dot) of a Qt-style | 159 | # interpret the first line (until the first dot) of a Qt-style |
154 | # comment as the brief description. If set to NO, the comments | 160 | # comment as the brief description. If set to NO, the comments |
155 | # will behave just like regular Qt-style comments (thus requiring | 161 | # will behave just like regular Qt-style comments (thus requiring |
156 | # an explicit \brief command for a brief description.) | 162 | # an explicit \brief command for a brief description.) |
157 | 163 | ||
158 | QT_AUTOBRIEF = NO | 164 | QT_AUTOBRIEF = NO |
159 | 165 | ||
160 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | 166 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
161 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | 167 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
162 | # comments) as a brief description. This used to be the default behaviour. | 168 | # comments) as a brief description. This used to be the default behaviour. |
163 | # The new default is to treat a multi-line C++ comment block as a detailed | 169 | # The new default is to treat a multi-line C++ comment block as a detailed |
164 | # description. Set this tag to YES if you prefer the old behaviour instead. | 170 | # description. Set this tag to YES if you prefer the old behaviour instead. |
165 | 171 | ||
166 | MULTILINE_CPP_IS_BRIEF = NO | 172 | MULTILINE_CPP_IS_BRIEF = NO |
167 | 173 | ||
168 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | 174 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
169 | # member inherits the documentation from any documented member that it | 175 | # member inherits the documentation from any documented member that it |
170 | # re-implements. | 176 | # re-implements. |
171 | 177 | ||
172 | INHERIT_DOCS = YES | 178 | INHERIT_DOCS = YES |
173 | 179 | ||
174 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce | 180 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
175 | # a new page for each member. If set to NO, the documentation of a member will | 181 | # a new page for each member. If set to NO, the documentation of a member will |
176 | # be part of the file/class/namespace that contains it. | 182 | # be part of the file/class/namespace that contains it. |
177 | 183 | ||
178 | SEPARATE_MEMBER_PAGES = NO | 184 | SEPARATE_MEMBER_PAGES = NO |
179 | 185 | ||
180 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. | 186 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
181 | # Doxygen uses this value to replace tabs by spaces in code fragments. | 187 | # Doxygen uses this value to replace tabs by spaces in code fragments. |
182 | 188 | ||
183 | TAB_SIZE = 8 | 189 | TAB_SIZE = 8 |
184 | 190 | ||
185 | # This tag can be used to specify a number of aliases that acts | 191 | # This tag can be used to specify a number of aliases that acts |
186 | # as commands in the documentation. An alias has the form "name=value". | 192 | # as commands in the documentation. An alias has the form "name=value". |
187 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | 193 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
188 | # put the command \sideeffect (or @sideeffect) in the documentation, which | 194 | # put the command \sideeffect (or @sideeffect) in the documentation, which |
189 | # will result in a user-defined paragraph with heading "Side Effects:". | 195 | # will result in a user-defined paragraph with heading "Side Effects:". |
190 | # You can put \n's in the value part of an alias to insert newlines. | 196 | # You can put \n's in the value part of an alias to insert newlines. |
191 | 197 | ||
192 | ALIASES = | 198 | ALIASES = |
199 | |||
200 | # This tag can be used to specify a number of word-keyword mappings (TCL only). | ||
201 | # A mapping has the form "name=value". For example adding | ||
202 | # "class=itcl::class" will allow you to use the command class in the | ||
203 | # itcl::class meaning. | ||
193 | 204 | ||
194 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C | 205 | TCL_SUBST = |
195 | # sources only. Doxygen will then generate output that is more tailored for C. | 206 | |
196 | # For instance, some of the names that are used will be different. The list | 207 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
208 | # sources only. Doxygen will then generate output that is more tailored for C. | ||
209 | # For instance, some of the names that are used will be different. The list | ||
197 | # of all members will be omitted, etc. | 210 | # of all members will be omitted, etc. |
198 | 211 | ||
199 | OPTIMIZE_OUTPUT_FOR_C = NO | 212 | OPTIMIZE_OUTPUT_FOR_C = YES |
200 | 213 | ||
201 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java | 214 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
202 | # sources only. Doxygen will then generate output that is more tailored for | 215 | # sources only. Doxygen will then generate output that is more tailored for |
203 | # Java. For instance, namespaces will be presented as packages, qualified | 216 | # Java. For instance, namespaces will be presented as packages, qualified |
204 | # scopes will look different, etc. | 217 | # scopes will look different, etc. |
205 | 218 | ||
206 | OPTIMIZE_OUTPUT_JAVA = NO | 219 | OPTIMIZE_OUTPUT_JAVA = NO |
207 | 220 | ||
208 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | 221 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
209 | # sources only. Doxygen will then generate output that is more tailored for | 222 | # sources only. Doxygen will then generate output that is more tailored for |
210 | # Fortran. | 223 | # Fortran. |
211 | 224 | ||
212 | OPTIMIZE_FOR_FORTRAN = NO | 225 | OPTIMIZE_FOR_FORTRAN = NO |
213 | 226 | ||
214 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | 227 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
215 | # sources. Doxygen will then generate output that is tailored for | 228 | # sources. Doxygen will then generate output that is tailored for |
216 | # VHDL. | 229 | # VHDL. |
217 | 230 | ||
218 | OPTIMIZE_OUTPUT_VHDL = NO | 231 | OPTIMIZE_OUTPUT_VHDL = NO |
219 | 232 | ||
220 | # Doxygen selects the parser to use depending on the extension of the files it | 233 | # Doxygen selects the parser to use depending on the extension of the files it |
221 | # parses. With this tag you can assign which parser to use for a given extension. | 234 | # parses. With this tag you can assign which parser to use for a given |
222 | # Doxygen has a built-in mapping, but you can override or extend it using this | 235 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
223 | # tag. The format is ext=language, where ext is a file extension, and language | 236 | # using this tag. The format is ext=language, where ext is a file extension, |
224 | # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, | 237 | # and language is one of the parsers supported by doxygen: IDL, Java, |
225 | # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make | 238 | # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, |
226 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C | 239 | # C++. For instance to make doxygen treat .inc files as Fortran files (default |
227 | # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions | 240 | # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note |
228 | # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. | 241 | # that for custom extensions you also need to set FILE_PATTERNS otherwise the |
229 | 242 | # files are not read by doxygen. | |
230 | EXTENSION_MAPPING = | 243 | |
231 | 244 | EXTENSION_MAPPING = | |
232 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | 245 | |
233 | # to include (a tag file for) the STL sources as input, then you should | 246 | # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all |
234 | # set this tag to YES in order to let doxygen match functions declarations and | 247 | # comments according to the Markdown format, which allows for more readable |
235 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | 248 | # documentation. See http://daringfireball.net/projects/markdown/ for details. |
236 | # func(std::string) {}). This also makes the inheritance and collaboration | 249 | # The output of markdown processing is further processed by doxygen, so you |
250 | # can mix doxygen, HTML, and XML commands with Markdown formatting. | ||
251 | # Disable only in case of backward compatibilities issues. | ||
252 | |||
253 | MARKDOWN_SUPPORT = YES | ||
254 | |||
255 | # When enabled doxygen tries to link words that correspond to documented classes, | ||
256 | # or namespaces to their corresponding documentation. Such a link can be | ||
257 | # prevented in individual cases by by putting a % sign in front of the word or | ||
258 | # globally by setting AUTOLINK_SUPPORT to NO. | ||
259 | |||
260 | AUTOLINK_SUPPORT = YES | ||
261 | |||
262 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | ||
263 | # to include (a tag file for) the STL sources as input, then you should | ||
264 | # set this tag to YES in order to let doxygen match functions declarations and | ||
265 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | ||
266 | # func(std::string) {}). This also makes the inheritance and collaboration | ||
237 | # diagrams that involve STL classes more complete and accurate. | 267 | # diagrams that involve STL classes more complete and accurate. |
238 | 268 | ||
239 | BUILTIN_STL_SUPPORT = NO | 269 | BUILTIN_STL_SUPPORT = NO |
240 | 270 | ||
241 | # If you use Microsoft's C++/CLI language, you should set this option to YES to | 271 | # If you use Microsoft's C++/CLI language, you should set this option to YES to |
242 | # enable parsing support. | 272 | # enable parsing support. |
243 | 273 | ||
244 | CPP_CLI_SUPPORT = NO | 274 | CPP_CLI_SUPPORT = NO |
245 | 275 | ||
246 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | 276 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
247 | # Doxygen will parse them like normal C++ but will assume all classes use public | 277 | # Doxygen will parse them like normal C++ but will assume all classes use public |
248 | # instead of private inheritance when no explicit protection keyword is present. | 278 | # instead of private inheritance when no explicit protection keyword is present. |
249 | 279 | ||
250 | SIP_SUPPORT = NO | 280 | SIP_SUPPORT = NO |
251 | 281 | ||
252 | # For Microsoft's IDL there are propget and propput attributes to indicate getter | 282 | # For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. |
253 | # and setter methods for a property. Setting this option to YES (the default) | ||
254 | # will make doxygen replace the get and set methods by a property in the | ||
255 | # documentation. This will only work if the methods are indeed getting or | ||
256 | # setting a simple type. If this is not the case, or you want to show the | ||
257 | # methods anyway, you should set this option to NO. | ||
258 | 283 | ||
259 | IDL_PROPERTY_SUPPORT = YES | 284 | IDL_PROPERTY_SUPPORT = YES |
260 | 285 | ||
261 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | 286 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
262 | # tag is set to YES, then doxygen will reuse the documentation of the first | 287 | # tag is set to YES, then doxygen will reuse the documentation of the first |
263 | # member in the group (if any) for the other members of the group. By default | 288 | # member in the group (if any) for the other members of the group. By default |
264 | # all members of a group must be documented explicitly. | 289 | # all members of a group must be documented explicitly. |
265 | 290 | ||
266 | DISTRIBUTE_GROUP_DOC = NO | 291 | DISTRIBUTE_GROUP_DOC = NO |
267 | 292 | ||
268 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | 293 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
269 | # the same type (for instance a group of public functions) to be put as a | 294 | # the same type (for instance a group of public functions) to be put as a |
270 | # subgroup of that type (e.g. under the Public Functions section). Set it to | 295 | # subgroup of that type (e.g. under the Public Functions section). Set it to |
271 | # NO to prevent subgrouping. Alternatively, this can be done per class using | 296 | # NO to prevent subgrouping. Alternatively, this can be done per class using |
272 | # the \nosubgrouping command. | 297 | # the \nosubgrouping command. |
273 | 298 | ||
274 | SUBGROUPING = YES | 299 | SUBGROUPING = YES |
275 | 300 | ||
276 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | 301 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and |
277 | # is documented as struct, union, or enum with the name of the typedef. So | 302 | # unions are shown inside the group in which they are included (e.g. using |
278 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | 303 | # @ingroup) instead of on a separate page (for HTML and Man pages) or |
279 | # with name TypeT. When disabled the typedef will appear as a member of a file, | 304 | # section (for LaTeX and RTF). |
280 | # namespace, or class. And the struct will be named TypeS. This can typically | 305 | |
281 | # be useful for C code in case the coding convention dictates that all compound | 306 | INLINE_GROUPED_CLASSES = NO |
307 | |||
308 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and | ||
309 | # unions with only public data fields will be shown inline in the documentation | ||
310 | # of the scope in which they are defined (i.e. file, namespace, or group | ||
311 | # documentation), provided this scope is documented. If set to NO (the default), | ||
312 | # structs, classes, and unions are shown on a separate page (for HTML and Man | ||
313 | # pages) or section (for LaTeX and RTF). | ||
314 | |||
315 | INLINE_SIMPLE_STRUCTS = NO | ||
316 | |||
317 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | ||
318 | # is documented as struct, union, or enum with the name of the typedef. So | ||
319 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | ||
320 | # with name TypeT. When disabled the typedef will appear as a member of a file, | ||
321 | # namespace, or class. And the struct will be named TypeS. This can typically | ||
322 | # be useful for C code in case the coding convention dictates that all compound | ||
282 | # types are typedef'ed and only the typedef is referenced, never the tag name. | 323 | # types are typedef'ed and only the typedef is referenced, never the tag name. |
283 | 324 | ||
284 | TYPEDEF_HIDES_STRUCT = NO | 325 | TYPEDEF_HIDES_STRUCT = NO |
285 | 326 | ||
286 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to | 327 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
287 | # determine which symbols to keep in memory and which to flush to disk. | 328 | # determine which symbols to keep in memory and which to flush to disk. |
288 | # When the cache is full, less often used symbols will be written to disk. | 329 | # When the cache is full, less often used symbols will be written to disk. |
289 | # For small to medium size projects (<1000 input files) the default value is | 330 | # For small to medium size projects (<1000 input files) the default value is |
290 | # probably good enough. For larger projects a too small cache size can cause | 331 | # probably good enough. For larger projects a too small cache size can cause |
291 | # doxygen to be busy swapping symbols to and from disk most of the time | 332 | # doxygen to be busy swapping symbols to and from disk most of the time |
292 | # causing a significant performance penality. | 333 | # causing a significant performance penalty. |
293 | # If the system has enough physical memory increasing the cache will improve the | 334 | # If the system has enough physical memory increasing the cache will improve the |
294 | # performance by keeping more symbols in memory. Note that the value works on | 335 | # performance by keeping more symbols in memory. Note that the value works on |
295 | # a logarithmic scale so increasing the size by one will roughly double the | 336 | # a logarithmic scale so increasing the size by one will roughly double the |
296 | # memory usage. The cache size is given by this formula: | 337 | # memory usage. The cache size is given by this formula: |
297 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, | 338 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
298 | # corresponding to a cache size of 2^16 = 65536 symbols | 339 | # corresponding to a cache size of 2^16 = 65536 symbols. |
299 | 340 | ||
300 | SYMBOL_CACHE_SIZE = 0 | 341 | SYMBOL_CACHE_SIZE = 0 |
301 | 342 | ||
343 | # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be | ||
344 | # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given | ||
345 | # their name and scope. Since this can be an expensive process and often the | ||
346 | # same symbol appear multiple times in the code, doxygen keeps a cache of | ||
347 | # pre-resolved symbols. If the cache is too small doxygen will become slower. | ||
348 | # If the cache is too large, memory is wasted. The cache size is given by this | ||
349 | # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, | ||
350 | # corresponding to a cache size of 2^16 = 65536 symbols. | ||
351 | |||
352 | LOOKUP_CACHE_SIZE = 0 | ||
353 | |||
302 | #--------------------------------------------------------------------------- | 354 | #--------------------------------------------------------------------------- |
303 | # Build related configuration options | 355 | # Build related configuration options |
304 | #--------------------------------------------------------------------------- | 356 | #--------------------------------------------------------------------------- |
305 | 357 | ||
306 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | 358 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
307 | # documentation are documented, even if no documentation was available. | 359 | # documentation are documented, even if no documentation was available. |
308 | # Private class members and static file members will be hidden unless | 360 | # Private class members and static file members will be hidden unless |
309 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | 361 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
310 | 362 | ||
311 | EXTRACT_ALL = NO | 363 | EXTRACT_ALL = NO |
312 | 364 | ||
313 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | 365 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
314 | # will be included in the documentation. | 366 | # will be included in the documentation. |
315 | 367 | ||
316 | EXTRACT_PRIVATE = NO | 368 | EXTRACT_PRIVATE = NO |
317 | 369 | ||
318 | # If the EXTRACT_STATIC tag is set to YES all static members of a file | 370 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
371 | # scope will be included in the documentation. | ||
372 | |||
373 | EXTRACT_PACKAGE = NO | ||
374 | |||
375 | # If the EXTRACT_STATIC tag is set to YES all static members of a file | ||
319 | # will be included in the documentation. | 376 | # will be included in the documentation. |
320 | 377 | ||
321 | EXTRACT_STATIC = NO | 378 | EXTRACT_STATIC = YES |
322 | 379 | ||
323 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | 380 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
324 | # defined locally in source files will be included in the documentation. | 381 | # defined locally in source files will be included in the documentation. |
325 | # If set to NO only classes defined in header files are included. | 382 | # If set to NO only classes defined in header files are included. |
326 | 383 | ||
327 | EXTRACT_LOCAL_CLASSES = YES | 384 | EXTRACT_LOCAL_CLASSES = NO |
328 | 385 | ||
329 | # This flag is only useful for Objective-C code. When set to YES local | 386 | # This flag is only useful for Objective-C code. When set to YES local |
330 | # methods, which are defined in the implementation section but not in | 387 | # methods, which are defined in the implementation section but not in |
331 | # the interface are included in the documentation. | 388 | # the interface are included in the documentation. |
332 | # If set to NO (the default) only methods in the interface are included. | 389 | # If set to NO (the default) only methods in the interface are included. |
333 | 390 | ||
334 | EXTRACT_LOCAL_METHODS = NO | 391 | EXTRACT_LOCAL_METHODS = NO |
335 | 392 | ||
336 | # If this flag is set to YES, the members of anonymous namespaces will be | 393 | # If this flag is set to YES, the members of anonymous namespaces will be |
337 | # extracted and appear in the documentation as a namespace called | 394 | # extracted and appear in the documentation as a namespace called |
338 | # 'anonymous_namespace{file}', where file will be replaced with the base | 395 | # 'anonymous_namespace{file}', where file will be replaced with the base |
339 | # name of the file that contains the anonymous namespace. By default | 396 | # name of the file that contains the anonymous namespace. By default |
340 | # anonymous namespaces are hidden. | 397 | # anonymous namespaces are hidden. |
341 | 398 | ||
342 | EXTRACT_ANON_NSPACES = NO | 399 | EXTRACT_ANON_NSPACES = NO |
343 | 400 | ||
344 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | 401 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
345 | # undocumented members of documented classes, files or namespaces. | 402 | # undocumented members of documented classes, files or namespaces. |
346 | # If set to NO (the default) these members will be included in the | 403 | # If set to NO (the default) these members will be included in the |
347 | # various overviews, but no documentation section is generated. | 404 | # various overviews, but no documentation section is generated. |
348 | # This option has no effect if EXTRACT_ALL is enabled. | 405 | # This option has no effect if EXTRACT_ALL is enabled. |
349 | 406 | ||
350 | HIDE_UNDOC_MEMBERS = NO | 407 | HIDE_UNDOC_MEMBERS = NO |
351 | 408 | ||
352 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | 409 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
353 | # undocumented classes that are normally visible in the class hierarchy. | 410 | # undocumented classes that are normally visible in the class hierarchy. |
354 | # If set to NO (the default) these classes will be included in the various | 411 | # If set to NO (the default) these classes will be included in the various |
355 | # overviews. This option has no effect if EXTRACT_ALL is enabled. | 412 | # overviews. This option has no effect if EXTRACT_ALL is enabled. |
356 | 413 | ||
357 | HIDE_UNDOC_CLASSES = NO | 414 | HIDE_UNDOC_CLASSES = NO |
358 | 415 | ||
359 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | 416 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
360 | # friend (class|struct|union) declarations. | 417 | # friend (class|struct|union) declarations. |
361 | # If set to NO (the default) these declarations will be included in the | 418 | # If set to NO (the default) these declarations will be included in the |
362 | # documentation. | 419 | # documentation. |
363 | 420 | ||
364 | HIDE_FRIEND_COMPOUNDS = NO | 421 | HIDE_FRIEND_COMPOUNDS = NO |
365 | 422 | ||
366 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | 423 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
367 | # documentation blocks found inside the body of a function. | 424 | # documentation blocks found inside the body of a function. |
368 | # If set to NO (the default) these blocks will be appended to the | 425 | # If set to NO (the default) these blocks will be appended to the |
369 | # function's detailed documentation block. | 426 | # function's detailed documentation block. |
370 | 427 | ||
371 | HIDE_IN_BODY_DOCS = NO | 428 | HIDE_IN_BODY_DOCS = NO |
372 | 429 | ||
373 | # The INTERNAL_DOCS tag determines if documentation | 430 | # The INTERNAL_DOCS tag determines if documentation |
374 | # that is typed after a \internal command is included. If the tag is set | 431 | # that is typed after a \internal command is included. If the tag is set |
375 | # to NO (the default) then the documentation will be excluded. | 432 | # to NO (the default) then the documentation will be excluded. |
376 | # Set it to YES to include the internal documentation. | 433 | # Set it to YES to include the internal documentation. |
377 | 434 | ||
378 | INTERNAL_DOCS = NO | 435 | INTERNAL_DOCS = NO |
379 | 436 | ||
380 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | 437 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
381 | # file names in lower-case letters. If set to YES upper-case letters are also | 438 | # file names in lower-case letters. If set to YES upper-case letters are also |
382 | # allowed. This is useful if you have classes or files whose names only differ | 439 | # allowed. This is useful if you have classes or files whose names only differ |
383 | # in case and if your file system supports case sensitive file names. Windows | 440 | # in case and if your file system supports case sensitive file names. Windows |
384 | # and Mac users are advised to set this option to NO. | 441 | # and Mac users are advised to set this option to NO. |
385 | 442 | ||
386 | CASE_SENSE_NAMES = NO | 443 | CASE_SENSE_NAMES = YES |
387 | 444 | ||
388 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | 445 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
389 | # will show members with their full class and namespace scopes in the | 446 | # will show members with their full class and namespace scopes in the |
390 | # documentation. If set to YES the scope will be hidden. | 447 | # documentation. If set to YES the scope will be hidden. |
391 | 448 | ||
392 | HIDE_SCOPE_NAMES = NO | 449 | HIDE_SCOPE_NAMES = NO |
393 | 450 | ||
394 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | 451 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
395 | # will put a list of the files that are included by a file in the documentation | 452 | # will put a list of the files that are included by a file in the documentation |
396 | # of that file. | 453 | # of that file. |
397 | 454 | ||
398 | SHOW_INCLUDE_FILES = YES | 455 | SHOW_INCLUDE_FILES = NO |
399 | 456 | ||
400 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen | 457 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen |
401 | # will list include files with double quotes in the documentation | 458 | # will list include files with double quotes in the documentation |
402 | # rather than with sharp brackets. | 459 | # rather than with sharp brackets. |
403 | 460 | ||
404 | FORCE_LOCAL_INCLUDES = NO | 461 | FORCE_LOCAL_INCLUDES = NO |
405 | 462 | ||
406 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | 463 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
407 | # is inserted in the documentation for inline members. | 464 | # is inserted in the documentation for inline members. |
408 | 465 | ||
409 | INLINE_INFO = YES | 466 | INLINE_INFO = YES |
410 | 467 | ||
411 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | 468 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
412 | # will sort the (detailed) documentation of file and class members | 469 | # will sort the (detailed) documentation of file and class members |
413 | # alphabetically by member name. If set to NO the members will appear in | 470 | # alphabetically by member name. If set to NO the members will appear in |
414 | # declaration order. | 471 | # declaration order. |
415 | 472 | ||
416 | SORT_MEMBER_DOCS = YES | 473 | SORT_MEMBER_DOCS = NO |
417 | 474 | ||
418 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the | 475 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
419 | # brief documentation of file, namespace and class members alphabetically | 476 | # brief documentation of file, namespace and class members alphabetically |
420 | # by member name. If set to NO (the default) the members will appear in | 477 | # by member name. If set to NO (the default) the members will appear in |
421 | # declaration order. | 478 | # declaration order. |
422 | 479 | ||
423 | SORT_BRIEF_DOCS = NO | 480 | SORT_BRIEF_DOCS = NO |
424 | 481 | ||
425 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen | 482 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
426 | # will sort the (brief and detailed) documentation of class members so that | 483 | # will sort the (brief and detailed) documentation of class members so that |
427 | # constructors and destructors are listed first. If set to NO (the default) | 484 | # constructors and destructors are listed first. If set to NO (the default) |
428 | # the constructors will appear in the respective orders defined by | 485 | # the constructors will appear in the respective orders defined by |
429 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. | 486 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
430 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO | 487 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
431 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. | 488 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
432 | 489 | ||
433 | SORT_MEMBERS_CTORS_1ST = NO | 490 | SORT_MEMBERS_CTORS_1ST = NO |
434 | 491 | ||
435 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | 492 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
436 | # hierarchy of group names into alphabetical order. If set to NO (the default) | 493 | # hierarchy of group names into alphabetical order. If set to NO (the default) |
437 | # the group names will appear in their defined order. | 494 | # the group names will appear in their defined order. |
438 | 495 | ||
439 | SORT_GROUP_NAMES = NO | 496 | SORT_GROUP_NAMES = NO |
440 | 497 | ||
441 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | 498 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
442 | # sorted by fully-qualified names, including namespaces. If set to | 499 | # sorted by fully-qualified names, including namespaces. If set to |
443 | # NO (the default), the class list will be sorted only by class name, | 500 | # NO (the default), the class list will be sorted only by class name, |
444 | # not including the namespace part. | 501 | # not including the namespace part. |
445 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. | 502 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
446 | # Note: This option applies only to the class list, not to the | 503 | # Note: This option applies only to the class list, not to the |
447 | # alphabetical list. | 504 | # alphabetical list. |
448 | 505 | ||
449 | SORT_BY_SCOPE_NAME = NO | 506 | SORT_BY_SCOPE_NAME = NO |
450 | 507 | ||
451 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | 508 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to |
452 | # disable (NO) the todo list. This list is created by putting \todo | 509 | # do proper type resolution of all parameters of a function it will reject a |
510 | # match between the prototype and the implementation of a member function even | ||
511 | # if there is only one candidate or it is obvious which candidate to choose | ||
512 | # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen | ||
513 | # will still accept a match between prototype and implementation in such cases. | ||
514 | |||
515 | STRICT_PROTO_MATCHING = NO | ||
516 | |||
517 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | ||
518 | # disable (NO) the todo list. This list is created by putting \todo | ||
453 | # commands in the documentation. | 519 | # commands in the documentation. |
454 | 520 | ||
455 | GENERATE_TODOLIST = YES | 521 | GENERATE_TODOLIST = YES |
456 | 522 | ||
457 | # The GENERATE_TESTLIST tag can be used to enable (YES) or | 523 | # The GENERATE_TESTLIST tag can be used to enable (YES) or |
458 | # disable (NO) the test list. This list is created by putting \test | 524 | # disable (NO) the test list. This list is created by putting \test |
459 | # commands in the documentation. | 525 | # commands in the documentation. |
460 | 526 | ||
461 | GENERATE_TESTLIST = YES | 527 | GENERATE_TESTLIST = YES |
462 | 528 | ||
463 | # The GENERATE_BUGLIST tag can be used to enable (YES) or | 529 | # The GENERATE_BUGLIST tag can be used to enable (YES) or |
464 | # disable (NO) the bug list. This list is created by putting \bug | 530 | # disable (NO) the bug list. This list is created by putting \bug |
465 | # commands in the documentation. | 531 | # commands in the documentation. |
466 | 532 | ||
467 | GENERATE_BUGLIST = YES | 533 | GENERATE_BUGLIST = YES |
468 | 534 | ||
469 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | 535 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
470 | # disable (NO) the deprecated list. This list is created by putting | 536 | # disable (NO) the deprecated list. This list is created by putting |
471 | # \deprecated commands in the documentation. | 537 | # \deprecated commands in the documentation. |
472 | 538 | ||
473 | GENERATE_DEPRECATEDLIST= YES | 539 | GENERATE_DEPRECATEDLIST= YES |
474 | 540 | ||
475 | # The ENABLED_SECTIONS tag can be used to enable conditional | 541 | # The ENABLED_SECTIONS tag can be used to enable conditional |
476 | # documentation sections, marked by \if sectionname ... \endif. | 542 | # documentation sections, marked by \if sectionname ... \endif. |
477 | 543 | ||
478 | ENABLED_SECTIONS = | 544 | ENABLED_SECTIONS = |
479 | 545 | ||
480 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | 546 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
481 | # the initial value of a variable or macro consists of for it to appear in | 547 | # the initial value of a variable or macro consists of for it to appear in |
482 | # the documentation. If the initializer consists of more lines than specified | 548 | # the documentation. If the initializer consists of more lines than specified |
483 | # here it will be hidden. Use a value of 0 to hide initializers completely. | 549 | # here it will be hidden. Use a value of 0 to hide initializers completely. |
484 | # The appearance of the initializer of individual variables and macros in the | 550 | # The appearance of the initializer of individual variables and macros in the |
485 | # documentation can be controlled using \showinitializer or \hideinitializer | 551 | # documentation can be controlled using \showinitializer or \hideinitializer |
486 | # command in the documentation regardless of this setting. | 552 | # command in the documentation regardless of this setting. |
487 | 553 | ||
488 | MAX_INITIALIZER_LINES = 30 | 554 | MAX_INITIALIZER_LINES = 30 |
489 | 555 | ||
490 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | 556 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
491 | # at the bottom of the documentation of classes and structs. If set to YES the | 557 | # at the bottom of the documentation of classes and structs. If set to YES the |
492 | # list will mention the files that were used to generate the documentation. | 558 | # list will mention the files that were used to generate the documentation. |
493 | 559 | ||
494 | SHOW_USED_FILES = YES | 560 | SHOW_USED_FILES = NO |
495 | |||
496 | # If the sources in your project are distributed over multiple directories | ||
497 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | ||
498 | # in the documentation. The default is NO. | ||
499 | 561 | ||
500 | SHOW_DIRECTORIES = NO | 562 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
501 | 563 | # This will remove the Files entry from the Quick Index and from the | |
502 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | ||
503 | # This will remove the Files entry from the Quick Index and from the | ||
504 | # Folder Tree View (if specified). The default is YES. | 564 | # Folder Tree View (if specified). The default is YES. |
505 | 565 | ||
506 | SHOW_FILES = YES | 566 | SHOW_FILES = YES |
507 | 567 | ||
508 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | 568 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
509 | # Namespaces page. This will remove the Namespaces entry from the Quick Index | 569 | # Namespaces page. |
570 | # This will remove the Namespaces entry from the Quick Index | ||
510 | # and from the Folder Tree View (if specified). The default is YES. | 571 | # and from the Folder Tree View (if specified). The default is YES. |
511 | 572 | ||
512 | SHOW_NAMESPACES = YES | 573 | SHOW_NAMESPACES = YES |
513 | 574 | ||
514 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that | 575 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
515 | # doxygen should invoke to get the current version for each file (typically from | 576 | # doxygen should invoke to get the current version for each file (typically from |
516 | # the version control system). Doxygen will invoke the program by executing (via | 577 | # the version control system). Doxygen will invoke the program by executing (via |
517 | # popen()) the command <command> <input-file>, where <command> is the value of | 578 | # popen()) the command <command> <input-file>, where <command> is the value of |
518 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | 579 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
519 | # provided by doxygen. Whatever the program writes to standard output | 580 | # provided by doxygen. Whatever the program writes to standard output |
520 | # is used as the file version. See the manual for examples. | 581 | # is used as the file version. See the manual for examples. |
521 | 582 | ||
522 | FILE_VERSION_FILTER = | 583 | FILE_VERSION_FILTER = |
523 | 584 | ||
524 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed | 585 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
525 | # by doxygen. The layout file controls the global structure of the generated | 586 | # by doxygen. The layout file controls the global structure of the generated |
526 | # output files in an output format independent way. The create the layout file | 587 | # output files in an output format independent way. To create the layout file |
527 | # that represents doxygen's defaults, run doxygen with the -l option. | 588 | # that represents doxygen's defaults, run doxygen with the -l option. |
528 | # You can optionally specify a file name after the option, if omitted | 589 | # You can optionally specify a file name after the option, if omitted |
529 | # DoxygenLayout.xml will be used as the name of the layout file. | 590 | # DoxygenLayout.xml will be used as the name of the layout file. |
530 | 591 | ||
531 | LAYOUT_FILE = | 592 | LAYOUT_FILE = |
593 | |||
594 | # The CITE_BIB_FILES tag can be used to specify one or more bib files | ||
595 | # containing the references data. This must be a list of .bib files. The | ||
596 | # .bib extension is automatically appended if omitted. Using this command | ||
597 | # requires the bibtex tool to be installed. See also | ||
598 | # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style | ||
599 | # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this | ||
600 | # feature you need bibtex and perl available in the search path. | ||
601 | |||
602 | CITE_BIB_FILES = | ||
532 | 603 | ||
533 | #--------------------------------------------------------------------------- | 604 | #--------------------------------------------------------------------------- |
534 | # configuration options related to warning and progress messages | 605 | # configuration options related to warning and progress messages |
535 | #--------------------------------------------------------------------------- | 606 | #--------------------------------------------------------------------------- |
536 | 607 | ||
537 | # The QUIET tag can be used to turn on/off the messages that are generated | 608 | # The QUIET tag can be used to turn on/off the messages that are generated |
538 | # by doxygen. Possible values are YES and NO. If left blank NO is used. | 609 | # by doxygen. Possible values are YES and NO. If left blank NO is used. |
539 | 610 | ||
540 | QUIET = NO | 611 | QUIET = NO |
541 | 612 | ||
542 | # The WARNINGS tag can be used to turn on/off the warning messages that are | 613 | # The WARNINGS tag can be used to turn on/off the warning messages that are |
543 | # generated by doxygen. Possible values are YES and NO. If left blank | 614 | # generated by doxygen. Possible values are YES and NO. If left blank |
544 | # NO is used. | 615 | # NO is used. |
545 | 616 | ||
546 | WARNINGS = YES | 617 | WARNINGS = YES |
547 | 618 | ||
548 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | 619 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
549 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | 620 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
550 | # automatically be disabled. | 621 | # automatically be disabled. |
551 | 622 | ||
552 | WARN_IF_UNDOCUMENTED = YES | 623 | WARN_IF_UNDOCUMENTED = YES |
553 | 624 | ||
554 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | 625 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
555 | # potential errors in the documentation, such as not documenting some | 626 | # potential errors in the documentation, such as not documenting some |
556 | # parameters in a documented function, or documenting parameters that | 627 | # parameters in a documented function, or documenting parameters that |
557 | # don't exist or using markup commands wrongly. | 628 | # don't exist or using markup commands wrongly. |
558 | 629 | ||
559 | WARN_IF_DOC_ERROR = YES | 630 | WARN_IF_DOC_ERROR = YES |
560 | 631 | ||
561 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for | 632 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for |
562 | # functions that are documented, but have no documentation for their parameters | 633 | # functions that are documented, but have no documentation for their parameters |
563 | # or return value. If set to NO (the default) doxygen will only warn about | 634 | # or return value. If set to NO (the default) doxygen will only warn about |
564 | # wrong or incomplete parameter documentation, but not about the absence of | 635 | # wrong or incomplete parameter documentation, but not about the absence of |
565 | # documentation. | 636 | # documentation. |
566 | 637 | ||
567 | WARN_NO_PARAMDOC = NO | 638 | WARN_NO_PARAMDOC = YES |
568 | 639 | ||
569 | # The WARN_FORMAT tag determines the format of the warning messages that | 640 | # The WARN_FORMAT tag determines the format of the warning messages that |
570 | # doxygen can produce. The string should contain the $file, $line, and $text | 641 | # doxygen can produce. The string should contain the $file, $line, and $text |
571 | # tags, which will be replaced by the file and line number from which the | 642 | # tags, which will be replaced by the file and line number from which the |
572 | # warning originated and the warning text. Optionally the format may contain | 643 | # warning originated and the warning text. Optionally the format may contain |
573 | # $version, which will be replaced by the version of the file (if it could | 644 | # $version, which will be replaced by the version of the file (if it could |
574 | # be obtained via FILE_VERSION_FILTER) | 645 | # be obtained via FILE_VERSION_FILTER) |
575 | 646 | ||
576 | WARN_FORMAT = "$file:$line: $text" | 647 | WARN_FORMAT = "$file:$line: $text" |
577 | 648 | ||
578 | # The WARN_LOGFILE tag can be used to specify a file to which warning | 649 | # The WARN_LOGFILE tag can be used to specify a file to which warning |
579 | # and error messages should be written. If left blank the output is written | 650 | # and error messages should be written. If left blank the output is written |
580 | # to stderr. | 651 | # to stderr. |
581 | 652 | ||
582 | WARN_LOGFILE = | 653 | WARN_LOGFILE = |
583 | 654 | ||
584 | #--------------------------------------------------------------------------- | 655 | #--------------------------------------------------------------------------- |
585 | # configuration options related to the input files | 656 | # configuration options related to the input files |
586 | #--------------------------------------------------------------------------- | 657 | #--------------------------------------------------------------------------- |
587 | 658 | ||
588 | # The INPUT tag can be used to specify the files and/or directories that contain | 659 | # The INPUT tag can be used to specify the files and/or directories that contain |
589 | # documented source files. You may enter file names like "myfile.cpp" or | 660 | # documented source files. You may enter file names like "myfile.cpp" or |
590 | # directories like "/usr/src/myproject". Separate the files or directories | 661 | # directories like "/usr/src/myproject". Separate the files or directories |
591 | # with spaces. | 662 | # with spaces. |
592 | 663 | ||
593 | INPUT = ../src/bin | 664 | INPUT = ../src/bin/ \ |
665 | ../src/lib/ \ | ||
666 | ../src/include/ \ | ||
667 | smman.dox | ||
594 | 668 | ||
595 | # This tag can be used to specify the character encoding of the source files | 669 | # This tag can be used to specify the character encoding of the source files |
596 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | 670 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
597 | # also the default input encoding. Doxygen uses libiconv (or the iconv built | 671 | # also the default input encoding. Doxygen uses libiconv (or the iconv built |
598 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | 672 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
599 | # the list of possible encodings. | 673 | # the list of possible encodings. |
600 | 674 | ||
601 | INPUT_ENCODING = UTF-8 | 675 | INPUT_ENCODING = UTF-8 |
602 | 676 | ||
603 | # If the value of the INPUT tag contains directories, you can use the | 677 | # If the value of the INPUT tag contains directories, you can use the |
604 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 678 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
605 | # and *.h) to filter out the source-files in the directories. If left | 679 | # and *.h) to filter out the source-files in the directories. If left |
606 | # blank the following patterns are tested: | 680 | # blank the following patterns are tested: |
607 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh | 681 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
608 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | 682 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
609 | # *.f90 *.f *.vhd *.vhdl | 683 | # *.f90 *.f *.for *.vhd *.vhdl |
610 | 684 | ||
611 | FILE_PATTERNS = *.c \ | 685 | FILE_PATTERNS = *.c \ |
612 | *.cc \ | ||
613 | *.cxx \ | ||
614 | *.cpp \ | ||
615 | *.c++ \ | ||
616 | *.d \ | ||
617 | *.java \ | ||
618 | *.ii \ | ||
619 | *.ixx \ | ||
620 | *.ipp \ | ||
621 | *.i++ \ | ||
622 | *.inl \ | ||
623 | *.h \ | 686 | *.h \ |
624 | *.hh \ | 687 | *.x |
625 | *.hxx \ | 688 | |
626 | *.hpp \ | 689 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
627 | *.h++ \ | 690 | # should be searched for input files as well. Possible values are YES and NO. |
628 | *.idl \ | ||
629 | *.odl \ | ||
630 | *.cs \ | ||
631 | *.php \ | ||
632 | *.php3 \ | ||
633 | *.inc \ | ||
634 | *.m \ | ||
635 | *.mm \ | ||
636 | *.dox \ | ||
637 | *.py \ | ||
638 | *.f90 \ | ||
639 | *.f \ | ||
640 | *.vhd \ | ||
641 | *.vhdl | ||
642 | |||
643 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories | ||
644 | # should be searched for input files as well. Possible values are YES and NO. | ||
645 | # If left blank NO is used. | 691 | # If left blank NO is used. |
646 | 692 | ||
647 | RECURSIVE = YES | 693 | RECURSIVE = YES |
648 | 694 | ||
649 | # The EXCLUDE tag can be used to specify files and/or directories that should | 695 | # The EXCLUDE tag can be used to specify files and/or directories that should be |
650 | # excluded from the INPUT source files. This way you can easily exclude a | 696 | # excluded from the INPUT source files. This way you can easily exclude a |
651 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | 697 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
698 | # Note that relative paths are relative to the directory from which doxygen is | ||
699 | # run. | ||
652 | 700 | ||
653 | EXCLUDE = | 701 | EXCLUDE = |
654 | 702 | ||
655 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or | 703 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
656 | # directories that are symbolic links (a Unix filesystem feature) are excluded | 704 | # directories that are symbolic links (a Unix file system feature) are excluded |
657 | # from the input. | 705 | # from the input. |
658 | 706 | ||
659 | EXCLUDE_SYMLINKS = NO | 707 | EXCLUDE_SYMLINKS = NO |
660 | 708 | ||
661 | # If the value of the INPUT tag contains directories, you can use the | 709 | # If the value of the INPUT tag contains directories, you can use the |
662 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | 710 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
663 | # certain files from those directories. Note that the wildcards are matched | 711 | # certain files from those directories. Note that the wildcards are matched |
664 | # against the file with absolute path, so to exclude all test directories | 712 | # against the file with absolute path, so to exclude all test directories |
665 | # for example use the pattern */test/* | 713 | # for example use the pattern */test/* |
666 | 714 | ||
667 | EXCLUDE_PATTERNS = | 715 | EXCLUDE_PATTERNS = |
668 | 716 | ||
669 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | 717 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
670 | # (namespaces, classes, functions, etc.) that should be excluded from the | 718 | # (namespaces, classes, functions, etc.) that should be excluded from the |
671 | # output. The symbol name can be a fully qualified name, a word, or if the | 719 | # output. The symbol name can be a fully qualified name, a word, or if the |
672 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | 720 | # wildcard * is used, a substring. Examples: ANamespace, AClass, |
673 | # AClass::ANamespace, ANamespace::*Test | 721 | # AClass::ANamespace, ANamespace::*Test |
674 | 722 | ||
675 | EXCLUDE_SYMBOLS = | 723 | EXCLUDE_SYMBOLS = |
676 | 724 | ||
677 | # The EXAMPLE_PATH tag can be used to specify one or more files or | 725 | # The EXAMPLE_PATH tag can be used to specify one or more files or |
678 | # directories that contain example code fragments that are included (see | 726 | # directories that contain example code fragments that are included (see |
679 | # the \include command). | 727 | # the \include command). |
680 | 728 | ||
681 | EXAMPLE_PATH = | 729 | EXAMPLE_PATH = |
682 | 730 | ||
683 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | 731 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
684 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 732 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
685 | # and *.h) to filter out the source-files in the directories. If left | 733 | # and *.h) to filter out the source-files in the directories. If left |
686 | # blank all files are included. | 734 | # blank all files are included. |
687 | 735 | ||
688 | EXAMPLE_PATTERNS = * | 736 | EXAMPLE_PATTERNS = |
689 | 737 | ||
690 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | 738 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
691 | # searched for input files to be used with the \include or \dontinclude | 739 | # searched for input files to be used with the \include or \dontinclude |
692 | # commands irrespective of the value of the RECURSIVE tag. | 740 | # commands irrespective of the value of the RECURSIVE tag. |
693 | # Possible values are YES and NO. If left blank NO is used. | 741 | # Possible values are YES and NO. If left blank NO is used. |
694 | 742 | ||
695 | EXAMPLE_RECURSIVE = NO | 743 | EXAMPLE_RECURSIVE = NO |
696 | 744 | ||
697 | # The IMAGE_PATH tag can be used to specify one or more files or | 745 | # The IMAGE_PATH tag can be used to specify one or more files or |
698 | # directories that contain image that are included in the documentation (see | 746 | # directories that contain image that are included in the documentation (see |
699 | # the \image command). | 747 | # the \image command). |
700 | 748 | ||
701 | IMAGE_PATH = | 749 | IMAGE_PATH = doc/img \ |
750 | doc/benchmark | ||
702 | 751 | ||
703 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | 752 | # The INPUT_FILTER tag can be used to specify a program that doxygen should |
704 | # invoke to filter for each input file. Doxygen will invoke the filter program | 753 | # invoke to filter for each input file. Doxygen will invoke the filter program |
705 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | 754 | # by executing (via popen()) the command <filter> <input-file>, where <filter> |
706 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | 755 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
707 | # input file. Doxygen will then use the output that the filter program writes | 756 | # input file. Doxygen will then use the output that the filter program writes |
708 | # to standard output. If FILTER_PATTERNS is specified, this tag will be | 757 | # to standard output. |
758 | # If FILTER_PATTERNS is specified, this tag will be | ||
709 | # ignored. | 759 | # ignored. |
710 | 760 | ||
711 | INPUT_FILTER = | 761 | INPUT_FILTER = |
712 | 762 | ||
713 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | 763 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
714 | # basis. Doxygen will compare the file name with each pattern and apply the | 764 | # basis. |
715 | # filter if there is a match. The filters are a list of the form: | 765 | # Doxygen will compare the file name with each pattern and apply the |
716 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | 766 | # filter if there is a match. |
717 | # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | 767 | # The filters are a list of the form: |
718 | # is applied to all files. | 768 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
769 | # info on how filters are used. If FILTER_PATTERNS is empty or if | ||
770 | # non of the patterns match the file name, INPUT_FILTER is applied. | ||
719 | 771 | ||
720 | FILTER_PATTERNS = | 772 | FILTER_PATTERNS = |
721 | 773 | ||
722 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | 774 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
723 | # INPUT_FILTER) will be used to filter the input files when producing source | 775 | # INPUT_FILTER) will be used to filter the input files when producing source |
724 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). | 776 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
725 | 777 | ||
726 | FILTER_SOURCE_FILES = NO | 778 | FILTER_SOURCE_FILES = NO |
727 | 779 | ||
780 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | ||
781 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) | ||
782 | # and it is also possible to disable source filtering for a specific pattern | ||
783 | # using *.ext= (so without naming a filter). This option only has effect when | ||
784 | # FILTER_SOURCE_FILES is enabled. | ||
785 | |||
786 | FILTER_SOURCE_PATTERNS = | ||
787 | |||
728 | #--------------------------------------------------------------------------- | 788 | #--------------------------------------------------------------------------- |
729 | # configuration options related to source browsing | 789 | # configuration options related to source browsing |
730 | #--------------------------------------------------------------------------- | 790 | #--------------------------------------------------------------------------- |
731 | 791 | ||
732 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | 792 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
733 | # be generated. Documented entities will be cross-referenced with these sources. | 793 | # be generated. Documented entities will be cross-referenced with these sources. |
734 | # Note: To get rid of all source code in the generated output, make sure also | 794 | # Note: To get rid of all source code in the generated output, make sure also |
735 | # VERBATIM_HEADERS is set to NO. | 795 | # VERBATIM_HEADERS is set to NO. |
736 | 796 | ||
737 | SOURCE_BROWSER = NO | 797 | SOURCE_BROWSER = NO |
738 | 798 | ||
739 | # Setting the INLINE_SOURCES tag to YES will include the body | 799 | # Setting the INLINE_SOURCES tag to YES will include the body |
740 | # of functions and classes directly in the documentation. | 800 | # of functions and classes directly in the documentation. |
741 | 801 | ||
742 | INLINE_SOURCES = NO | 802 | INLINE_SOURCES = NO |
743 | 803 | ||
744 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | 804 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
745 | # doxygen to hide any special comment blocks from generated source code | 805 | # doxygen to hide any special comment blocks from generated source code |
746 | # fragments. Normal C and C++ comments will always remain visible. | 806 | # fragments. Normal C, C++ and Fortran comments will always remain visible. |
747 | 807 | ||
748 | STRIP_CODE_COMMENTS = YES | 808 | STRIP_CODE_COMMENTS = YES |
749 | 809 | ||
750 | # If the REFERENCED_BY_RELATION tag is set to YES | 810 | # If the REFERENCED_BY_RELATION tag is set to YES |
751 | # then for each documented function all documented | 811 | # then for each documented function all documented |
752 | # functions referencing it will be listed. | 812 | # functions referencing it will be listed. |
753 | 813 | ||
754 | REFERENCED_BY_RELATION = NO | 814 | REFERENCED_BY_RELATION = YES |
755 | 815 | ||
756 | # If the REFERENCES_RELATION tag is set to YES | 816 | # If the REFERENCES_RELATION tag is set to YES |
757 | # then for each documented function all documented entities | 817 | # then for each documented function all documented entities |
758 | # called/used by that function will be listed. | 818 | # called/used by that function will be listed. |
759 | 819 | ||
760 | REFERENCES_RELATION = NO | 820 | REFERENCES_RELATION = YES |
761 | 821 | ||
762 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | 822 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
763 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | 823 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
764 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | 824 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
765 | # link to the source code. Otherwise they will link to the documentation. | 825 | # link to the source code. |
826 | # Otherwise they will link to the documentation. | ||
766 | 827 | ||
767 | REFERENCES_LINK_SOURCE = YES | 828 | REFERENCES_LINK_SOURCE = YES |
768 | 829 | ||
769 | # If the USE_HTAGS tag is set to YES then the references to source code | 830 | # If the USE_HTAGS tag is set to YES then the references to source code |
770 | # will point to the HTML generated by the htags(1) tool instead of doxygen | 831 | # will point to the HTML generated by the htags(1) tool instead of doxygen |
771 | # built-in source browser. The htags tool is part of GNU's global source | 832 | # built-in source browser. The htags tool is part of GNU's global source |
772 | # tagging system (see http://www.gnu.org/software/global/global.html). You | 833 | # tagging system (see http://www.gnu.org/software/global/global.html). You |
773 | # will need version 4.8.6 or higher. | 834 | # will need version 4.8.6 or higher. |
774 | 835 | ||
775 | USE_HTAGS = NO | 836 | USE_HTAGS = NO |
776 | 837 | ||
777 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | 838 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
778 | # will generate a verbatim copy of the header file for each class for | 839 | # will generate a verbatim copy of the header file for each class for |
779 | # which an include is specified. Set to NO to disable this. | 840 | # which an include is specified. Set to NO to disable this. |
780 | 841 | ||
781 | VERBATIM_HEADERS = YES | 842 | VERBATIM_HEADERS = NO |
782 | 843 | ||
783 | #--------------------------------------------------------------------------- | 844 | #--------------------------------------------------------------------------- |
784 | # configuration options related to the alphabetical class index | 845 | # configuration options related to the alphabetical class index |
785 | #--------------------------------------------------------------------------- | 846 | #--------------------------------------------------------------------------- |
786 | 847 | ||
787 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | 848 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
788 | # of all compounds will be generated. Enable this if the project | 849 | # of all compounds will be generated. Enable this if the project |
789 | # contains a lot of classes, structs, unions or interfaces. | 850 | # contains a lot of classes, structs, unions or interfaces. |
790 | 851 | ||
791 | ALPHABETICAL_INDEX = YES | 852 | ALPHABETICAL_INDEX = YES |
792 | 853 | ||
793 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | 854 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
794 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | 855 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
795 | # in which this list will be split (can be a number in the range [1..20]) | 856 | # in which this list will be split (can be a number in the range [1..20]) |
796 | 857 | ||
797 | COLS_IN_ALPHA_INDEX = 5 | 858 | COLS_IN_ALPHA_INDEX = 2 |
798 | 859 | ||
799 | # In case all classes in a project start with a common prefix, all | 860 | # In case all classes in a project start with a common prefix, all |
800 | # classes will be put under the same header in the alphabetical index. | 861 | # classes will be put under the same header in the alphabetical index. |
801 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | 862 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
802 | # should be ignored while generating the index headers. | 863 | # should be ignored while generating the index headers. |
803 | 864 | ||
804 | IGNORE_PREFIX = | 865 | IGNORE_PREFIX = |
805 | 866 | ||
806 | #--------------------------------------------------------------------------- | 867 | #--------------------------------------------------------------------------- |
807 | # configuration options related to the HTML output | 868 | # configuration options related to the HTML output |
808 | #--------------------------------------------------------------------------- | 869 | #--------------------------------------------------------------------------- |
809 | 870 | ||
810 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | 871 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
811 | # generate HTML output. | 872 | # generate HTML output. |
812 | 873 | ||
813 | GENERATE_HTML = YES | 874 | GENERATE_HTML = YES |
814 | 875 | ||
815 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | 876 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
816 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 877 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
817 | # put in front of it. If left blank `html' will be used as the default path. | 878 | # put in front of it. If left blank `html' will be used as the default path. |
818 | 879 | ||
819 | HTML_OUTPUT = html | 880 | HTML_OUTPUT = html |
820 | 881 | ||
821 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | 882 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
822 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | 883 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
823 | # doxygen will generate files with .html extension. | 884 | # doxygen will generate files with .html extension. |
824 | 885 | ||
825 | HTML_FILE_EXTENSION = .html | 886 | HTML_FILE_EXTENSION = .html |
826 | 887 | ||
827 | # The HTML_HEADER tag can be used to specify a personal HTML header for | 888 | # The HTML_HEADER tag can be used to specify a personal HTML header for |
828 | # each generated HTML page. If it is left blank doxygen will generate a | 889 | # each generated HTML page. If it is left blank doxygen will generate a |
829 | # standard header. | 890 | # standard header. Note that when using a custom header you are responsible |
830 | 891 | # for the proper inclusion of any scripts and style sheets that doxygen | |
831 | HTML_HEADER = | 892 | # needs, which is dependent on the configuration options used. |
832 | 893 | # It is advised to generate a default header using "doxygen -w html | |
833 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | 894 | # header.html footer.html stylesheet.css YourConfigFile" and then modify |
834 | # each generated HTML page. If it is left blank doxygen will generate a | 895 | # that header. Note that the header is subject to change so you typically |
896 | # have to redo this when upgrading to a newer version of doxygen or when | ||
897 | # changing the value of configuration settings such as GENERATE_TREEVIEW! | ||
898 | |||
899 | HTML_HEADER = doxygen/data/head.html | ||
900 | |||
901 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | ||
902 | # each generated HTML page. If it is left blank doxygen will generate a | ||
835 | # standard footer. | 903 | # standard footer. |
836 | 904 | ||
837 | HTML_FOOTER = | 905 | HTML_FOOTER = doxygen/data/foot.html |
838 | 906 | ||
839 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | 907 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
840 | # style sheet that is used by each HTML page. It can be used to | 908 | # style sheet that is used by each HTML page. It can be used to |
841 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | 909 | # fine-tune the look of the HTML output. If left blank doxygen will |
842 | # will generate a default style sheet. Note that doxygen will try to copy | 910 | # generate a default style sheet. Note that it is recommended to use |
843 | # the style sheet file to the HTML output directory, so don't put your own | 911 | # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this |
844 | # stylesheet in the HTML output directory as well, or it will be erased! | 912 | # tag will in the future become obsolete. |
845 | 913 | ||
846 | HTML_STYLESHEET = | 914 | HTML_STYLESHEET = doxygen/data/css/style.css |
847 | 915 | ||
848 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | 916 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional |
849 | # Doxygen will adjust the colors in the stylesheet and background images | 917 | # user-defined cascading style sheet that is included after the standard |
850 | # according to this color. Hue is specified as an angle on a colorwheel, | 918 | # style sheets created by doxygen. Using this option one can overrule |
851 | # see http://en.wikipedia.org/wiki/Hue for more information. | 919 | # certain style aspects. This is preferred over using HTML_STYLESHEET |
852 | # For instance the value 0 represents red, 60 is yellow, 120 is green, | 920 | # since it does not replace the standard style sheet and is therefor more |
853 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | 921 | # robust against future updates. Doxygen will copy the style sheet file to |
922 | # the output directory. | ||
923 | |||
924 | HTML_EXTRA_STYLESHEET = | ||
925 | |||
926 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or | ||
927 | # other source files which should be copied to the HTML output directory. Note | ||
928 | # that these files will be copied to the base HTML output directory. Use the | ||
929 | # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these | ||
930 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that | ||
931 | # the files will be copied as-is; there are no commands or markers available. | ||
932 | |||
933 | HTML_EXTRA_FILES = | ||
934 | |||
935 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | ||
936 | # Doxygen will adjust the colors in the style sheet and background images | ||
937 | # according to this color. Hue is specified as an angle on a colorwheel, | ||
938 | # see http://en.wikipedia.org/wiki/Hue for more information. | ||
939 | # For instance the value 0 represents red, 60 is yellow, 120 is green, | ||
940 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | ||
854 | # The allowed range is 0 to 359. | 941 | # The allowed range is 0 to 359. |
855 | 942 | ||
856 | HTML_COLORSTYLE_HUE = 220 | 943 | HTML_COLORSTYLE_HUE = 220 |
857 | 944 | ||
858 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of | 945 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of |
859 | # the colors in the HTML output. For a value of 0 the output will use | 946 | # the colors in the HTML output. For a value of 0 the output will use |
860 | # grayscales only. A value of 255 will produce the most vivid colors. | 947 | # grayscales only. A value of 255 will produce the most vivid colors. |
861 | 948 | ||
862 | HTML_COLORSTYLE_SAT = 100 | 949 | HTML_COLORSTYLE_SAT = 100 |
863 | 950 | ||
864 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to | 951 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to |
865 | # the luminance component of the colors in the HTML output. Values below | 952 | # the luminance component of the colors in the HTML output. Values below |
866 | # 100 gradually make the output lighter, whereas values above 100 make | 953 | # 100 gradually make the output lighter, whereas values above 100 make |
867 | # the output darker. The value divided by 100 is the actual gamma applied, | 954 | # the output darker. The value divided by 100 is the actual gamma applied, |
868 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, | 955 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, |
869 | # and 100 does not change the gamma. | 956 | # and 100 does not change the gamma. |
870 | 957 | ||
871 | HTML_COLORSTYLE_GAMMA = 80 | 958 | HTML_COLORSTYLE_GAMMA = 80 |
872 | 959 | ||
873 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | 960 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
874 | # page will contain the date and time when the page was generated. Setting | 961 | # page will contain the date and time when the page was generated. Setting |
875 | # this to NO can help when comparing the output of multiple runs. | 962 | # this to NO can help when comparing the output of multiple runs. |
876 | 963 | ||
877 | HTML_TIMESTAMP = YES | 964 | HTML_TIMESTAMP = YES |
878 | 965 | ||
879 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | 966 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
880 | # files or namespaces will be aligned in HTML using tables. If set to | 967 | # documentation will contain sections that can be hidden and shown after the |
881 | # NO a bullet list will be used. | 968 | # page has loaded. |
882 | |||
883 | HTML_ALIGN_MEMBERS = YES | ||
884 | |||
885 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
886 | # documentation will contain sections that can be hidden and shown after the | ||
887 | # page has loaded. For this to work a browser that supports | ||
888 | # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | ||
889 | # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | ||
890 | 969 | ||
891 | HTML_DYNAMIC_SECTIONS = NO | 970 | HTML_DYNAMIC_SECTIONS = NO |
892 | 971 | ||
893 | # If the GENERATE_DOCSET tag is set to YES, additional index files | 972 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of |
894 | # will be generated that can be used as input for Apple's Xcode 3 | 973 | # entries shown in the various tree structured indices initially; the user |
895 | # integrated development environment, introduced with OSX 10.5 (Leopard). | 974 | # can expand and collapse entries dynamically later on. Doxygen will expand |
896 | # To create a documentation set, doxygen will generate a Makefile in the | 975 | # the tree to such a level that at most the specified number of entries are |
897 | # HTML output directory. Running make will produce the docset in that | 976 | # visible (unless a fully collapsed tree already exceeds this amount). |
898 | # directory and running "make install" will install the docset in | 977 | # So setting the number of entries 1 will produce a full collapsed tree by |
899 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | 978 | # default. 0 is a special value representing an infinite number of entries |
900 | # it at startup. | 979 | # and will result in a full expanded tree by default. |
901 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | 980 | |
981 | HTML_INDEX_NUM_ENTRIES = 100 | ||
982 | |||
983 | # If the GENERATE_DOCSET tag is set to YES, additional index files | ||
984 | # will be generated that can be used as input for Apple's Xcode 3 | ||
985 | # integrated development environment, introduced with OSX 10.5 (Leopard). | ||
986 | # To create a documentation set, doxygen will generate a Makefile in the | ||
987 | # HTML output directory. Running make will produce the docset in that | ||
988 | # directory and running "make install" will install the docset in | ||
989 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | ||
990 | # it at startup. | ||
991 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | ||
902 | # for more information. | 992 | # for more information. |
903 | 993 | ||
904 | GENERATE_DOCSET = NO | 994 | GENERATE_DOCSET = NO |
905 | 995 | ||
906 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | 996 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
907 | # feed. A documentation feed provides an umbrella under which multiple | 997 | # feed. A documentation feed provides an umbrella under which multiple |
908 | # documentation sets from a single provider (such as a company or product suite) | 998 | # documentation sets from a single provider (such as a company or product suite) |
909 | # can be grouped. | 999 | # can be grouped. |
910 | 1000 | ||
911 | DOCSET_FEEDNAME = "Doxygen generated docs" | 1001 | DOCSET_FEEDNAME = "Doxygen generated docs" |
912 | 1002 | ||
913 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | 1003 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
914 | # should uniquely identify the documentation set bundle. This should be a | 1004 | # should uniquely identify the documentation set bundle. This should be a |
915 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | 1005 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
916 | # will append .docset to the name. | 1006 | # will append .docset to the name. |
917 | 1007 | ||
918 | DOCSET_BUNDLE_ID = org.doxygen.Project | 1008 | DOCSET_BUNDLE_ID = com.asp64.corepack |
919 | 1009 | ||
920 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify | 1010 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely |
921 | # the documentation publisher. This should be a reverse domain-name style | 1011 | # identify the documentation publisher. This should be a reverse domain-name |
922 | # string, e.g. com.mycompany.MyDocSet.documentation. | 1012 | # style string, e.g. com.mycompany.MyDocSet.documentation. |
923 | 1013 | ||
924 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher | 1014 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
925 | 1015 | ||
@@ -927,211 +1017,216 @@ DOCSET_PUBLISHER_ID = org.doxygen.Publisher | |||
927 | 1017 | ||
928 | DOCSET_PUBLISHER_NAME = Publisher | 1018 | DOCSET_PUBLISHER_NAME = Publisher |
929 | 1019 | ||
930 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 1020 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
931 | # will be generated that can be used as input for tools like the | 1021 | # will be generated that can be used as input for tools like the |
932 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | 1022 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
933 | # of the generated HTML documentation. | 1023 | # of the generated HTML documentation. |
934 | 1024 | ||
935 | GENERATE_HTMLHELP = NO | 1025 | GENERATE_HTMLHELP = NO |
936 | 1026 | ||
937 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | 1027 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
938 | # be used to specify the file name of the resulting .chm file. You | 1028 | # be used to specify the file name of the resulting .chm file. You |
939 | # can add a path in front of the file if the result should not be | 1029 | # can add a path in front of the file if the result should not be |
940 | # written to the html output directory. | 1030 | # written to the html output directory. |
941 | 1031 | ||
942 | CHM_FILE = | 1032 | CHM_FILE = |
943 | 1033 | ||
944 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | 1034 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
945 | # be used to specify the location (absolute path including file name) of | 1035 | # be used to specify the location (absolute path including file name) of |
946 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | 1036 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
947 | # the HTML help compiler on the generated index.hhp. | 1037 | # the HTML help compiler on the generated index.hhp. |
948 | 1038 | ||
949 | HHC_LOCATION = | 1039 | HHC_LOCATION = |
950 | 1040 | ||
951 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | 1041 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
952 | # controls if a separate .chi index file is generated (YES) or that | 1042 | # controls if a separate .chi index file is generated (YES) or that |
953 | # it should be included in the master .chm file (NO). | 1043 | # it should be included in the master .chm file (NO). |
954 | 1044 | ||
955 | GENERATE_CHI = NO | 1045 | GENERATE_CHI = NO |
956 | 1046 | ||
957 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | 1047 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
958 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file | 1048 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file |
959 | # content. | 1049 | # content. |
960 | 1050 | ||
961 | CHM_INDEX_ENCODING = | 1051 | CHM_INDEX_ENCODING = |
962 | 1052 | ||
963 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | 1053 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
964 | # controls whether a binary table of contents is generated (YES) or a | 1054 | # controls whether a binary table of contents is generated (YES) or a |
965 | # normal table of contents (NO) in the .chm file. | 1055 | # normal table of contents (NO) in the .chm file. |
966 | 1056 | ||
967 | BINARY_TOC = NO | 1057 | BINARY_TOC = NO |
968 | 1058 | ||
969 | # The TOC_EXPAND flag can be set to YES to add extra items for group members | 1059 | # The TOC_EXPAND flag can be set to YES to add extra items for group members |
970 | # to the contents of the HTML help documentation and to the tree view. | 1060 | # to the contents of the HTML help documentation and to the tree view. |
971 | 1061 | ||
972 | TOC_EXPAND = NO | 1062 | TOC_EXPAND = NO |
973 | 1063 | ||
974 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | 1064 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
975 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated | 1065 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
976 | # that can be used as input for Qt's qhelpgenerator to generate a | 1066 | # that can be used as input for Qt's qhelpgenerator to generate a |
977 | # Qt Compressed Help (.qch) of the generated HTML documentation. | 1067 | # Qt Compressed Help (.qch) of the generated HTML documentation. |
978 | 1068 | ||
979 | GENERATE_QHP = NO | 1069 | GENERATE_QHP = NO |
980 | 1070 | ||
981 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can | 1071 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
982 | # be used to specify the file name of the resulting .qch file. | 1072 | # be used to specify the file name of the resulting .qch file. |
983 | # The path specified is relative to the HTML output folder. | 1073 | # The path specified is relative to the HTML output folder. |
984 | 1074 | ||
985 | QCH_FILE = | 1075 | QCH_FILE = |
986 | 1076 | ||
987 | # The QHP_NAMESPACE tag specifies the namespace to use when generating | 1077 | # The QHP_NAMESPACE tag specifies the namespace to use when generating |
988 | # Qt Help Project output. For more information please see | 1078 | # Qt Help Project output. For more information please see |
989 | # http://doc.trolltech.com/qthelpproject.html#namespace | 1079 | # http://doc.trolltech.com/qthelpproject.html#namespace |
990 | 1080 | ||
991 | QHP_NAMESPACE = org.doxygen.Project | 1081 | QHP_NAMESPACE = org.doxygen.Project |
992 | 1082 | ||
993 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating | 1083 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
994 | # Qt Help Project output. For more information please see | 1084 | # Qt Help Project output. For more information please see |
995 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders | 1085 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders |
996 | 1086 | ||
997 | QHP_VIRTUAL_FOLDER = doc | 1087 | QHP_VIRTUAL_FOLDER = doc |
998 | 1088 | ||
999 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to | 1089 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
1000 | # add. For more information please see | 1090 | # add. For more information please see |
1001 | # http://doc.trolltech.com/qthelpproject.html#custom-filters | 1091 | # http://doc.trolltech.com/qthelpproject.html#custom-filters |
1002 | 1092 | ||
1003 | QHP_CUST_FILTER_NAME = | 1093 | QHP_CUST_FILTER_NAME = |
1004 | 1094 | ||
1005 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the | 1095 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
1006 | # custom filter to add. For more information please see | 1096 | # custom filter to add. For more information please see |
1007 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> | 1097 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
1008 | # Qt Help Project / Custom Filters</a>. | 1098 | # Qt Help Project / Custom Filters</a>. |
1009 | 1099 | ||
1010 | QHP_CUST_FILTER_ATTRS = | 1100 | QHP_CUST_FILTER_ATTRS = |
1011 | 1101 | ||
1012 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | 1102 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1013 | # project's | 1103 | # project's |
1014 | # filter section matches. | 1104 | # filter section matches. |
1015 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> | 1105 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
1016 | # Qt Help Project / Filter Attributes</a>. | 1106 | # Qt Help Project / Filter Attributes</a>. |
1017 | 1107 | ||
1018 | QHP_SECT_FILTER_ATTRS = | 1108 | QHP_SECT_FILTER_ATTRS = |
1019 | 1109 | ||
1020 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can | 1110 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
1021 | # be used to specify the location of Qt's qhelpgenerator. | 1111 | # be used to specify the location of Qt's qhelpgenerator. |
1022 | # If non-empty doxygen will try to run qhelpgenerator on the generated | 1112 | # If non-empty doxygen will try to run qhelpgenerator on the generated |
1023 | # .qhp file. | 1113 | # .qhp file. |
1024 | 1114 | ||
1025 | QHG_LOCATION = | 1115 | QHG_LOCATION = |
1026 | 1116 | ||
1027 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files | 1117 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files |
1028 | # will be generated, which together with the HTML files, form an Eclipse help | 1118 | # will be generated, which together with the HTML files, form an Eclipse help |
1029 | # plugin. To install this plugin and make it available under the help contents | 1119 | # plugin. To install this plugin and make it available under the help contents |
1030 | # menu in Eclipse, the contents of the directory containing the HTML and XML | 1120 | # menu in Eclipse, the contents of the directory containing the HTML and XML |
1031 | # files needs to be copied into the plugins directory of eclipse. The name of | 1121 | # files needs to be copied into the plugins directory of eclipse. The name of |
1032 | # the directory within the plugins directory should be the same as | 1122 | # the directory within the plugins directory should be the same as |
1033 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before | 1123 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
1034 | # the help appears. | 1124 | # the help appears. |
1035 | 1125 | ||
1036 | GENERATE_ECLIPSEHELP = NO | 1126 | GENERATE_ECLIPSEHELP = NO |
1037 | 1127 | ||
1038 | # A unique identifier for the eclipse help plugin. When installing the plugin | 1128 | # A unique identifier for the eclipse help plugin. When installing the plugin |
1039 | # the directory name containing the HTML and XML files should also have | 1129 | # the directory name containing the HTML and XML files should also have |
1040 | # this name. | 1130 | # this name. |
1041 | 1131 | ||
1042 | ECLIPSE_DOC_ID = org.doxygen.Project | 1132 | ECLIPSE_DOC_ID = org.doxygen.Project |
1043 | 1133 | ||
1044 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | 1134 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) |
1045 | # top of each HTML page. The value NO (the default) enables the index and | 1135 | # at top of each HTML page. The value NO (the default) enables the index and |
1046 | # the value YES disables it. | 1136 | # the value YES disables it. Since the tabs have the same information as the |
1047 | 1137 | # navigation tree you can set this option to NO if you already set | |
1048 | DISABLE_INDEX = NO | 1138 | # GENERATE_TREEVIEW to YES. |
1049 | |||
1050 | # This tag can be used to set the number of enum values (range [0,1..20]) | ||
1051 | # that doxygen will group on one line in the generated HTML documentation. | ||
1052 | # Note that a value of 0 will completely suppress the enum values from | ||
1053 | # appearing in the overview section. | ||
1054 | 1139 | ||
1055 | ENUM_VALUES_PER_LINE = 4 | 1140 | DISABLE_INDEX = YES |
1056 | 1141 | ||
1057 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | 1142 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
1058 | # structure should be generated to display hierarchical information. | 1143 | # structure should be generated to display hierarchical information. |
1059 | # If the tag value is set to YES, a side panel will be generated | 1144 | # If the tag value is set to YES, a side panel will be generated |
1060 | # containing a tree-like index structure (just like the one that | 1145 | # containing a tree-like index structure (just like the one that |
1061 | # is generated for HTML Help). For this to work a browser that supports | 1146 | # is generated for HTML Help). For this to work a browser that supports |
1062 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | 1147 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
1063 | # Windows users are probably better off using the HTML help feature. | 1148 | # Windows users are probably better off using the HTML help feature. |
1149 | # Since the tree basically has the same information as the tab index you | ||
1150 | # could consider to set DISABLE_INDEX to NO when enabling this option. | ||
1064 | 1151 | ||
1065 | GENERATE_TREEVIEW = NO | 1152 | GENERATE_TREEVIEW = YES |
1066 | 1153 | ||
1067 | # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, | 1154 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values |
1068 | # and Class Hierarchy pages using a tree view instead of an ordered list. | 1155 | # (range [0,1..20]) that doxygen will group on one line in the generated HTML |
1156 | # documentation. Note that a value of 0 will completely suppress the enum | ||
1157 | # values from appearing in the overview section. | ||
1069 | 1158 | ||
1070 | USE_INLINE_TREES = NO | 1159 | ENUM_VALUES_PER_LINE = 1 |
1071 | 1160 | ||
1072 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | 1161 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
1073 | # used to set the initial width (in pixels) of the frame in which the tree | 1162 | # used to set the initial width (in pixels) of the frame in which the tree |
1074 | # is shown. | 1163 | # is shown. |
1075 | 1164 | ||
1076 | TREEVIEW_WIDTH = 250 | 1165 | TREEVIEW_WIDTH = 250 |
1077 | 1166 | ||
1078 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open | 1167 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open |
1079 | # links to external symbols imported via tag files in a separate window. | 1168 | # links to external symbols imported via tag files in a separate window. |
1080 | 1169 | ||
1081 | EXT_LINKS_IN_WINDOW = NO | 1170 | EXT_LINKS_IN_WINDOW = NO |
1082 | 1171 | ||
1083 | # Use this tag to change the font size of Latex formulas included | 1172 | # Use this tag to change the font size of Latex formulas included |
1084 | # as images in the HTML documentation. The default is 10. Note that | 1173 | # as images in the HTML documentation. The default is 10. Note that |
1085 | # when you change the font size after a successful doxygen run you need | 1174 | # when you change the font size after a successful doxygen run you need |
1086 | # to manually remove any form_*.png images from the HTML output directory | 1175 | # to manually remove any form_*.png images from the HTML output directory |
1087 | # to force them to be regenerated. | 1176 | # to force them to be regenerated. |
1088 | 1177 | ||
1089 | FORMULA_FONTSIZE = 10 | 1178 | FORMULA_FONTSIZE = 10 |
1090 | 1179 | ||
1091 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images | 1180 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images |
1092 | # generated for formulas are transparent PNGs. Transparent PNGs are | 1181 | # generated for formulas are transparent PNGs. Transparent PNGs are |
1093 | # not supported properly for IE 6.0, but are supported on all modern browsers. | 1182 | # not supported properly for IE 6.0, but are supported on all modern browsers. |
1094 | # Note that when changing this option you need to delete any form_*.png files | 1183 | # Note that when changing this option you need to delete any form_*.png files |
1095 | # in the HTML output before the changes have effect. | 1184 | # in the HTML output before the changes have effect. |
1096 | 1185 | ||
1097 | FORMULA_TRANSPARENT = YES | 1186 | FORMULA_TRANSPARENT = YES |
1098 | 1187 | ||
1099 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax | 1188 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax |
1100 | # (see http://www.mathjax.org) which uses client side Javascript for the | 1189 | # (see http://www.mathjax.org) which uses client side Javascript for the |
1101 | # rendering instead of using prerendered bitmaps. Use this if you do not | 1190 | # rendering instead of using prerendered bitmaps. Use this if you do not |
1102 | # have LaTeX installed or if you want to formulas look prettier in the HTML | 1191 | # have LaTeX installed or if you want to formulas look prettier in the HTML |
1103 | # output. When enabled you also need to install MathJax separately and | 1192 | # output. When enabled you may also need to install MathJax separately and |
1104 | # configure the path to it using the MATHJAX_RELPATH option. | 1193 | # configure the path to it using the MATHJAX_RELPATH option. |
1105 | 1194 | ||
1106 | USE_MATHJAX = NO | 1195 | USE_MATHJAX = NO |
1107 | 1196 | ||
1108 | # When MathJax is enabled you need to specify the location relative to the | 1197 | # When MathJax is enabled you need to specify the location relative to the |
1109 | # HTML output directory using the MATHJAX_RELPATH option. The destination | 1198 | # HTML output directory using the MATHJAX_RELPATH option. The destination |
1110 | # directory should contain the MathJax.js script. For instance, if the mathjax | 1199 | # directory should contain the MathJax.js script. For instance, if the mathjax |
1111 | # directory is located at the same level as the HTML output directory, then | 1200 | # directory is located at the same level as the HTML output directory, then |
1112 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the | 1201 | # MATHJAX_RELPATH should be ../mathjax. The default value points to |
1113 | # mathjax.org site, so you can quickly see the result without installing | 1202 | # the MathJax Content Delivery Network so you can quickly see the result without |
1114 | # MathJax, but it is strongly recommended to install a local copy of MathJax | 1203 | # installing MathJax. |
1115 | # before deployment. | 1204 | # However, it is strongly recommended to install a local |
1205 | # copy of MathJax from http://www.mathjax.org before deployment. | ||
1116 | 1206 | ||
1117 | MATHJAX_RELPATH = http://www.mathjax.org/mathjax | 1207 | MATHJAX_RELPATH = http://www.mathjax.org/mathjax |
1118 | 1208 | ||
1119 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box | 1209 | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension |
1120 | # for the HTML output. The underlying search engine uses javascript | 1210 | # names that should be enabled during MathJax rendering. |
1121 | # and DHTML and should work on any modern browser. Note that when using | 1211 | |
1122 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | 1212 | MATHJAX_EXTENSIONS = |
1123 | # (GENERATE_DOCSET) there is already a search function so this one should | 1213 | |
1124 | # typically be disabled. For large projects the javascript based search engine | 1214 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box |
1215 | # for the HTML output. The underlying search engine uses javascript | ||
1216 | # and DHTML and should work on any modern browser. Note that when using | ||
1217 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | ||
1218 | # (GENERATE_DOCSET) there is already a search function so this one should | ||
1219 | # typically be disabled. For large projects the javascript based search engine | ||
1125 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. | 1220 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
1126 | 1221 | ||
1127 | SEARCHENGINE = YES | 1222 | SEARCHENGINE = NO |
1128 | 1223 | ||
1129 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | 1224 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
1130 | # implemented using a PHP enabled web server instead of at the web client | 1225 | # implemented using a PHP enabled web server instead of at the web client |
1131 | # using Javascript. Doxygen will generate the search PHP script and index | 1226 | # using Javascript. Doxygen will generate the search PHP script and index |
1132 | # file to put on the web server. The advantage of the server | 1227 | # file to put on the web server. The advantage of the server |
1133 | # based approach is that it scales better to large projects and allows | 1228 | # based approach is that it scales better to large projects and allows |
1134 | # full text search. The disadvantages are that it is more difficult to setup | 1229 | # full text search. The disadvantages are that it is more difficult to setup |
1135 | # and does not have live searching capabilities. | 1230 | # and does not have live searching capabilities. |
1136 | 1231 | ||
1137 | SERVER_BASED_SEARCH = NO | 1232 | SERVER_BASED_SEARCH = NO |
@@ -1140,189 +1235,202 @@ SERVER_BASED_SEARCH = NO | |||
1140 | # configuration options related to the LaTeX output | 1235 | # configuration options related to the LaTeX output |
1141 | #--------------------------------------------------------------------------- | 1236 | #--------------------------------------------------------------------------- |
1142 | 1237 | ||
1143 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | 1238 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
1144 | # generate Latex output. | 1239 | # generate Latex output. |
1145 | 1240 | ||
1146 | GENERATE_LATEX = YES | 1241 | GENERATE_LATEX = YES |
1147 | 1242 | ||
1148 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | 1243 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
1149 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 1244 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1150 | # put in front of it. If left blank `latex' will be used as the default path. | 1245 | # put in front of it. If left blank `latex' will be used as the default path. |
1151 | 1246 | ||
1152 | LATEX_OUTPUT = latex | 1247 | LATEX_OUTPUT = latex |
1153 | 1248 | ||
1154 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | 1249 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
1155 | # invoked. If left blank `latex' will be used as the default command name. | 1250 | # invoked. If left blank `latex' will be used as the default command name. |
1156 | # Note that when enabling USE_PDFLATEX this option is only used for | 1251 | # Note that when enabling USE_PDFLATEX this option is only used for |
1157 | # generating bitmaps for formulas in the HTML output, but not in the | 1252 | # generating bitmaps for formulas in the HTML output, but not in the |
1158 | # Makefile that is written to the output directory. | 1253 | # Makefile that is written to the output directory. |
1159 | 1254 | ||
1160 | LATEX_CMD_NAME = latex | 1255 | LATEX_CMD_NAME = latex |
1161 | 1256 | ||
1162 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | 1257 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
1163 | # generate index for LaTeX. If left blank `makeindex' will be used as the | 1258 | # generate index for LaTeX. If left blank `makeindex' will be used as the |
1164 | # default command name. | 1259 | # default command name. |
1165 | 1260 | ||
1166 | MAKEINDEX_CMD_NAME = makeindex | 1261 | MAKEINDEX_CMD_NAME = makeindex |
1167 | 1262 | ||
1168 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | 1263 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
1169 | # LaTeX documents. This may be useful for small projects and may help to | 1264 | # LaTeX documents. This may be useful for small projects and may help to |
1170 | # save some trees in general. | 1265 | # save some trees in general. |
1171 | 1266 | ||
1172 | COMPACT_LATEX = NO | 1267 | COMPACT_LATEX = NO |
1173 | 1268 | ||
1174 | # The PAPER_TYPE tag can be used to set the paper type that is used | 1269 | # The PAPER_TYPE tag can be used to set the paper type that is used |
1175 | # by the printer. Possible values are: a4, letter, legal and | 1270 | # by the printer. Possible values are: a4, letter, legal and |
1176 | # executive. If left blank a4wide will be used. | 1271 | # executive. If left blank a4wide will be used. |
1177 | 1272 | ||
1178 | PAPER_TYPE = a4 | 1273 | PAPER_TYPE = a4wide |
1179 | 1274 | ||
1180 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | 1275 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
1181 | # packages that should be included in the LaTeX output. | 1276 | # packages that should be included in the LaTeX output. |
1182 | 1277 | ||
1183 | EXTRA_PACKAGES = | 1278 | EXTRA_PACKAGES = |
1184 | 1279 | ||
1185 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | 1280 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
1186 | # the generated latex document. The header should contain everything until | 1281 | # the generated latex document. The header should contain everything until |
1187 | # the first chapter. If it is left blank doxygen will generate a | 1282 | # the first chapter. If it is left blank doxygen will generate a |
1188 | # standard header. Notice: only use this tag if you know what you are doing! | 1283 | # standard header. Notice: only use this tag if you know what you are doing! |
1189 | 1284 | ||
1190 | LATEX_HEADER = | 1285 | LATEX_HEADER = |
1286 | |||
1287 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for | ||
1288 | # the generated latex document. The footer should contain everything after | ||
1289 | # the last chapter. If it is left blank doxygen will generate a | ||
1290 | # standard footer. Notice: only use this tag if you know what you are doing! | ||
1191 | 1291 | ||
1192 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | 1292 | LATEX_FOOTER = |
1193 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | 1293 | |
1194 | # contain links (just like the HTML output) instead of page references | 1294 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
1295 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | ||
1296 | # contain links (just like the HTML output) instead of page references | ||
1195 | # This makes the output suitable for online browsing using a pdf viewer. | 1297 | # This makes the output suitable for online browsing using a pdf viewer. |
1196 | 1298 | ||
1197 | PDF_HYPERLINKS = YES | 1299 | PDF_HYPERLINKS = YES |
1198 | 1300 | ||
1199 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | 1301 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
1200 | # plain latex in the generated Makefile. Set this option to YES to get a | 1302 | # plain latex in the generated Makefile. Set this option to YES to get a |
1201 | # higher quality PDF documentation. | 1303 | # higher quality PDF documentation. |
1202 | 1304 | ||
1203 | USE_PDFLATEX = YES | 1305 | USE_PDFLATEX = NO |
1204 | 1306 | ||
1205 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | 1307 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
1206 | # command to the generated LaTeX files. This will instruct LaTeX to keep | 1308 | # command to the generated LaTeX files. This will instruct LaTeX to keep |
1207 | # running if errors occur, instead of asking the user for help. | 1309 | # running if errors occur, instead of asking the user for help. |
1208 | # This option is also used when generating formulas in HTML. | 1310 | # This option is also used when generating formulas in HTML. |
1209 | 1311 | ||
1210 | LATEX_BATCHMODE = NO | 1312 | LATEX_BATCHMODE = NO |
1211 | 1313 | ||
1212 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not | 1314 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
1213 | # include the index chapters (such as File Index, Compound Index, etc.) | 1315 | # include the index chapters (such as File Index, Compound Index, etc.) |
1214 | # in the output. | 1316 | # in the output. |
1215 | 1317 | ||
1216 | LATEX_HIDE_INDICES = NO | 1318 | LATEX_HIDE_INDICES = NO |
1217 | 1319 | ||
1218 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include | 1320 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include |
1219 | # source code with syntax highlighting in the LaTeX output. | 1321 | # source code with syntax highlighting in the LaTeX output. |
1220 | # Note that which sources are shown also depends on other settings | 1322 | # Note that which sources are shown also depends on other settings |
1221 | # such as SOURCE_BROWSER. | 1323 | # such as SOURCE_BROWSER. |
1222 | 1324 | ||
1223 | LATEX_SOURCE_CODE = NO | 1325 | LATEX_SOURCE_CODE = NO |
1224 | 1326 | ||
1327 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the | ||
1328 | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See | ||
1329 | # http://en.wikipedia.org/wiki/BibTeX for more info. | ||
1330 | |||
1331 | LATEX_BIB_STYLE = plain | ||
1332 | |||
1225 | #--------------------------------------------------------------------------- | 1333 | #--------------------------------------------------------------------------- |
1226 | # configuration options related to the RTF output | 1334 | # configuration options related to the RTF output |
1227 | #--------------------------------------------------------------------------- | 1335 | #--------------------------------------------------------------------------- |
1228 | 1336 | ||
1229 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | 1337 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
1230 | # The RTF output is optimized for Word 97 and may not look very pretty with | 1338 | # The RTF output is optimized for Word 97 and may not look very pretty with |
1231 | # other RTF readers or editors. | 1339 | # other RTF readers or editors. |
1232 | 1340 | ||
1233 | GENERATE_RTF = NO | 1341 | GENERATE_RTF = NO |
1234 | 1342 | ||
1235 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | 1343 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
1236 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 1344 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1237 | # put in front of it. If left blank `rtf' will be used as the default path. | 1345 | # put in front of it. If left blank `rtf' will be used as the default path. |
1238 | 1346 | ||
1239 | RTF_OUTPUT = rtf | 1347 | RTF_OUTPUT = rtf |
1240 | 1348 | ||
1241 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | 1349 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
1242 | # RTF documents. This may be useful for small projects and may help to | 1350 | # RTF documents. This may be useful for small projects and may help to |
1243 | # save some trees in general. | 1351 | # save some trees in general. |
1244 | 1352 | ||
1245 | COMPACT_RTF = NO | 1353 | COMPACT_RTF = NO |
1246 | 1354 | ||
1247 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | 1355 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
1248 | # will contain hyperlink fields. The RTF file will | 1356 | # will contain hyperlink fields. The RTF file will |
1249 | # contain links (just like the HTML output) instead of page references. | 1357 | # contain links (just like the HTML output) instead of page references. |
1250 | # This makes the output suitable for online browsing using WORD or other | 1358 | # This makes the output suitable for online browsing using WORD or other |
1251 | # programs which support those fields. | 1359 | # programs which support those fields. |
1252 | # Note: wordpad (write) and others do not support links. | 1360 | # Note: wordpad (write) and others do not support links. |
1253 | 1361 | ||
1254 | RTF_HYPERLINKS = NO | 1362 | RTF_HYPERLINKS = NO |
1255 | 1363 | ||
1256 | # Load stylesheet definitions from file. Syntax is similar to doxygen's | 1364 | # Load style sheet definitions from file. Syntax is similar to doxygen's |
1257 | # config file, i.e. a series of assignments. You only have to provide | 1365 | # config file, i.e. a series of assignments. You only have to provide |
1258 | # replacements, missing definitions are set to their default value. | 1366 | # replacements, missing definitions are set to their default value. |
1259 | 1367 | ||
1260 | RTF_STYLESHEET_FILE = | 1368 | RTF_STYLESHEET_FILE = |
1261 | 1369 | ||
1262 | # Set optional variables used in the generation of an rtf document. | 1370 | # Set optional variables used in the generation of an rtf document. |
1263 | # Syntax is similar to doxygen's config file. | 1371 | # Syntax is similar to doxygen's config file. |
1264 | 1372 | ||
1265 | RTF_EXTENSIONS_FILE = | 1373 | RTF_EXTENSIONS_FILE = |
1266 | 1374 | ||
1267 | #--------------------------------------------------------------------------- | 1375 | #--------------------------------------------------------------------------- |
1268 | # configuration options related to the man page output | 1376 | # configuration options related to the man page output |
1269 | #--------------------------------------------------------------------------- | 1377 | #--------------------------------------------------------------------------- |
1270 | 1378 | ||
1271 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | 1379 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
1272 | # generate man pages | 1380 | # generate man pages |
1273 | 1381 | ||
1274 | GENERATE_MAN = NO | 1382 | GENERATE_MAN = YES |
1275 | 1383 | ||
1276 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | 1384 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
1277 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 1385 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1278 | # put in front of it. If left blank `man' will be used as the default path. | 1386 | # put in front of it. If left blank `man' will be used as the default path. |
1279 | 1387 | ||
1280 | MAN_OUTPUT = man | 1388 | MAN_OUTPUT = man |
1281 | 1389 | ||
1282 | # The MAN_EXTENSION tag determines the extension that is added to | 1390 | # The MAN_EXTENSION tag determines the extension that is added to |
1283 | # the generated man pages (default is the subroutine's section .3) | 1391 | # the generated man pages (default is the subroutine's section .3) |
1284 | 1392 | ||
1285 | MAN_EXTENSION = .3 | 1393 | MAN_EXTENSION = .3 |
1286 | 1394 | ||
1287 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | 1395 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
1288 | # then it will generate one additional man file for each entity | 1396 | # then it will generate one additional man file for each entity |
1289 | # documented in the real man page(s). These additional files | 1397 | # documented in the real man page(s). These additional files |
1290 | # only source the real man page, but without them the man command | 1398 | # only source the real man page, but without them the man command |
1291 | # would be unable to find the correct page. The default is NO. | 1399 | # would be unable to find the correct page. The default is NO. |
1292 | 1400 | ||
1293 | MAN_LINKS = NO | 1401 | MAN_LINKS = YES |
1294 | 1402 | ||
1295 | #--------------------------------------------------------------------------- | 1403 | #--------------------------------------------------------------------------- |
1296 | # configuration options related to the XML output | 1404 | # configuration options related to the XML output |
1297 | #--------------------------------------------------------------------------- | 1405 | #--------------------------------------------------------------------------- |
1298 | 1406 | ||
1299 | # If the GENERATE_XML tag is set to YES Doxygen will | 1407 | # If the GENERATE_XML tag is set to YES Doxygen will |
1300 | # generate an XML file that captures the structure of | 1408 | # generate an XML file that captures the structure of |
1301 | # the code including all documentation. | 1409 | # the code including all documentation. |
1302 | 1410 | ||
1303 | GENERATE_XML = NO | 1411 | GENERATE_XML = NO |
1304 | 1412 | ||
1305 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. | 1413 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
1306 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 1414 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1307 | # put in front of it. If left blank `xml' will be used as the default path. | 1415 | # put in front of it. If left blank `xml' will be used as the default path. |
1308 | 1416 | ||
1309 | XML_OUTPUT = xml | 1417 | XML_OUTPUT = xml |
1310 | 1418 | ||
1311 | # The XML_SCHEMA tag can be used to specify an XML schema, | 1419 | # The XML_SCHEMA tag can be used to specify an XML schema, |
1312 | # which can be used by a validating XML parser to check the | 1420 | # which can be used by a validating XML parser to check the |
1313 | # syntax of the XML files. | 1421 | # syntax of the XML files. |
1314 | 1422 | ||
1315 | XML_SCHEMA = | 1423 | XML_SCHEMA = |
1316 | 1424 | ||
1317 | # The XML_DTD tag can be used to specify an XML DTD, | 1425 | # The XML_DTD tag can be used to specify an XML DTD, |
1318 | # which can be used by a validating XML parser to check the | 1426 | # which can be used by a validating XML parser to check the |
1319 | # syntax of the XML files. | 1427 | # syntax of the XML files. |
1320 | 1428 | ||
1321 | XML_DTD = | 1429 | XML_DTD = |
1322 | 1430 | ||
1323 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will | 1431 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
1324 | # dump the program listings (including syntax highlighting | 1432 | # dump the program listings (including syntax highlighting |
1325 | # and cross-referencing information) to the XML output. Note that | 1433 | # and cross-referencing information) to the XML output. Note that |
1326 | # enabling this will significantly increase the size of the XML output. | 1434 | # enabling this will significantly increase the size of the XML output. |
1327 | 1435 | ||
1328 | XML_PROGRAMLISTING = YES | 1436 | XML_PROGRAMLISTING = YES |
@@ -1331,10 +1439,10 @@ XML_PROGRAMLISTING = YES | |||
1331 | # configuration options for the AutoGen Definitions output | 1439 | # configuration options for the AutoGen Definitions output |
1332 | #--------------------------------------------------------------------------- | 1440 | #--------------------------------------------------------------------------- |
1333 | 1441 | ||
1334 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | 1442 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1335 | # generate an AutoGen Definitions (see autogen.sf.net) file | 1443 | # generate an AutoGen Definitions (see autogen.sf.net) file |
1336 | # that captures the structure of the code including all | 1444 | # that captures the structure of the code including all |
1337 | # documentation. Note that this feature is still experimental | 1445 | # documentation. Note that this feature is still experimental |
1338 | # and incomplete at the moment. | 1446 | # and incomplete at the moment. |
1339 | 1447 | ||
1340 | GENERATE_AUTOGEN_DEF = NO | 1448 | GENERATE_AUTOGEN_DEF = NO |
@@ -1343,98 +1451,100 @@ GENERATE_AUTOGEN_DEF = NO | |||
1343 | # configuration options related to the Perl module output | 1451 | # configuration options related to the Perl module output |
1344 | #--------------------------------------------------------------------------- | 1452 | #--------------------------------------------------------------------------- |
1345 | 1453 | ||
1346 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will | 1454 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will |
1347 | # generate a Perl module file that captures the structure of | 1455 | # generate a Perl module file that captures the structure of |
1348 | # the code including all documentation. Note that this | 1456 | # the code including all documentation. Note that this |
1349 | # feature is still experimental and incomplete at the | 1457 | # feature is still experimental and incomplete at the |
1350 | # moment. | 1458 | # moment. |
1351 | 1459 | ||
1352 | GENERATE_PERLMOD = NO | 1460 | GENERATE_PERLMOD = NO |
1353 | 1461 | ||
1354 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | 1462 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
1355 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able | 1463 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able |
1356 | # to generate PDF and DVI output from the Perl module output. | 1464 | # to generate PDF and DVI output from the Perl module output. |
1357 | 1465 | ||
1358 | PERLMOD_LATEX = NO | 1466 | PERLMOD_LATEX = NO |
1359 | 1467 | ||
1360 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | 1468 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
1361 | # nicely formatted so it can be parsed by a human reader. This is useful | 1469 | # nicely formatted so it can be parsed by a human reader. |
1362 | # if you want to understand what is going on. On the other hand, if this | 1470 | # This is useful |
1363 | # tag is set to NO the size of the Perl module output will be much smaller | 1471 | # if you want to understand what is going on. |
1472 | # On the other hand, if this | ||
1473 | # tag is set to NO the size of the Perl module output will be much smaller | ||
1364 | # and Perl will parse it just the same. | 1474 | # and Perl will parse it just the same. |
1365 | 1475 | ||
1366 | PERLMOD_PRETTY = YES | 1476 | PERLMOD_PRETTY = YES |
1367 | 1477 | ||
1368 | # The names of the make variables in the generated doxyrules.make file | 1478 | # The names of the make variables in the generated doxyrules.make file |
1369 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | 1479 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
1370 | # This is useful so different doxyrules.make files included by the same | 1480 | # This is useful so different doxyrules.make files included by the same |
1371 | # Makefile don't overwrite each other's variables. | 1481 | # Makefile don't overwrite each other's variables. |
1372 | 1482 | ||
1373 | PERLMOD_MAKEVAR_PREFIX = | 1483 | PERLMOD_MAKEVAR_PREFIX = |
1374 | 1484 | ||
1375 | #--------------------------------------------------------------------------- | 1485 | #--------------------------------------------------------------------------- |
1376 | # Configuration options related to the preprocessor | 1486 | # Configuration options related to the preprocessor |
1377 | #--------------------------------------------------------------------------- | 1487 | #--------------------------------------------------------------------------- |
1378 | 1488 | ||
1379 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | 1489 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
1380 | # evaluate all C-preprocessor directives found in the sources and include | 1490 | # evaluate all C-preprocessor directives found in the sources and include |
1381 | # files. | 1491 | # files. |
1382 | 1492 | ||
1383 | ENABLE_PREPROCESSING = YES | 1493 | ENABLE_PREPROCESSING = YES |
1384 | 1494 | ||
1385 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | 1495 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1386 | # names in the source code. If set to NO (the default) only conditional | 1496 | # names in the source code. If set to NO (the default) only conditional |
1387 | # compilation will be performed. Macro expansion can be done in a controlled | 1497 | # compilation will be performed. Macro expansion can be done in a controlled |
1388 | # way by setting EXPAND_ONLY_PREDEF to YES. | 1498 | # way by setting EXPAND_ONLY_PREDEF to YES. |
1389 | 1499 | ||
1390 | MACRO_EXPANSION = NO | 1500 | MACRO_EXPANSION = YES |
1391 | 1501 | ||
1392 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | 1502 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
1393 | # then the macro expansion is limited to the macros specified with the | 1503 | # then the macro expansion is limited to the macros specified with the |
1394 | # PREDEFINED and EXPAND_AS_DEFINED tags. | 1504 | # PREDEFINED and EXPAND_AS_DEFINED tags. |
1395 | 1505 | ||
1396 | EXPAND_ONLY_PREDEF = NO | 1506 | EXPAND_ONLY_PREDEF = YES |
1397 | 1507 | ||
1398 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | 1508 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
1399 | # in the INCLUDE_PATH (see below) will be search if a #include is found. | 1509 | # pointed to by INCLUDE_PATH will be searched when a #include is found. |
1400 | 1510 | ||
1401 | SEARCH_INCLUDES = YES | 1511 | SEARCH_INCLUDES = NO |
1402 | 1512 | ||
1403 | # The INCLUDE_PATH tag can be used to specify one or more directories that | 1513 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
1404 | # contain include files that are not input files but should be processed by | 1514 | # contain include files that are not input files but should be processed by |
1405 | # the preprocessor. | 1515 | # the preprocessor. |
1406 | 1516 | ||
1407 | INCLUDE_PATH = | 1517 | INCLUDE_PATH = |
1408 | 1518 | ||
1409 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | 1519 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
1410 | # patterns (like *.h and *.hpp) to filter out the header-files in the | 1520 | # patterns (like *.h and *.hpp) to filter out the header-files in the |
1411 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | 1521 | # directories. If left blank, the patterns specified with FILE_PATTERNS will |
1412 | # be used. | 1522 | # be used. |
1413 | 1523 | ||
1414 | INCLUDE_FILE_PATTERNS = | 1524 | INCLUDE_FILE_PATTERNS = |
1415 | 1525 | ||
1416 | # The PREDEFINED tag can be used to specify one or more macro names that | 1526 | # The PREDEFINED tag can be used to specify one or more macro names that |
1417 | # are defined before the preprocessor is started (similar to the -D option of | 1527 | # are defined before the preprocessor is started (similar to the -D option of |
1418 | # gcc). The argument of the tag is a list of macros of the form: name | 1528 | # gcc). The argument of the tag is a list of macros of the form: name |
1419 | # or name=definition (no spaces). If the definition and the = are | 1529 | # or name=definition (no spaces). If the definition and the = are |
1420 | # omitted =1 is assumed. To prevent a macro definition from being | 1530 | # omitted =1 is assumed. To prevent a macro definition from being |
1421 | # undefined via #undef or recursively expanded use the := operator | 1531 | # undefined via #undef or recursively expanded use the := operator |
1422 | # instead of the = operator. | 1532 | # instead of the = operator. |
1423 | 1533 | ||
1424 | PREDEFINED = | 1534 | PREDEFINED = __UNUSED__= |
1425 | 1535 | ||
1426 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | 1536 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
1427 | # this tag can be used to specify a list of macro names that should be expanded. | 1537 | # this tag can be used to specify a list of macro names that should be expanded. |
1428 | # The macro definition that is found in the sources will be used. | 1538 | # The macro definition that is found in the sources will be used. |
1429 | # Use the PREDEFINED tag if you want to use a different macro definition. | 1539 | # Use the PREDEFINED tag if you want to use a different macro definition that |
1540 | # overrules the definition found in the source code. | ||
1430 | 1541 | ||
1431 | EXPAND_AS_DEFINED = | 1542 | EXPAND_AS_DEFINED = |
1432 | 1543 | ||
1433 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | 1544 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
1434 | # doxygen's preprocessor will remove all function-like macros that are alone | 1545 | # doxygen's preprocessor will remove all references to function-like macros |
1435 | # on a line, have an all uppercase name, and do not end with a semicolon. Such | 1546 | # that are alone on a line, have an all uppercase name, and do not end with a |
1436 | # function macros are typically used for boiler-plate code, and will confuse | 1547 | # semicolon, because these will confuse the parser if not removed. |
1437 | # the parser if not removed. | ||
1438 | 1548 | ||
1439 | SKIP_FUNCTION_MACROS = YES | 1549 | SKIP_FUNCTION_MACROS = YES |
1440 | 1550 | ||
@@ -1442,41 +1552,39 @@ SKIP_FUNCTION_MACROS = YES | |||
1442 | # Configuration::additions related to external references | 1552 | # Configuration::additions related to external references |
1443 | #--------------------------------------------------------------------------- | 1553 | #--------------------------------------------------------------------------- |
1444 | 1554 | ||
1445 | # The TAGFILES option can be used to specify one or more tagfiles. | 1555 | # The TAGFILES option can be used to specify one or more tagfiles. For each |
1446 | # Optionally an initial location of the external documentation | 1556 | # tag file the location of the external documentation should be added. The |
1447 | # can be added for each tagfile. The format of a tag file without | 1557 | # format of a tag file without this location is as follows: |
1448 | # this location is as follows: | 1558 | # |
1449 | # TAGFILES = file1 file2 ... | 1559 | # TAGFILES = file1 file2 ... |
1450 | # Adding location for the tag files is done as follows: | 1560 | # Adding location for the tag files is done as follows: |
1451 | # TAGFILES = file1=loc1 "file2 = loc2" ... | 1561 | # |
1452 | # where "loc1" and "loc2" can be relative or absolute paths or | 1562 | # TAGFILES = file1=loc1 "file2 = loc2" ... |
1453 | # URLs. If a location is present for each tag, the installdox tool | 1563 | # where "loc1" and "loc2" can be relative or absolute paths |
1454 | # does not have to be run to correct the links. | 1564 | # or URLs. Note that each tag file must have a unique name (where the name does |
1455 | # Note that each tag file must have a unique name | 1565 | # NOT include the path). If a tag file is not located in the directory in which |
1456 | # (where the name does NOT include the path) | 1566 | # doxygen is run, you must also specify the path to the tagfile here. |
1457 | # If a tag file is not located in the directory in which doxygen | 1567 | |
1458 | # is run, you must also specify the path to the tagfile here. | 1568 | TAGFILES = |
1459 | 1569 | ||
1460 | TAGFILES = | 1570 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
1461 | |||
1462 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | ||
1463 | # a tag file that is based on the input files it reads. | 1571 | # a tag file that is based on the input files it reads. |
1464 | 1572 | ||
1465 | GENERATE_TAGFILE = | 1573 | GENERATE_TAGFILE = |
1466 | 1574 | ||
1467 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | 1575 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
1468 | # in the class index. If set to NO only the inherited external classes | 1576 | # in the class index. If set to NO only the inherited external classes |
1469 | # will be listed. | 1577 | # will be listed. |
1470 | 1578 | ||
1471 | ALLEXTERNALS = NO | 1579 | ALLEXTERNALS = NO |
1472 | 1580 | ||
1473 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | 1581 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
1474 | # in the modules index. If set to NO, only the current project's groups will | 1582 | # in the modules index. If set to NO, only the current project's groups will |
1475 | # be listed. | 1583 | # be listed. |
1476 | 1584 | ||
1477 | EXTERNAL_GROUPS = YES | 1585 | EXTERNAL_GROUPS = YES |
1478 | 1586 | ||
1479 | # The PERL_PATH should be the absolute path and name of the perl script | 1587 | # The PERL_PATH should be the absolute path and name of the perl script |
1480 | # interpreter (i.e. the result of `which perl'). | 1588 | # interpreter (i.e. the result of `which perl'). |
1481 | 1589 | ||
1482 | PERL_PATH = /usr/bin/perl | 1590 | PERL_PATH = /usr/bin/perl |
@@ -1485,205 +1593,225 @@ PERL_PATH = /usr/bin/perl | |||
1485 | # Configuration options related to the dot tool | 1593 | # Configuration options related to the dot tool |
1486 | #--------------------------------------------------------------------------- | 1594 | #--------------------------------------------------------------------------- |
1487 | 1595 | ||
1488 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | 1596 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1489 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | 1597 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1490 | # or super classes. Setting the tag to NO turns the diagrams off. Note that | 1598 | # or super classes. Setting the tag to NO turns the diagrams off. Note that |
1491 | # this option also works with HAVE_DOT disabled, but it is recommended to | 1599 | # this option also works with HAVE_DOT disabled, but it is recommended to |
1492 | # install and use dot, since it yields more powerful graphs. | 1600 | # install and use dot, since it yields more powerful graphs. |
1493 | 1601 | ||
1494 | CLASS_DIAGRAMS = YES | 1602 | CLASS_DIAGRAMS = NO |
1495 | 1603 | ||
1496 | # You can define message sequence charts within doxygen comments using the \msc | 1604 | # You can define message sequence charts within doxygen comments using the \msc |
1497 | # command. Doxygen will then run the mscgen tool (see | 1605 | # command. Doxygen will then run the mscgen tool (see |
1498 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | 1606 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
1499 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | 1607 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
1500 | # the mscgen tool resides. If left empty the tool is assumed to be found in the | 1608 | # the mscgen tool resides. If left empty the tool is assumed to be found in the |
1501 | # default search path. | 1609 | # default search path. |
1502 | 1610 | ||
1503 | MSCGEN_PATH = | 1611 | MSCGEN_PATH = |
1504 | 1612 | ||
1505 | # If set to YES, the inheritance and collaboration graphs will hide | 1613 | # If set to YES, the inheritance and collaboration graphs will hide |
1506 | # inheritance and usage relations if the target is undocumented | 1614 | # inheritance and usage relations if the target is undocumented |
1507 | # or is not a class. | 1615 | # or is not a class. |
1508 | 1616 | ||
1509 | HIDE_UNDOC_RELATIONS = YES | 1617 | HIDE_UNDOC_RELATIONS = YES |
1510 | 1618 | ||
1511 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | 1619 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
1512 | # available from the path. This tool is part of Graphviz, a graph visualization | 1620 | # available from the path. This tool is part of Graphviz, a graph visualization |
1513 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | 1621 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
1514 | # have no effect if this option is set to NO (the default) | 1622 | # have no effect if this option is set to NO (the default) |
1515 | 1623 | ||
1516 | HAVE_DOT = NO | 1624 | HAVE_DOT = YES |
1517 | 1625 | ||
1518 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | 1626 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
1519 | # allowed to run in parallel. When set to 0 (the default) doxygen will | 1627 | # allowed to run in parallel. When set to 0 (the default) doxygen will |
1520 | # base this on the number of processors available in the system. You can set it | 1628 | # base this on the number of processors available in the system. You can set it |
1521 | # explicitly to a value larger than 0 to get control over the balance | 1629 | # explicitly to a value larger than 0 to get control over the balance |
1522 | # between CPU load and processing speed. | 1630 | # between CPU load and processing speed. |
1523 | 1631 | ||
1524 | DOT_NUM_THREADS = 0 | 1632 | DOT_NUM_THREADS = 2 |
1525 | 1633 | ||
1526 | # By default doxygen will write a font called FreeSans.ttf to the output | 1634 | # By default doxygen will use the Helvetica font for all dot files that |
1527 | # directory and reference it in all dot files that doxygen generates. This | 1635 | # doxygen generates. When you want a differently looking font you can specify |
1528 | # font does not include all possible unicode characters however, so when you need | 1636 | # the font name using DOT_FONTNAME. You need to make sure dot is able to find |
1529 | # these (or just want a differently looking font) you can specify the font name | 1637 | # the font, which can be done by putting it in a standard location or by setting |
1530 | # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | 1638 | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the |
1531 | # which can be done by putting it in a standard location or by setting the | 1639 | # directory containing the font. |
1532 | # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | ||
1533 | # containing the font. | ||
1534 | 1640 | ||
1535 | DOT_FONTNAME = FreeSans.ttf | 1641 | DOT_FONTNAME = FreeSans.ttf |
1536 | 1642 | ||
1537 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | 1643 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
1538 | # The default size is 10pt. | 1644 | # The default size is 10pt. |
1539 | 1645 | ||
1540 | DOT_FONTSIZE = 10 | 1646 | DOT_FONTSIZE = 10 |
1541 | 1647 | ||
1542 | # By default doxygen will tell dot to use the output directory to look for the | 1648 | # By default doxygen will tell dot to use the Helvetica font. |
1543 | # FreeSans.ttf font (which doxygen will put there itself). If you specify a | 1649 | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to |
1544 | # different font using DOT_FONTNAME you can set the path where dot | 1650 | # set the path where dot can find it. |
1545 | # can find it using this tag. | ||
1546 | 1651 | ||
1547 | DOT_FONTPATH = | 1652 | DOT_FONTPATH = |
1548 | 1653 | ||
1549 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | 1654 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1550 | # will generate a graph for each documented class showing the direct and | 1655 | # will generate a graph for each documented class showing the direct and |
1551 | # indirect inheritance relations. Setting this tag to YES will force the | 1656 | # indirect inheritance relations. Setting this tag to YES will force the |
1552 | # the CLASS_DIAGRAMS tag to NO. | 1657 | # CLASS_DIAGRAMS tag to NO. |
1553 | 1658 | ||
1554 | CLASS_GRAPH = YES | 1659 | CLASS_GRAPH = NO |
1555 | 1660 | ||
1556 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | 1661 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1557 | # will generate a graph for each documented class showing the direct and | 1662 | # will generate a graph for each documented class showing the direct and |
1558 | # indirect implementation dependencies (inheritance, containment, and | 1663 | # indirect implementation dependencies (inheritance, containment, and |
1559 | # class references variables) of the class with other documented classes. | 1664 | # class references variables) of the class with other documented classes. |
1560 | 1665 | ||
1561 | COLLABORATION_GRAPH = YES | 1666 | COLLABORATION_GRAPH = NO |
1562 | 1667 | ||
1563 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | 1668 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1564 | # will generate a graph for groups, showing the direct groups dependencies | 1669 | # will generate a graph for groups, showing the direct groups dependencies |
1565 | 1670 | ||
1566 | GROUP_GRAPHS = YES | 1671 | GROUP_GRAPHS = NO |
1567 | 1672 | ||
1568 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | 1673 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1569 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | 1674 | # collaboration diagrams in a style similar to the OMG's Unified Modeling |
1570 | # Language. | 1675 | # Language. |
1571 | 1676 | ||
1572 | UML_LOOK = NO | 1677 | UML_LOOK = NO |
1573 | 1678 | ||
1574 | # If set to YES, the inheritance and collaboration graphs will show the | 1679 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside |
1680 | # the class node. If there are many fields or methods and many nodes the | ||
1681 | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS | ||
1682 | # threshold limits the number of items for each type to make the size more | ||
1683 | # managable. Set this to 0 for no limit. Note that the threshold may be | ||
1684 | # exceeded by 50% before the limit is enforced. | ||
1685 | |||
1686 | UML_LIMIT_NUM_FIELDS = 10 | ||
1687 | |||
1688 | # If set to YES, the inheritance and collaboration graphs will show the | ||
1575 | # relations between templates and their instances. | 1689 | # relations between templates and their instances. |
1576 | 1690 | ||
1577 | TEMPLATE_RELATIONS = NO | 1691 | TEMPLATE_RELATIONS = NO |
1578 | 1692 | ||
1579 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | 1693 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
1580 | # tags are set to YES then doxygen will generate a graph for each documented | 1694 | # tags are set to YES then doxygen will generate a graph for each documented |
1581 | # file showing the direct and indirect include dependencies of the file with | 1695 | # file showing the direct and indirect include dependencies of the file with |
1582 | # other documented files. | 1696 | # other documented files. |
1583 | 1697 | ||
1584 | INCLUDE_GRAPH = YES | 1698 | INCLUDE_GRAPH = NO |
1585 | 1699 | ||
1586 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | 1700 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
1587 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | 1701 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
1588 | # documented header file showing the documented files that directly or | 1702 | # documented header file showing the documented files that directly or |
1589 | # indirectly include this file. | 1703 | # indirectly include this file. |
1590 | 1704 | ||
1591 | INCLUDED_BY_GRAPH = YES | 1705 | INCLUDED_BY_GRAPH = NO |
1592 | 1706 | ||
1593 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then | 1707 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1594 | # doxygen will generate a call dependency graph for every global function | 1708 | # doxygen will generate a call dependency graph for every global function |
1595 | # or class method. Note that enabling this option will significantly increase | 1709 | # or class method. Note that enabling this option will significantly increase |
1596 | # the time of a run. So in most cases it will be better to enable call graphs | 1710 | # the time of a run. So in most cases it will be better to enable call graphs |
1597 | # for selected functions only using the \callgraph command. | 1711 | # for selected functions only using the \callgraph command. |
1598 | 1712 | ||
1599 | CALL_GRAPH = NO | 1713 | CALL_GRAPH = NO |
1600 | 1714 | ||
1601 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | 1715 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
1602 | # doxygen will generate a caller dependency graph for every global function | 1716 | # doxygen will generate a caller dependency graph for every global function |
1603 | # or class method. Note that enabling this option will significantly increase | 1717 | # or class method. Note that enabling this option will significantly increase |
1604 | # the time of a run. So in most cases it will be better to enable caller | 1718 | # the time of a run. So in most cases it will be better to enable caller |
1605 | # graphs for selected functions only using the \callergraph command. | 1719 | # graphs for selected functions only using the \callergraph command. |
1606 | 1720 | ||
1607 | CALLER_GRAPH = NO | 1721 | CALLER_GRAPH = NO |
1608 | 1722 | ||
1609 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | 1723 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1610 | # will generate a graphical hierarchy of all classes instead of a textual one. | 1724 | # will generate a graphical hierarchy of all classes instead of a textual one. |
1611 | 1725 | ||
1612 | GRAPHICAL_HIERARCHY = YES | 1726 | GRAPHICAL_HIERARCHY = NO |
1613 | 1727 | ||
1614 | # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | 1728 | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES |
1615 | # then doxygen will show the dependencies a directory has on other directories | 1729 | # then doxygen will show the dependencies a directory has on other directories |
1616 | # in a graphical way. The dependency relations are determined by the #include | 1730 | # in a graphical way. The dependency relations are determined by the #include |
1617 | # relations between the files in the directories. | 1731 | # relations between the files in the directories. |
1618 | 1732 | ||
1619 | DIRECTORY_GRAPH = YES | 1733 | DIRECTORY_GRAPH = NO |
1620 | 1734 | ||
1621 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 1735 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1622 | # generated by dot. Possible values are png, jpg, or gif. | 1736 | # generated by dot. Possible values are svg, png, jpg, or gif. |
1623 | # If left blank png will be used. | 1737 | # If left blank png will be used. If you choose svg you need to set |
1738 | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||
1739 | # visible in IE 9+ (other browsers do not have this requirement). | ||
1624 | 1740 | ||
1625 | DOT_IMAGE_FORMAT = png | 1741 | DOT_IMAGE_FORMAT = png |
1626 | 1742 | ||
1627 | # The tag DOT_PATH can be used to specify the path where the dot tool can be | 1743 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
1744 | # enable generation of interactive SVG images that allow zooming and panning. | ||
1745 | # Note that this requires a modern browser other than Internet Explorer. | ||
1746 | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you | ||
1747 | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files | ||
1748 | # visible. Older versions of IE do not have SVG support. | ||
1749 | |||
1750 | INTERACTIVE_SVG = NO | ||
1751 | |||
1752 | # The tag DOT_PATH can be used to specify the path where the dot tool can be | ||
1628 | # found. If left blank, it is assumed the dot tool can be found in the path. | 1753 | # found. If left blank, it is assumed the dot tool can be found in the path. |
1629 | 1754 | ||
1630 | DOT_PATH = | 1755 | DOT_PATH = |
1631 | 1756 | ||
1632 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | 1757 | # The DOTFILE_DIRS tag can be used to specify one or more directories that |
1633 | # contain dot files that are included in the documentation (see the | 1758 | # contain dot files that are included in the documentation (see the |
1634 | # \dotfile command). | 1759 | # \dotfile command). |
1635 | 1760 | ||
1636 | DOTFILE_DIRS = | 1761 | DOTFILE_DIRS = |
1637 | 1762 | ||
1638 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | 1763 | # The MSCFILE_DIRS tag can be used to specify one or more directories that |
1639 | # contain msc files that are included in the documentation (see the | 1764 | # contain msc files that are included in the documentation (see the |
1640 | # \mscfile command). | 1765 | # \mscfile command). |
1641 | 1766 | ||
1642 | MSCFILE_DIRS = | 1767 | MSCFILE_DIRS = |
1643 | 1768 | ||
1644 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | 1769 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1645 | # nodes that will be shown in the graph. If the number of nodes in a graph | 1770 | # nodes that will be shown in the graph. If the number of nodes in a graph |
1646 | # becomes larger than this value, doxygen will truncate the graph, which is | 1771 | # becomes larger than this value, doxygen will truncate the graph, which is |
1647 | # visualized by representing a node as a red box. Note that doxygen if the | 1772 | # visualized by representing a node as a red box. Note that doxygen if the |
1648 | # number of direct children of the root node in a graph is already larger than | 1773 | # number of direct children of the root node in a graph is already larger than |
1649 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | 1774 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
1650 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | 1775 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1651 | 1776 | ||
1652 | DOT_GRAPH_MAX_NODES = 50 | 1777 | DOT_GRAPH_MAX_NODES = 50 |
1653 | 1778 | ||
1654 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | 1779 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1655 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | 1780 | # graphs generated by dot. A depth value of 3 means that only nodes reachable |
1656 | # from the root by following a path via at most 3 edges will be shown. Nodes | 1781 | # from the root by following a path via at most 3 edges will be shown. Nodes |
1657 | # that lay further from the root node will be omitted. Note that setting this | 1782 | # that lay further from the root node will be omitted. Note that setting this |
1658 | # option to 1 or 2 may greatly reduce the computation time needed for large | 1783 | # option to 1 or 2 may greatly reduce the computation time needed for large |
1659 | # code bases. Also note that the size of a graph can be further restricted by | 1784 | # code bases. Also note that the size of a graph can be further restricted by |
1660 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | 1785 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1661 | 1786 | ||
1662 | MAX_DOT_GRAPH_DEPTH = 0 | 1787 | MAX_DOT_GRAPH_DEPTH = 0 |
1663 | 1788 | ||
1664 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | 1789 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1665 | # background. This is disabled by default, because dot on Windows does not | 1790 | # background. This is disabled by default, because dot on Windows does not |
1666 | # seem to support this out of the box. Warning: Depending on the platform used, | 1791 | # seem to support this out of the box. Warning: Depending on the platform used, |
1667 | # enabling this option may lead to badly anti-aliased labels on the edges of | 1792 | # enabling this option may lead to badly anti-aliased labels on the edges of |
1668 | # a graph (i.e. they become hard to read). | 1793 | # a graph (i.e. they become hard to read). |
1669 | 1794 | ||
1670 | DOT_TRANSPARENT = NO | 1795 | DOT_TRANSPARENT = YES |
1671 | 1796 | ||
1672 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | 1797 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
1673 | # files in one run (i.e. multiple -o and -T options on the command line). This | 1798 | # files in one run (i.e. multiple -o and -T options on the command line). This |
1674 | # makes dot run faster, but since only newer versions of dot (>1.8.10) | 1799 | # makes dot run faster, but since only newer versions of dot (>1.8.10) |
1675 | # support this, this feature is disabled by default. | 1800 | # support this, this feature is disabled by default. |
1676 | 1801 | ||
1677 | DOT_MULTI_TARGETS = NO | 1802 | DOT_MULTI_TARGETS = NO |
1678 | 1803 | ||
1679 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | 1804 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1680 | # generate a legend page explaining the meaning of the various boxes and | 1805 | # generate a legend page explaining the meaning of the various boxes and |
1681 | # arrows in the dot generated graphs. | 1806 | # arrows in the dot generated graphs. |
1682 | 1807 | ||
1683 | GENERATE_LEGEND = YES | 1808 | GENERATE_LEGEND = YES |
1684 | 1809 | ||
1685 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | 1810 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
1686 | # remove the intermediate dot files that are used to generate | 1811 | # remove the intermediate dot files that are used to generate |
1687 | # the various graphs. | 1812 | # the various graphs. |
1688 | 1813 | ||
1689 | DOT_CLEANUP = YES | 1814 | DOT_CLEANUP = YES |
1815 | |||
1816 | ALIASES += xmpp="<blockquote class=\"xmpp\">" | ||
1817 | ALIASES += endxmpp="</blockquote>" | ||
diff --git a/doc/doxygen/data/head.html b/doc/doxygen/data/head.html index 6035c58..bf9da23 100644 --- a/doc/doxygen/data/head.html +++ b/doc/doxygen/data/head.html | |||
@@ -24,8 +24,6 @@ | |||
24 | <ul> | 24 | <ul> |
25 | <li class="current"><a href="index.html">Documentation</a></li> | 25 | <li class="current"><a href="index.html">Documentation</a></li> |
26 | <li><a href="recipe.html">Recipes</a></li> | 26 | <li><a href="recipe.html">Recipes</a></li> |
27 | <li><a href="coverage/index.html" target="_blank">Coverage</a></li> | ||
28 | <li><a href="http://redmine.asp64.lan/projects/CorePack" target="_blank">Tracker</a></li> | ||
29 | </ul> | 27 | </ul> |
30 | </div> | 28 | </div> |
31 | </div> | 29 | </div> |