Doxyfile

Sun, 03 Oct 2021 10:43:31 +0200

author
Mike Becker <universe@uap-core.de>
date
Sun, 03 Oct 2021 10:43:31 +0200
changeset 449
68ad5750ba6b
parent 266
33d229634809
child 462
1bcf7c8d4b47
permissions
-rw-r--r--

minor code changes

These changes do not affect program behavior.

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

mercurial