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