cmake_infile.doxygen

Tue, 05 Oct 2021 11:19:32 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 05 Oct 2021 11:19:32 +0200
changeset 460
e075009b33b7
parent 390
d345541018fa
child 462
1bcf7c8d4b47
permissions
-rw-r--r--

remove convenience macros

Users should write their own wrappers s.t. the type
information does not have to be repeated on every
call site.

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

mercurial