Doxyfile

Sun, 14 Jan 2024 13:50:17 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 14 Jan 2024 13:50:17 +0100
changeset 806
e06249e09f99
parent 753
24dc84788dee
child 983
b040340bf64d
permissions
-rw-r--r--

add constant for reading out strstr sbo size - relates to #343

also fixes the related test which was working with the old SBO size of 256 and was broken after increasing it to 512

711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1 # Doxyfile 1.9.6
208
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 (\" \").
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
15 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
16 # Note:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
17 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
18 # Use doxygen to compare the used configuration file with the template
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
19 # configuration file:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
20 # doxygen -x [configFile]
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
21 # Use doxygen to compare the used configuration file with the template
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
22 # configuration file without replacing the environment variables or CMake type
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
23 # replacement variables:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
24 # doxygen -x_noenv [configFile]
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25
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 # Project related configuration options
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
30 # This tag specifies the encoding used for all characters in the configuration
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
31 # file that follow. The default is UTF-8 which is also the encoding used for all
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
33 # iconv built into libc) for the transcoding. See
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
34 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
35 # The default value is: UTF-8.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
36
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37 DOXYFILE_ENCODING = UTF-8
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
39 # 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
40 # 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
41 # 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
42 # 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
43 # The default value is: My Project.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
45 PROJECT_NAME = ucx
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
46
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
47 # 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
48 # 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
49 # control system is used.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
50
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
51 PROJECT_NUMBER =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
52
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
53 # 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
54 # 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
55 # 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
56
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
57 PROJECT_BRIEF = "UAP Common Extensions"
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
58
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
59 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
60 # in the documentation. The maximum height of the logo should not exceed 55
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
62 # the logo to the output directory.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
63
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
64 PROJECT_LOGO = ./uaplogo.png
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
65
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
66 # 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
67 # 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
68 # 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
69 # 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
70
753
24dc84788dee replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents: 711
diff changeset
71 OUTPUT_DIRECTORY = build/docs
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
72
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
74 # sub-directories (in 2 levels) under the output directory of each output format
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
75 # and will distribute the generated files over these directories. Enabling this
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
76 # 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
77 # putting all generated files in the same directory would otherwise causes
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
78 # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
79 # control the number of sub-directories.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
80 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
81
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
82 CREATE_SUBDIRS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
83
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
84 # Controls the number of sub-directories that will be created when
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
85 # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
86 # level increment doubles the number of directories, resulting in 4096
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
87 # directories at level 8 which is the default and also the maximum value. The
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
88 # sub-directories are organized in 2 levels, the first level always has a fixed
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
89 # number of 16 directories.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
90 # Minimum value: 0, maximum value: 8, default value: 8.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
91 # This tag requires that the tag CREATE_SUBDIRS is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
92
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
93 CREATE_SUBDIRS_LEVEL = 8
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
94
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
95 # 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
96 # 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
97 # 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
98 # U+3044.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
99 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
100
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
101 ALLOW_UNICODE_NAMES = NO
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
102
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
103 # 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
104 # 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
105 # information to generate all constant output in the proper language.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
106 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
107 # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
108 # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
109 # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
110 # English messages), Korean, Korean-en (Korean with English messages), Latvian,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
111 # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
112 # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
113 # Swedish, Turkish, Ukrainian and Vietnamese.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
114 # The default value is: English.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
115
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
116 OUTPUT_LANGUAGE = English
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
117
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
119 # 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
120 # 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
121 # The default value is: YES.
114
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 BRIEF_MEMBER_DESC = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
124
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
126 # 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
127 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
128 # 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
129 # 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
130 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
131
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
132 REPEAT_BRIEF = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
133
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
134 # 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
135 # 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
136 # 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
137 # 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
138 # 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
139 # 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
140 # 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
141 # 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
142
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
143 ABBREVIATE_BRIEF =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
144
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
145 # 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
146 # 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
147 # description.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
148 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
149
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
150 ALWAYS_DETAILED_SEC = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
151
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
152 # 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
153 # 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
154 # 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
155 # 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
156 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
157
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
158 INLINE_INHERITED_MEMB = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
159
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
160 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
161 # 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
162 # 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
163 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
164
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
165 FULL_PATH_NAMES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
166
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
167 # 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
168 # 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
169 # 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
170 # 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
171 # strip.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
172 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
173 # 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
174 # 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
175 # 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
176
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
177 STRIP_FROM_PATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
178
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
179 # 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
180 # 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
181 # 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
182 # 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
183 # 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
184 # using the -I flag.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
185
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
186 STRIP_FROM_INC_PATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
187
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
188 # 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
189 # 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
190 # 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
191 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
192
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
193 SHORT_NAMES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
194
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
195 # 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
196 # 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
197 # 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
198 # 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
199 # description.)
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
200 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
201
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
202 JAVADOC_AUTOBRIEF = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
203
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
205 # such as
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
206 # /***************
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
207 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
208 # Javadoc-style will behave just like regular comments and it will not be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
209 # interpreted by doxygen.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
210 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
211
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
212 JAVADOC_BANNER = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
213
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
214 # 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
215 # 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
216 # 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
217 # 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
218 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
219
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
220 QT_AUTOBRIEF = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
221
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
222 # 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
223 # 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
224 # 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
225 # 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
226 # 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
227 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
228 # 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
229 # not recognized any more.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
230 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
231
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
232 MULTILINE_CPP_IS_BRIEF = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
233
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
234 # By default Python docstrings are displayed as preformatted text and doxygen's
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
235 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
236 # doxygen's special commands can be used and the contents of the docstring
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
237 # documentation blocks is shown as doxygen documentation.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
238 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
239
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
240 PYTHON_DOCSTRING = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
241
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
242 # 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
243 # 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
244 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
245
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
246 INHERIT_DOCS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
247
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
248 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
249 # page for each member. If set to NO, the documentation of a member will be part
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
250 # of the file/class/namespace that contains it.
208
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 SEPARATE_MEMBER_PAGES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
254
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
255 # 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
256 # 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
257 # 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
258
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
259 TAB_SIZE = 4
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
260
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
261 # 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
262 # 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
263 # name=value
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
264 # For example adding
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
265 # "sideeffect=@par Side Effects:^^"
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
266 # 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
267 # documentation, which will result in a user-defined paragraph with heading
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
268 # "Side Effects:". Note that you cannot put \n's in the value part of an alias
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
269 # to insert newlines (in the resulting output). You can put ^^ in the value part
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
270 # of an alias to insert a newline as if a physical newline was in the original
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
271 # file. When you need a literal { or } or , in the value part of an alias you
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
272 # have to escape them by means of a backslash (\), this can lead to conflicts
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
273 # with the commands \{ and \} for these it is advised to use the version @{ and
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
274 # @} or use a double escape (\\{ and \\})
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
275
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
276 ALIASES =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
277
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
278 # 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
279 # 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
280 # 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
281 # members will be omitted, etc.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
282 # The default value is: NO.
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 OPTIMIZE_OUTPUT_FOR_C = YES
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 # 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
287 # 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
288 # 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
289 # qualified scopes will look different, etc.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
290 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
291
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
292 OPTIMIZE_OUTPUT_JAVA = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
293
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
294 # 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
295 # 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
296 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
297
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
298 OPTIMIZE_FOR_FORTRAN = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
299
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
300 # 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
301 # 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
302 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
303
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
304 OPTIMIZE_OUTPUT_VHDL = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
305
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
306 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
307 # sources only. Doxygen will then generate output that is more tailored for that
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
308 # language. For instance, namespaces will be presented as modules, types will be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
309 # separated into more groups, etc.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
310 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
311
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
312 OPTIMIZE_OUTPUT_SLICE = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
313
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
314 # 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
315 # 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
316 # 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
317 # using this tag. The format is ext=language, where ext is a file extension, and
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
318 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
319 # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
320 # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
321 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
322 # tries to guess whether the code is fixed or free formatted code, this is the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
323 # default for Fortran type files). For instance to make doxygen treat .inc files
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
324 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
325 # use: inc=Fortran f=C.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
326 #
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
327 # Note: For files without extension you can use no_extension as a placeholder.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
328 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
329 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
330 # the files are not read by doxygen. When specifying no_extension you should add
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
331 # * to the FILE_PATTERNS.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
332 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
333 # Note see also the list of default file extension mappings.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
334
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
335 EXTENSION_MAPPING =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
336
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
337 # 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
338 # according to the Markdown format, which allows for more readable
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
339 # documentation. See https://daringfireball.net/projects/markdown/ for details.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
340 # 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
341 # 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
342 # case of backward compatibilities issues.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
343 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
344
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
345 MARKDOWN_SUPPORT = YES
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
346
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
347 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
348 # to that level are automatically included in the table of contents, even if
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
349 # they do not have an id attribute.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
350 # Note: This feature currently applies only to Markdown headings.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
351 # Minimum value: 0, maximum value: 99, default value: 5.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
352 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
353
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
354 TOC_INCLUDE_HEADINGS = 5
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
355
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
356 # 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
357 # classes, or namespaces to their corresponding documentation. Such a link can
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
358 # be prevented in individual cases by putting a % sign in front of the word or
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
359 # globally by setting AUTOLINK_SUPPORT to NO.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
360 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
361
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
362 AUTOLINK_SUPPORT = YES
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
363
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
364 # 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
365 # 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
366 # 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
367 # 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
368 # 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
369 # 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
370 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
371
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
372 BUILTIN_STL_SUPPORT = NO
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 # 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
375 # enable parsing support.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
376 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
377
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
378 CPP_CLI_SUPPORT = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
379
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
380 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
381 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
382 # 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
383 # 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
384 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
385
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
386 SIP_SUPPORT = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
387
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
388 # 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
389 # 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
390 # 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
391 # 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
392 # 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
393 # should set this option to NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
394 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
395
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
396 IDL_PROPERTY_SUPPORT = YES
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 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
399 # tag is set to YES then doxygen will reuse the documentation of the first
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
400 # 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
401 # 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
402 # The default value is: NO.
114
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 DISTRIBUTE_GROUP_DOC = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
405
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
406 # If one adds a struct or class to a group and this option is enabled, then also
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
407 # any nested class or struct is added to the same group. By default this option
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
408 # is disabled and one has to add nested compounds explicitly via \ingroup.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
409 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
410
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
411 GROUP_NESTED_COMPOUNDS = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
412
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
413 # 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
414 # (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
415 # 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
416 # 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
417 # \nosubgrouping command.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
418 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
419
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
420 SUBGROUPING = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
421
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
422 # 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
423 # 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
424 # 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
425 # and RTF).
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
426 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
427 # 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
428 # SEPARATE_MEMBER_PAGES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
429 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
430
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
431 INLINE_GROUPED_CLASSES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
432
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
433 # 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
434 # 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
435 # 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
436 # 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
437 # 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
438 # 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
439 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
440
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
441 INLINE_SIMPLE_STRUCTS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
442
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
443 # 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
444 # 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
445 # 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
446 # 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
447 # 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
448 # 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
449 # 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
450 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
451
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
452 TYPEDEF_HIDES_STRUCT = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
453
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
454 # 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
455 # 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
456 # 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
457 # 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
458 # 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
459 # 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
460 # 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
461 # 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
462 # 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
463 # 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
464
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
465 LOOKUP_CACHE_SIZE = 0
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
466
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
467 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
468 # during processing. When set to 0 doxygen will based this on the number of
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
469 # cores available in the system. You can set it explicitly to a value larger
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
470 # than 0 to get more control over the balance between CPU load and processing
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
471 # speed. At this moment only the input processing can be done using multiple
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
472 # threads. Since this is still an experimental feature the default is set to 1,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
473 # which effectively disables parallel processing. Please report any issues you
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
474 # encounter. Generating dot graphs in parallel is controlled by the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
475 # DOT_NUM_THREADS setting.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
476 # Minimum value: 0, maximum value: 32, default value: 1.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
477
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
478 NUM_PROC_THREADS = 1
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
479
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
480 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
481 # Build related configuration options
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
482 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
483
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
484 # 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
485 # 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
486 # 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
487 # 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
488 # 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
489 # 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
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 EXTRACT_ALL = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
493
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
494 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
495 # be included in the documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
496 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
497
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
498 EXTRACT_PRIVATE = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
499
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
500 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
501 # methods of a class will be included in the documentation.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
502 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
503
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
504 EXTRACT_PRIV_VIRTUAL = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
505
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
506 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
507 # 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
508 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
509
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
510 EXTRACT_PACKAGE = NO
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
511
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
512 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
513 # included in the documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
514 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
515
502
33e7b6ebf403 change Doxyfile to ignore __attribute__ and include static inline functions
Mike Becker <universe@uap-core.de>
parents: 463
diff changeset
516 EXTRACT_STATIC = YES
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
517
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
518 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
519 # locally in source files will be included in the documentation. If set to NO,
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
520 # 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
521 # for Java sources.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
522 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
523
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
524 EXTRACT_LOCAL_CLASSES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
525
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
526 # This flag is only useful for Objective-C code. If set to YES, local methods,
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
527 # which are defined in the implementation section but not in the interface are
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
528 # included in the documentation. If set to NO, only methods in the interface are
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
529 # included.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
530 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
531
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
532 EXTRACT_LOCAL_METHODS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
533
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
534 # 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
535 # 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
536 # '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
537 # 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
538 # are hidden.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
539 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
540
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
541 EXTRACT_ANON_NSPACES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
542
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
543 # If this flag is set to YES, the name of an unnamed parameter in a declaration
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
544 # will be determined by the corresponding definition. By default unnamed
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
545 # parameters remain unnamed in the output.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
546 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
547
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
548 RESOLVE_UNNAMED_PARAMS = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
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 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
551 # 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
552 # 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
553 # 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
554 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
555
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
556 HIDE_UNDOC_MEMBERS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
557
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
558 # 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
559 # undocumented classes that are normally visible in the class hierarchy. If set
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
560 # to NO, these classes will be included in the various overviews. This option
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
561 # will also hide undocumented C++ concepts if enabled. This option has no effect
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
562 # if EXTRACT_ALL is enabled.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
563 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
564
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
565 HIDE_UNDOC_CLASSES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
566
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
567 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
568 # declarations. If set to NO, these declarations will be included in the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
569 # documentation.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
570 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
571
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
572 HIDE_FRIEND_COMPOUNDS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
573
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
574 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
575 # documentation blocks found inside the body of a function. If set to NO, these
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
576 # 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
577 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
578
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
579 HIDE_IN_BODY_DOCS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
580
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
581 # 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
582 # \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
583 # 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
584 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
585
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
586 INTERNAL_DOCS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
587
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
588 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
589 # able to match the capabilities of the underlying filesystem. In case the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
590 # filesystem is case sensitive (i.e. it supports files in the same directory
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
591 # whose names only differ in casing), the option must be set to YES to properly
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
592 # deal with such files in case they appear in the input. For filesystems that
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
593 # are not case sensitive the option should be set to NO to properly deal with
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
594 # output files written for symbols that only differ in casing, such as for two
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
595 # classes, one named CLASS and the other named Class, and to also support
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
596 # references to files without having to specify the exact matching casing. On
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
597 # Windows (including Cygwin) and MacOS, users should typically set this option
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
598 # to NO, whereas on Linux or other Unix flavors it should typically be set to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
599 # YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
600 # Possible values are: SYSTEM, NO and YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
601 # The default value is: SYSTEM.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
602
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
603 CASE_SENSE_NAMES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
604
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
605 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
606 # their full class and namespace scopes in the documentation. If set to YES, the
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
607 # scope will be hidden.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
608 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
609
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
610 HIDE_SCOPE_NAMES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
611
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
612 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
613 # append additional text to a page's title, such as Class Reference. If set to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
614 # YES the compound reference will be hidden.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
615 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
616
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
617 HIDE_COMPOUND_REFERENCE= NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
618
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
619 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
620 # will show which file needs to be included to use the class.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
621 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
622
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
623 SHOW_HEADERFILE = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
624
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
625 # 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
626 # 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
627 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
628
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
629 SHOW_INCLUDE_FILES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
630
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
631 # 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
632 # 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
633 # 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
634 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
635
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
636 SHOW_GROUPED_MEMB_INC = NO
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
637
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
638 # 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
639 # 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
640 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
641
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
642 FORCE_LOCAL_INCLUDES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
643
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
644 # 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
645 # documentation for inline members.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
646 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
647
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
648 INLINE_INFO = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
649
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
650 # 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
651 # (detailed) documentation of file and class members alphabetically by member
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
652 # name. If set to NO, the members will appear in declaration order.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
653 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
654
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
655 SORT_MEMBER_DOCS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
656
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
657 # 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
658 # descriptions of file, namespace and class members alphabetically by member
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
659 # name. If set to NO, the members will appear in declaration order. Note that
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
660 # 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
661 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
662
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
663 SORT_BRIEF_DOCS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
664
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
665 # 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
666 # (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
667 # 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
668 # 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
669 # 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
670 # member documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
671 # 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
672 # detailed member documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
673 # The default value is: NO.
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 SORT_MEMBERS_CTORS_1ST = NO
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 # 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
678 # 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
679 # appear in their defined order.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
680 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
681
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
682 SORT_GROUP_NAMES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
683
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
684 # 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
685 # 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
686 # 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
687 # 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
688 # 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
689 # list.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
690 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
691
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
692 SORT_BY_SCOPE_NAME = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
693
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
694 # 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
695 # 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
696 # 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
697 # 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
698 # 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
699 # 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
700 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
701
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
702 STRICT_PROTO_MATCHING = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
703
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
704 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
705 # list. This list is created by putting \todo commands in the documentation.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
706 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
707
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
708 GENERATE_TODOLIST = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
709
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
710 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
711 # list. This list is created by putting \test commands in the documentation.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
712 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
713
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
714 GENERATE_TESTLIST = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
715
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
716 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
717 # 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
718 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
719
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
720 GENERATE_BUGLIST = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
721
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
722 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
723 # 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
724 # the documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
725 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
726
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
727 GENERATE_DEPRECATEDLIST= YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
728
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
729 # 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
730 # 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
731 # ... \endcond blocks.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
732
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
733 ENABLED_SECTIONS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
734
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
735 # 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
736 # 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
737 # 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
738 # 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
739 # 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
740 # 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
741 # documentation regardless of this setting.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
742 # 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
743
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
744 MAX_INITIALIZER_LINES = 30
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
745
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
746 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
747 # the bottom of the documentation of classes and structs. If set to YES, the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
748 # list will mention the files that were used to generate the documentation.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
749 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
750
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
751 SHOW_USED_FILES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
752
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
753 # 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
754 # 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
755 # (if specified).
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
756 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
757
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
758 SHOW_FILES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
759
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
760 # 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
761 # 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
762 # Folder Tree View (if specified).
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
763 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
764
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
765 SHOW_NAMESPACES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
766
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
767 # 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
768 # 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
769 # 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
770 # 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
771 # 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
772 # 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
773 # 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
774
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
775 FILE_VERSION_FILTER =
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 # 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
778 # 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
779 # 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
780 # 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
781 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
782 # will be used as the name of the layout file. See also section "Changing the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
783 # layout of pages" for information.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
784 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
785 # 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
786 # 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
787 # tag is left empty.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
788
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
789 LAYOUT_FILE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
790
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
791 # 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
792 # 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
793 # extension is automatically appended if omitted. This requires the bibtex tool
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
794 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
795 # 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
796 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
797 # search path. See 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
798
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
799 CITE_BIB_FILES =
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 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
802 # 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
803 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
804
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
805 # 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
806 # 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
807 # messages are off.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
808 # The default value is: NO.
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 QUIET = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
811
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
812 # The WARNINGS tag can be used to turn on/off the warning messages that are
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
813 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
814 # 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
815 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
816 # 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
817 # The default value is: YES.
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 WARNINGS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
820
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
821 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
822 # 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
823 # will automatically be disabled.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
824 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
825
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
826 WARN_IF_UNDOCUMENTED = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
827
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
828 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
829 # potential errors in the documentation, such as documenting some parameters in
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
830 # a documented function twice, or documenting parameters that don't exist or
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
831 # using markup commands wrongly.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
832 # The default value is: YES.
114
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 WARN_IF_DOC_ERROR = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
835
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
836 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
837 # function parameter documentation. If set to NO, doxygen will accept that some
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
838 # parameters have no documentation without warning.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
839 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
840
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
841 WARN_IF_INCOMPLETE_DOC = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
842
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
843 # 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
844 # are documented, but have no documentation for their parameters or return
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
845 # value. If set to NO, doxygen will only warn about wrong parameter
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
846 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
847 # set to YES then this flag will automatically be disabled. See also
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
848 # WARN_IF_INCOMPLETE_DOC
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
849 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
850
115
965fd17ed9cf added man page output
Mike Becker <universe@uap-core.de>
parents: 114
diff changeset
851 WARN_NO_PARAMDOC = YES
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
852
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
853 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
854 # undocumented enumeration values. If set to NO, doxygen will accept
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
855 # undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
856 # will automatically be disabled.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
857 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
858
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
859 WARN_IF_UNDOC_ENUM_VAL = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
860
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
861 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
862 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
863 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
864 # at the end of the doxygen process doxygen will return with a non-zero status.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
865 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
866 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
867
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
868 WARN_AS_ERROR = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
869
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
870 # 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
871 # 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
872 # 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
873 # 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
874 # 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
875 # FILE_VERSION_FILTER)
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
876 # See also: WARN_LINE_FORMAT
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
877 # 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
878
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
879 WARN_FORMAT = "$file:$line: $text"
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
880
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
881 # In the $text part of the WARN_FORMAT command it is possible that a reference
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
882 # to a more specific place is given. To make it easier to jump to this place
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
883 # (outside of doxygen) the user can define a custom "cut" / "paste" string.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
884 # Example:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
885 # WARN_LINE_FORMAT = "'vi $file +$line'"
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
886 # See also: WARN_FORMAT
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
887 # The default value is: at line $line of file $file.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
888
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
889 WARN_LINE_FORMAT = "at line $line of file $file"
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
890
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
891 # 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
892 # messages should be written. If left blank the output is written to standard
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
893 # error (stderr). In case the file specified cannot be opened for writing the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
894 # warning and error messages are written to standard error. When as file - is
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
895 # specified the warning and error messages are written to standard output
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
896 # (stdout).
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 WARN_LOGFILE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
899
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
900 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
901 # 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
902 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
903
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
904 # 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
905 # 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
906 # directories like /usr/src/myproject. Separate the files or directories with
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
907 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
908 # 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
909
463
92721c8f9db3 change src dir of Doxygen to only include header files
Mike Becker <universe@uap-core.de>
parents: 462
diff changeset
910 INPUT = ./src/cx
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 # 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
913 # 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
914 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
915 # documentation (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
916 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
917 # See also: INPUT_FILE_ENCODING
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
918 # The default value is: UTF-8.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
919
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
920 INPUT_ENCODING = UTF-8
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
921
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
922 # This tag can be used to specify the character encoding of the source files
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
923 # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
924 # character encoding on a per file pattern basis. Doxygen will compare the file
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
925 # name with each pattern and apply the encoding instead of the default
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
926 # INPUT_ENCODING) if there is a match. The character encodings are a list of the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
927 # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
928 # "INPUT_ENCODING" for further information on supported encodings.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
929
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
930 INPUT_FILE_ENCODING =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
931
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
932 # 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
933 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
934 # *.h) to filter out the source-files in the directories.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
935 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
936 # Note that for custom extensions or not directly supported extensions you also
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
937 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
938 # read by doxygen.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
939 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
940 # Note the list of default checked file patterns might differ from the list of
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
941 # default file extension mappings.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
942 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
943 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
944 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
945 # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
946 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
947 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
948 # *.vhdl, *.ucf, *.qsf and *.ice.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
949
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
950 FILE_PATTERNS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
951
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
952 # 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
953 # 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
954 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
955
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
956 RECURSIVE = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
957
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
958 # 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
959 # 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
960 # 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
961 #
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
962 # 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
963 # run.
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
964
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
965 EXCLUDE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
966
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
967 # 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
968 # 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
969 # from the input.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
970 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
971
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
972 EXCLUDE_SYMLINKS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
973
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
974 # 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
975 # 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
976 # certain files from those directories.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
977 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
978 # 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
979 # 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
980
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
981 EXCLUDE_PATTERNS =
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
982
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
983 # 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
984 # (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
985 # 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
986 # wildcard * is used, a substring. Examples: ANamespace, AClass,
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
987 # ANamespace::AClass, ANamespace::*Test
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
988 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
989 # 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
990 # 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
991
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
992 EXCLUDE_SYMBOLS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
993
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
994 # 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
995 # 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
996 # command).
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
997
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
998 EXAMPLE_PATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
999
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1000 # 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
1001 # 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
1002 # *.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
1003 # files are included.
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 EXAMPLE_PATTERNS =
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 # 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
1008 # 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
1009 # 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
1010 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1011
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1012 EXAMPLE_RECURSIVE = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1013
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1014 # 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
1015 # 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
1016 # \image command).
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1017
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1018 IMAGE_PATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1019
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1020 # 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
1021 # 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
1022 # by executing (via popen()) the command:
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1023 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1024 # <filter> <input-file>
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1025 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1026 # 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
1027 # 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
1028 # 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
1029 # will be ignored.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1030 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1031 # 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
1032 # 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
1033 # or removed, the anchors will not be placed correctly.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1034 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1035 # Note that doxygen will use the data processed and written to standard output
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1036 # for further processing, therefore nothing else, like debug statements or used
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1037 # commands (so in case of a Windows batch file always use @echo OFF), should be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1038 # written to standard output.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1039 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1040 # Note that for custom extensions or not directly supported extensions you also
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1041 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1042 # properly processed by doxygen.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1043
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1044 INPUT_FILTER =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1045
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1046 # 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
1047 # 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
1048 # 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
1049 # (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
1050 # 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
1051 # patterns match the file name, INPUT_FILTER is applied.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1052 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1053 # Note that for custom extensions or not directly supported extensions you also
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1054 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1055 # properly processed by doxygen.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1056
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1057 FILTER_PATTERNS =
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 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1060 # INPUT_FILTER) will also be used to filter the input files that are used for
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1061 # 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
1062 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1063
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1064 FILTER_SOURCE_FILES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1065
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1066 # 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
1067 # 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
1068 # 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
1069 # *.ext= (so without naming a filter).
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1070 # 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
1071
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1072 FILTER_SOURCE_PATTERNS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1073
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1074 # 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
1075 # 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
1076 # (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
1077 # 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
1078
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1079 USE_MDFILE_AS_MAINPAGE =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1080
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1081 # The Fortran standard specifies that for fixed formatted Fortran code all
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1082 # characters from position 72 are to be considered as comment. A common
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1083 # extension is to allow longer lines before the automatic comment starts. The
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1084 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1085 # be processed before the automatic comment starts.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1086 # Minimum value: 7, maximum value: 10000, default value: 72.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1087
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1088 FORTRAN_COMMENT_AFTER = 72
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1089
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1090 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1091 # Configuration options related to source browsing
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1092 #---------------------------------------------------------------------------
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 # 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
1095 # 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
1096 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1097 # 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
1098 # 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
1099 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1100
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1101 SOURCE_BROWSER = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1102
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1103 # 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
1104 # 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
1105 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1106
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1107 INLINE_SOURCES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1108
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1109 # 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
1110 # 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
1111 # Fortran comments will always remain visible.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1112 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1113
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1114 STRIP_CODE_COMMENTS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1115
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1116 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1117 # entity all documented functions referencing it will be listed.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1118 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1119
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1120 REFERENCED_BY_RELATION = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1121
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1122 # 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
1123 # 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
1124 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1125
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1126 REFERENCES_RELATION = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1127
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1128 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1129 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1130 # 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
1131 # link to the documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1132 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1133
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1134 REFERENCES_LINK_SOURCE = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1135
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1136 # 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
1137 # 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
1138 # 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
1139 # 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
1140 # can opt to disable this feature.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1141 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1142 # 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
1143
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1144 SOURCE_TOOLTIPS = YES
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1145
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1146 # 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
1147 # 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
1148 # source browser. The htags tool is part of GNU's global source tagging system
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1149 # (see https://www.gnu.org/software/global/global.html). You will need version
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1150 # 4.8.6 or higher.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1151 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1152 # To use it do the following:
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1153 # - Install the latest version of global
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1154 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1155 # - 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
1156 # - Run doxygen as normal
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1157 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1158 # 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
1159 # 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
1160 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1161 # 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
1162 # 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
1163 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1164 # 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
1165
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1166 USE_HTAGS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1167
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1168 # 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
1169 # 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
1170 # 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
1171 # See also: Section \class.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1172 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1173
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1174 VERBATIM_HEADERS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1175
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1176 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1177 # clang parser (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1178 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1179 # performance. This can be particularly helpful with template rich C++ code for
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1180 # which doxygen's built-in parser lacks the necessary type information.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1181 # Note: The availability of this option depends on whether or not doxygen was
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1182 # generated with the -Duse_libclang=ON option for CMake.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1183 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1184
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1185 CLANG_ASSISTED_PARSING = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1186
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1187 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1188 # tag is set to YES then doxygen will add the directory of each input to the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1189 # include path.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1190 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1191 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1192
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1193 CLANG_ADD_INC_PATHS = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1194
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1195 # If clang assisted parsing is enabled you can provide the compiler with command
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1196 # line options that you would normally use when invoking the compiler. Note that
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1197 # the include paths will already be set by doxygen for the files and directories
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1198 # specified with INPUT and INCLUDE_PATH.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1199 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1200
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1201 CLANG_OPTIONS =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1202
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1203 # If clang assisted parsing is enabled you can provide the clang parser with the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1204 # path to the directory containing a file called compile_commands.json. This
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1205 # file is the compilation database (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1206 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1207 # options used when the source files were built. This is equivalent to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1208 # specifying the -p option to a clang tool, such as clang-check. These options
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1209 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1210 # will be added as well.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1211 # Note: The availability of this option depends on whether or not doxygen was
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1212 # generated with the -Duse_libclang=ON option for CMake.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1213
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1214 CLANG_DATABASE_PATH =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1215
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1216 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1217 # 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
1218 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1219
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1220 # 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
1221 # 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
1222 # classes, structs, unions or interfaces.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1223 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1224
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1225 ALPHABETICAL_INDEX = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1226
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1227 # The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1228 # that should be ignored while generating the index headers. The IGNORE_PREFIX
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1229 # tag works for classes, function and member names. The entity will be placed in
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1230 # the alphabetical list under the first letter of the entity name that remains
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1231 # after removing the prefix.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1232 # 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
1233
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1234 IGNORE_PREFIX =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1235
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 # 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
1238 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1239
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1240 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1241 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1242
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1243 GENERATE_HTML = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1244
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1245 # 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
1246 # 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
1247 # it.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1248 # The default directory is: html.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1249 # 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
1250
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 226
diff changeset
1251 HTML_OUTPUT = web/api
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1252
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1253 # 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
1254 # 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
1255 # The default value is: .html.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1256 # 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
1257
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1258 HTML_FILE_EXTENSION = .html
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1259
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1260 # 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
1261 # 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
1262 # standard header.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1263 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1264 # 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
1265 # 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
1266 # 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
1267 # default header using
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1268 # 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
1269 # YourConfigFile
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1270 # 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
1271 # 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
1272 # uses.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1273 # 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
1274 # 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
1275 # 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
1276 # 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
1277
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1278 HTML_HEADER =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1279
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1280 # 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
1281 # 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
1282 # 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
1283 # 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
1284 # 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
1285 # that doxygen normally uses.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1286 # 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
1287
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1288 HTML_FOOTER =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1289
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1290 # 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
1291 # 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
1292 # 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
1293 # 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
1294 # sheet that doxygen normally uses.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1295 # 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
1296 # 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
1297 # obsolete.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1298 # 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
1299
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1300 HTML_STYLESHEET =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1301
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1302 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1303 # cascading style sheets that are included after the standard style sheets
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1304 # 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
1305 # This is preferred over using HTML_STYLESHEET since it does not replace the
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1306 # standard style sheet and is therefore more robust against future updates.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1307 # Doxygen will copy the style sheet files to the output directory.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1308 # Note: The order of the extra style sheet files is of importance (e.g. the last
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1309 # style sheet in the list overrules the setting of the previous ones in the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1310 # list).
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1311 # Note: Since the styling of scrollbars can currently not be overruled in
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1312 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1313 # one or more extra stylesheets have been specified. So if scrollbar
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1314 # customization is desired it has to be added explicitly. For an example see the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1315 # documentation.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1316 # 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
1317
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1318 HTML_EXTRA_STYLESHEET =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1319
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1320 # 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
1321 # 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
1322 # 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
1323 # $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
1324 # 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
1325 # 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
1326 # 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
1327
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1328 HTML_EXTRA_FILES =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1329
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1330 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1331 # should be rendered with a dark or light theme.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1332 # Possible values are: LIGHT always generate light mode output, DARK always
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1333 # generate dark mode output, AUTO_LIGHT automatically set the mode according to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1334 # the user preference, use light mode if no preference is set (the default),
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1335 # AUTO_DARK automatically set the mode according to the user preference, use
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1336 # dark mode if no preference is set and TOGGLE allow to user to switch between
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1337 # light and dark mode via a button.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1338 # The default value is: AUTO_LIGHT.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1339 # This tag requires that the tag GENERATE_HTML is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1340
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1341 HTML_COLORSTYLE = AUTO_LIGHT
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1342
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1343 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1344 # will adjust the colors in the style sheet and background images according to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1345 # this color. Hue is specified as an angle on a color-wheel, see
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1346 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1347 # 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
1348 # purple, and 360 is red again.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1349 # 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
1350 # 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
1351
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1352 HTML_COLORSTYLE_HUE = 220
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1353
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1354 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1355 # in the HTML output. For a value of 0 the output will use gray-scales only. A
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1356 # 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
1357 # 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
1358 # 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
1359
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1360 HTML_COLORSTYLE_SAT = 100
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1361
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1362 # 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
1363 # 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
1364 # 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
1365 # 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
1366 # 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
1367 # change the gamma.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1368 # 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
1369 # 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
1370
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1371 HTML_COLORSTYLE_GAMMA = 80
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1372
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1373 # 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
1374 # page will contain the date and time when the page was generated. Setting this
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1375 # to YES can help to show when doxygen was last run and thus if the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1376 # documentation is up to date.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1377 # The default value is: NO.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1378 # 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
1379
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1380 HTML_TIMESTAMP = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1381
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1382 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1383 # documentation will contain a main index with vertical navigation menus that
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1384 # are dynamically created via JavaScript. If disabled, the navigation index will
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1385 # consists of multiple levels of tabs that are statically embedded in every HTML
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1386 # page. Disable this option to support browsers that do not have JavaScript,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1387 # like the Qt help browser.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1388 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1389 # This tag requires that the tag GENERATE_HTML is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1390
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1391 HTML_DYNAMIC_MENUS = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1392
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1393 # 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
1394 # 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
1395 # page has loaded.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1396 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1397 # 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
1398
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1399 HTML_DYNAMIC_SECTIONS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1400
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1401 # 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
1402 # 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
1403 # 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
1404 # 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
1405 # 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
1406 # 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
1407 # 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
1408 # tree by default.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1409 # 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
1410 # 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
1411
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1412 HTML_INDEX_NUM_ENTRIES = 100
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1413
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1414 # 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
1415 # generated that can be used as input for Apple's Xcode 3 integrated development
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1416 # environment (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1417 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1418 # create a documentation set, doxygen will generate a Makefile in the HTML
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1419 # output directory. Running make will produce the docset in that directory and
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1420 # running make install will install the docset in
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1421 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1422 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1423 # genXcode/_index.html for more information.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1424 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1425 # 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
1426
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1427 GENERATE_DOCSET = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1428
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1429 # 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
1430 # 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
1431 # (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
1432 # 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
1433 # 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
1434
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1435 DOCSET_FEEDNAME = "Doxygen generated docs"
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1436
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1437 # This tag determines the URL of the docset feed. A documentation feed provides
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1438 # an umbrella under which multiple documentation sets from a single provider
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1439 # (such as a company or product suite) can be grouped.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1440 # This tag requires that the tag GENERATE_DOCSET is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1441
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1442 DOCSET_FEEDURL =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1443
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1444 # 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
1445 # 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
1446 # 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
1447 # 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
1448 # 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
1449
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1450 DOCSET_BUNDLE_ID = org.doxygen.Project
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1451
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1452 # 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
1453 # 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
1454 # 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
1455 # 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
1456 # 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
1457
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1458 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1459
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1460 # 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
1461 # The default value is: Publisher.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1462 # 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
1463
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1464 DOCSET_PUBLISHER_NAME = Publisher
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1465
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1466 # 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
1467 # 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
1468 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1469 # on Windows. In the beginning of 2021 Microsoft took the original page, with
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1470 # a.o. the download links, offline the HTML help workshop was already many years
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1471 # in maintenance mode). You can download the HTML help workshop from the web
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1472 # archives at Installation executable (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1473 # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1474 # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1475 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1476 # 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
1477 # 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
1478 # 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
1479 # 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
1480 # 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
1481 # 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
1482 # compressed HTML files.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1483 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1484 # 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
1485
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1486 GENERATE_HTMLHELP = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1487
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1488 # 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
1489 # 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
1490 # 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
1491 # 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
1492
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1493 CHM_FILE =
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 # The HHC_LOCATION tag can be used to specify the location (absolute path
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1496 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1497 # 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
1498 # 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
1499 # 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
1500
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1501 HHC_LOCATION =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1502
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1503 # The GENERATE_CHI flag controls if a separate .chi index file is generated
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1504 # (YES) or that it should be included in the main .chm file (NO).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1505 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1506 # 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
1507
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1508 GENERATE_CHI = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1509
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1510 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1511 # and project file content.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1512 # 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
1513
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1514 CHM_INDEX_ENCODING =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1515
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1516 # The BINARY_TOC flag controls whether a binary table of contents is generated
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1517 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1518 # enables the Previous and Next buttons.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1519 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1520 # 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
1521
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1522 BINARY_TOC = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1523
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1524 # 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
1525 # 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
1526 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1527 # 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
1528
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1529 TOC_EXPAND = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1530
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1531 # 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
1532 # 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
1533 # 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
1534 # (.qch) of the generated HTML documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1535 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1536 # 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
1537
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1538 GENERATE_QHP = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1539
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1540 # 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
1541 # 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
1542 # the HTML output folder.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1543 # 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
1544
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1545 QCH_FILE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1546
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1547 # 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
1548 # Project output. For more information please see Qt Help Project / Namespace
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1549 # (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1550 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1551 # 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
1552 # 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
1553
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1554 QHP_NAMESPACE = org.doxygen.Project
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1555
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1556 # 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
1557 # Help Project output. For more information please see Qt Help Project / Virtual
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1558 # Folders (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1559 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1560 # The default value is: doc.
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_QHP 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 QHP_VIRTUAL_FOLDER = doc
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1564
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1565 # 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
1566 # filter to add. For more information please see Qt Help Project / Custom
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1567 # Filters (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1568 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1569 # 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
1570
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1571 QHP_CUST_FILTER_NAME =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1572
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1573 # 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
1574 # custom filter to add. For more information please see Qt Help Project / Custom
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1575 # Filters (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1576 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1577 # 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
1578
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1579 QHP_CUST_FILTER_ATTRS =
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 # 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
1582 # project's filter section matches. Qt Help Project / Filter Attributes (see:
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1583 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1584 # 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
1585
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1586 QHP_SECT_FILTER_ATTRS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1587
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1588 # The QHG_LOCATION tag can be used to specify the location (absolute path
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1589 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1590 # run qhelpgenerator on the generated .qhp file.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1591 # 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
1592
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1593 QHG_LOCATION =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1594
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1595 # 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
1596 # 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
1597 # 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
1598 # 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
1599 # 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
1600 # 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
1601 # 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
1602 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1603 # 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
1604
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1605 GENERATE_ECLIPSEHELP = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1606
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1607 # 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
1608 # 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
1609 # 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
1610 # 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
1611 # 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
1612
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1613 ECLIPSE_DOC_ID = org.doxygen.Project
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1614
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1615 # 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
1616 # 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
1617 # 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
1618 # 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
1619 # 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
1620 # 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
1621 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1622 # 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
1623
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1624 DISABLE_INDEX = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1625
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1626 # 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
1627 # 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
1628 # 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
1629 # 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
1630 # 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
1631 # (i.e. any modern browser). Windows users are probably better off using the
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1632 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1633 # further fine tune the look of the index (see "Fine-tuning the output"). As an
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1634 # example, the default style sheet generated by doxygen has an example that
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1635 # shows how to put an image at the root of the tree instead of the PROJECT_NAME.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1636 # Since the tree basically has the same information as the tab index, you could
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1637 # consider setting DISABLE_INDEX to YES when enabling this option.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1638 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1639 # 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
1640
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1641 GENERATE_TREEVIEW = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1642
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1643 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1644 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1645 # area (value NO) or if it should extend to the full height of the window (value
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1646 # YES). Setting this to YES gives a layout similar to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1647 # https://docs.readthedocs.io with more room for contents, but less room for the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1648 # project logo, title, and description. If either GENERATE_TREEVIEW or
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1649 # DISABLE_INDEX is set to NO, this option has no effect.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1650 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1651 # This tag requires that the tag GENERATE_HTML is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1652
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1653 FULL_SIDEBAR = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1654
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1655 # 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
1656 # 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
1657 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1658 # 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
1659 # in the overview section.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1660 # 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
1661 # 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
1662
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1663 ENUM_VALUES_PER_LINE = 4
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1664
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1665 # 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
1666 # 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
1667 # 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
1668 # 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
1669
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1670 TREEVIEW_WIDTH = 250
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1671
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1672 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1673 # 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
1674 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1675 # 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
1676
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1677 EXT_LINKS_IN_WINDOW = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1678
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1679 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1680 # addresses.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1681 # The default value is: YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1682 # This tag requires that the tag GENERATE_HTML is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1683
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1684 OBFUSCATE_EMAILS = YES
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1685
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1686 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1687 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1688 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1689 # the HTML output. These images will generally look nicer at scaled resolutions.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1690 # Possible values are: png (the default) and svg (looks nicer but requires the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1691 # pdf2svg or inkscape tool).
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1692 # The default value is: png.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1693 # This tag requires that the tag GENERATE_HTML is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1694
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1695 HTML_FORMULA_FORMAT = png
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1696
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1697 # 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
1698 # 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
1699 # 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
1700 # 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
1701 # 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
1702 # 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
1703
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1704 FORMULA_FONTSIZE = 10
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1705
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1706 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1707 # to create new LaTeX commands to be used in formulas as building blocks. See
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1708 # the section "Including formulas" for details.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1709
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1710 FORMULA_MACROFILE =
114
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 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1713 # https://www.mathjax.org) which uses client side JavaScript for the rendering
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1714 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1715 # 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
1716 # 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
1717 # 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
1718 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1719 # 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
1720
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1721 USE_MATHJAX = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1722
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1723 # With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1724 # Note that the different versions of MathJax have different requirements with
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1725 # regards to the different settings, so it is possible that also other MathJax
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1726 # settings have to be changed when switching between the different MathJax
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1727 # versions.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1728 # Possible values are: MathJax_2 and MathJax_3.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1729 # The default value is: MathJax_2.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1730 # This tag requires that the tag USE_MATHJAX is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1731
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1732 MATHJAX_VERSION = MathJax_2
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1733
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1734 # When MathJax is enabled you can set the default output format to be used for
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1735 # the MathJax output. For more details about the output format see MathJax
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1736 # version 2 (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1737 # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1738 # (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1739 # http://docs.mathjax.org/en/latest/web/components/output.html).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1740 # Possible values are: HTML-CSS (which is slower, but has the best
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1741 # compatibility. This is the name for Mathjax version 2, for MathJax version 3
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1742 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1743 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1744 # is the name for Mathjax version 3, for MathJax version 2 this will be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1745 # translated into HTML-CSS) and SVG.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1746 # The default value is: HTML-CSS.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1747 # 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
1748
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1749 MATHJAX_FORMAT = HTML-CSS
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1750
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1751 # 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
1752 # 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
1753 # 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
1754 # 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
1755 # 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
1756 # 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
1757 # MathJax. However, it is strongly recommended to install a local copy of
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1758 # MathJax from https://www.mathjax.org before deployment. The default value is:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1759 # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1760 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1761 # 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
1762
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1763 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1764
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1765 # 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
1766 # extension names that should be enabled during MathJax rendering. For example
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1767 # for MathJax version 2 (see
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1768 # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1769 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1770 # For example for MathJax version 3 (see
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1771 # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1772 # MATHJAX_EXTENSIONS = ams
208
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 USE_MATHJAX 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 MATHJAX_EXTENSIONS =
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 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
1778 # of code that will be used on startup of the MathJax code. See the MathJax site
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1779 # (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1780 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1781 # example see the documentation.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1782 # 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
1783
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1784 MATHJAX_CODEFILE =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1785
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1786 # 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
1787 # 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
1788 # 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
1789 # (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
1790 # 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
1791 # 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
1792 # 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
1793 # 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
1794 # (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
1795 # <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
1796 # 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
1797 # 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
1798 # 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
1799 # 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
1800 # 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
1801 # option.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1802 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1803 # 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
1804
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1805 SEARCHENGINE = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1806
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1807 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1808 # implemented using a web server instead of a web client using JavaScript. There
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1809 # 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
1810 # 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
1811 # 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
1812 # 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
1813 # "External Indexing and Searching" for details.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1814 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1815 # 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
1816
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1817 SERVER_BASED_SEARCH = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1818
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1819 # 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
1820 # 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
1821 # 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
1822 # 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
1823 # search results.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1824 #
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1825 # Doxygen ships with an example indexer (doxyindexer) and search engine
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1826 # (doxysearch.cgi) which are based on the open source search engine library
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1827 # Xapian (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1828 # https://xapian.org/).
208
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 # 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
1831 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1832 # 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
1833
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1834 EXTERNAL_SEARCH = NO
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 # 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
1837 # 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
1838 #
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1839 # Doxygen ships with an example indexer (doxyindexer) and search engine
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1840 # (doxysearch.cgi) which are based on the open source search engine library
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1841 # Xapian (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1842 # https://xapian.org/). See the section "External Indexing and Searching" for
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1843 # details.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1844 # 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
1845
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1846 SEARCHENGINE_URL =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1847
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1848 # 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
1849 # 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
1850 # 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
1851 # The default file is: searchdata.xml.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1852 # 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
1853
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1854 SEARCHDATA_FILE = searchdata.xml
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1855
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1856 # 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
1857 # 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
1858 # 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
1859 # 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
1860 # 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
1861
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1862 EXTERNAL_SEARCH_ID =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1863
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1864 # 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
1865 # 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
1866 # 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
1867 # 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
1868 # 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
1869 # 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
1870 # 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
1871
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1872 EXTRA_SEARCH_MAPPINGS =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1873
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1874 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1875 # 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
1876 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1877
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1878 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1879 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1880
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1881 GENERATE_LATEX = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1882
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1883 # 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
1884 # 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
1885 # it.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1886 # The default directory is: latex.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1887 # 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
1888
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1889 LATEX_OUTPUT = latex
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 # 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
1892 # invoked.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1893 #
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1894 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1895 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1896 # chosen this is overwritten by pdflatex. For specific output languages the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1897 # default can have been set differently, this depends on the implementation of
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1898 # the output language.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1899 # 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
1900
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1901 LATEX_CMD_NAME = latex
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1902
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1903 # 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
1904 # index for LaTeX.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1905 # Note: This tag is used in the Makefile / make.bat.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1906 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1907 # (.tex).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1908 # The default file is: makeindex.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1909 # 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
1910
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1911 MAKEINDEX_CMD_NAME = makeindex
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1912
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1913 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1914 # generate index for LaTeX. In case there is no backslash (\) as first character
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1915 # it will be automatically added in the LaTeX code.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1916 # Note: This tag is used in the generated output file (.tex).
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1917 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1918 # The default value is: makeindex.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1919 # This tag requires that the tag GENERATE_LATEX is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1920
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1921 LATEX_MAKEINDEX_CMD = makeindex
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1922
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1923 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1924 # 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
1925 # trees in general.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1926 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1927 # 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
1928
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1929 COMPACT_LATEX = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1930
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1931 # 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
1932 # printer.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1933 # 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
1934 # 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
1935 # The default value is: a4.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1936 # 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
1937
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1938 PAPER_TYPE = a4
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1939
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1940 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1941 # that should be included in the LaTeX output. The package can be specified just
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1942 # by its name or with the correct syntax as to be used with the LaTeX
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1943 # \usepackage command. To get the times font for instance you can specify :
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1944 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1945 # To use the option intlimits with the amsmath package you can specify:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1946 # EXTRA_PACKAGES=[intlimits]{amsmath}
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1947 # 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
1948 # 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
1949
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1950 EXTRA_PACKAGES =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1951
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1952 # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1953 # the generated LaTeX document. The header should contain everything until the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1954 # first chapter. If it is left blank doxygen will generate a standard header. It
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1955 # is highly recommended to start with a default header using
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1956 # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1957 # and then modify the file new_header.tex. See also section "Doxygen usage" for
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1958 # information on how to generate the default header that doxygen normally uses.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1959 #
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1960 # Note: Only use a user-defined header if you know what you are doing!
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1961 # Note: The header is subject to change so you typically have to regenerate the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1962 # default header when upgrading to a newer version of doxygen. The following
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1963 # commands have a special meaning inside the header (and footer): For a
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1964 # description of the possible markers and block names see the documentation.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1965 # 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
1966
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1967 LATEX_HEADER =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1968
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1969 # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1970 # the generated LaTeX document. The footer should contain everything after the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1971 # last chapter. If it is left blank doxygen will generate a standard footer. See
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1972 # LATEX_HEADER for more information on how to generate a default footer and what
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1973 # special commands can be used inside the footer. See also section "Doxygen
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1974 # usage" for information on how to generate the default footer that doxygen
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1975 # normally uses. Note: Only use a user-defined footer if you know what you are
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1976 # doing!
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1977 # 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
1978
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1979 LATEX_FOOTER =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1980
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1981 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1982 # LaTeX style sheets that are included after the standard style sheets created
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1983 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1984 # will copy the style sheet files to the output directory.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1985 # Note: The order of the extra style sheet files is of importance (e.g. the last
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1986 # style sheet in the list overrules the setting of the previous ones in the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1987 # list).
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1988 # This tag requires that the tag GENERATE_LATEX is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1989
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1990 LATEX_EXTRA_STYLESHEET =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
1991
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1992 # 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
1993 # 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
1994 # 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
1995 # markers available.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1996 # 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
1997
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1998 LATEX_EXTRA_FILES =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
1999
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2000 # 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
2001 # 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
2002 # 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
2003 # 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
2004 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2005 # 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
2006
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2007 PDF_HYPERLINKS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2008
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2009 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2010 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2011 # files. Set this option to YES, to get a higher quality PDF documentation.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2012 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2013 # See also section LATEX_CMD_NAME for selecting the engine.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2014 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2015 # 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
2016
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2017 USE_PDFLATEX = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2018
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2019 # 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
2020 # command to the generated LaTeX files. This will instruct LaTeX to keep running
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2021 # if errors occur, instead of asking the user for help.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2022 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2023 # 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
2024
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2025 LATEX_BATCHMODE = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2026
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2027 # 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
2028 # 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
2029 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2030 # 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
2031
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2032 LATEX_HIDE_INDICES = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2033
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2034 # 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
2035 # bibliography, e.g. plainnat, or ieeetr. See
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2036 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2037 # The default value is: plain.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2038 # 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
2039
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2040 LATEX_BIB_STYLE = plain
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2041
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2042 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2043 # page will contain the date and time when the page was generated. Setting this
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2044 # to NO can help when comparing the output of multiple runs.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2045 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2046 # This tag requires that the tag GENERATE_LATEX is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2047
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2048 LATEX_TIMESTAMP = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2049
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2050 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2051 # path from which the emoji images will be read. If a relative path is entered,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2052 # it will be relative to the LATEX_OUTPUT directory. If left blank the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2053 # LATEX_OUTPUT directory will be used.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2054 # This tag requires that the tag GENERATE_LATEX is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2055
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2056 LATEX_EMOJI_DIRECTORY =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2057
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2058 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2059 # 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
2060 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2061
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2062 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2063 # 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
2064 # readers/editors.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2065 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2066
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2067 GENERATE_RTF = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2068
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2069 # 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
2070 # 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
2071 # it.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2072 # The default directory is: rtf.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2073 # 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
2074
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2075 RTF_OUTPUT = rtf
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2076
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2077 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2078 # 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
2079 # trees in general.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2080 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2081 # 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
2082
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2083 COMPACT_RTF = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2084
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2085 # 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
2086 # 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
2087 # 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
2088 # 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
2089 # fields.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2090 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2091 # 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
2092 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2093 # 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
2094
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2095 RTF_HYPERLINKS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2096
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2097 # Load stylesheet definitions from file. Syntax is similar to doxygen's
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2098 # configuration file, i.e. a series of assignments. You only have to provide
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2099 # replacements, missing definitions are set to their default value.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2100 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2101 # 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
2102 # 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
2103 # 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
2104
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2105 RTF_STYLESHEET_FILE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2106
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2107 # Set optional variables used in the generation of an RTF document. Syntax is
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2108 # similar to doxygen's configuration file. A template extensions file can be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2109 # generated using doxygen -e rtf extensionFile.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2110 # 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
2111
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2112 RTF_EXTENSIONS_FILE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2113
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2114 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2115 # 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
2116 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2117
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2118 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2119 # classes and files.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2120 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2121
266
33d229634809 toc for examples
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
2122 GENERATE_MAN = NO
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2123
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2124 # 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
2125 # 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
2126 # 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
2127 # MAN_OUTPUT.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2128 # The default directory is: man.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2129 # 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
2130
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2131 MAN_OUTPUT = man
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2132
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2133 # 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
2134 # 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
2135 # 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
2136 # optional.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2137 # The default value is: .3.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2138 # 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
2139
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2140 MAN_EXTENSION = .3
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2141
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2142 # 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
2143 # 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
2144 # MAN_EXTENSION with the initial . removed.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2145 # 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
2146
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2147 MAN_SUBDIR =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2148
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2149 # 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
2150 # 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
2151 # 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
2152 # 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
2153 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2154 # 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
2155
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2156 MAN_LINKS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2157
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2158 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2159 # 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
2160 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2161
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2162 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2163 # 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
2164 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2165
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2166 GENERATE_XML = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2167
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2168 # 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
2169 # 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
2170 # it.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2171 # The default directory is: xml.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2172 # 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
2173
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2174 XML_OUTPUT = xml
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2175
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2176 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2177 # 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
2178 # 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
2179 # of the XML output.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2180 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2181 # 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
2182
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2183 XML_PROGRAMLISTING = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2184
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2185 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2186 # namespace members in file scope as well, matching the HTML output.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2187 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2188 # This tag requires that the tag GENERATE_XML is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2189
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2190 XML_NS_MEMB_FILE_SCOPE = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2191
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2192 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2193 # 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
2194 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2195
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2196 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2197 # 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
2198 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2199
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2200 GENERATE_DOCBOOK = NO
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2201
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2202 # 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
2203 # 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
2204 # front of it.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2205 # The default directory is: docbook.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2206 # 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
2207
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2208 DOCBOOK_OUTPUT = docbook
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2209
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2210 #---------------------------------------------------------------------------
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2211 # 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
2212 #---------------------------------------------------------------------------
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2213
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2214 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2215 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2216 # the structure of the code including all documentation. Note that this feature
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2217 # is still experimental and incomplete at the moment.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2218 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2219
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2220 GENERATE_AUTOGEN_DEF = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2221
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2222 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2223 # 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
2224 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2225
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2226 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2227 # 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
2228 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2229 # 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
2230 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2231
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2232 GENERATE_PERLMOD = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2233
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2234 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2235 # 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
2236 # output from the Perl module output.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2237 # The default value is: NO.
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 GENERATE_PERLMOD 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 PERLMOD_LATEX = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2241
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2242 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2243 # formatted so it can be parsed by a human reader. This is useful if you want to
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2244 # understand what is going on. On the other hand, if this tag is set to NO, the
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2245 # 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
2246 # just the same.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2247 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2248 # 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
2249
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2250 PERLMOD_PRETTY = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2251
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2252 # 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
2253 # 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
2254 # 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
2255 # overwrite each other's variables.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2256 # 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
2257
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2258 PERLMOD_MAKEVAR_PREFIX =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2259
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2260 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2261 # Configuration options related to the preprocessor
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2262 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2263
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2264 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2265 # 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
2266 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2267
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2268 ENABLE_PREPROCESSING = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2269
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2270 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2271 # in the source code. If set to NO, only conditional compilation will be
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2272 # 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
2273 # EXPAND_ONLY_PREDEF to YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2274 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2275 # 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
2276
502
33e7b6ebf403 change Doxyfile to ignore __attribute__ and include static inline functions
Mike Becker <universe@uap-core.de>
parents: 463
diff changeset
2277 MACRO_EXPANSION = YES
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2278
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2279 # 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
2280 # 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
2281 # EXPAND_AS_DEFINED tags.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2282 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2283 # 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
2284
502
33e7b6ebf403 change Doxyfile to ignore __attribute__ and include static inline functions
Mike Becker <universe@uap-core.de>
parents: 463
diff changeset
2285 EXPAND_ONLY_PREDEF = YES
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2286
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2287 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2288 # 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
2289 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2290 # 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
2291
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2292 SEARCH_INCLUDES = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2293
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2294 # 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
2295 # contain include files that are not input files but should be processed by the
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2296 # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2297 # RECURSIVE has no effect here.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2298 # 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
2299
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2300 INCLUDE_PATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2301
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2302 # 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
2303 # 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
2304 # 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
2305 # used.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2306 # 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
2307
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2308 INCLUDE_FILE_PATTERNS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2309
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2310 # 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
2311 # 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
2312 # 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
2313 # 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
2314 # 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
2315 # 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
2316 # 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
2317
502
33e7b6ebf403 change Doxyfile to ignore __attribute__ and include static inline functions
Mike Becker <universe@uap-core.de>
parents: 463
diff changeset
2318 PREDEFINED = __attribute__(x)=
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2319
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2320 # 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
2321 # 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
2322 # 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
2323 # 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
2324 # definition found in the source code.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2325 # 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
2326
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2327 EXPAND_AS_DEFINED =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2328
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2329 # 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
2330 # 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
2331 # 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
2332 # 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
2333 # removed.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2334 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2335 # 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
2336
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2337 SKIP_FUNCTION_MACROS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2338
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2339 #---------------------------------------------------------------------------
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2340 # Configuration options related to external references
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2341 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2342
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2343 # 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
2344 # 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
2345 # 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
2346 # TAGFILES = file1 file2 ...
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2347 # 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
2348 # TAGFILES = file1=loc1 "file2 = loc2" ...
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2349 # 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
2350 # 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
2351 # of tag files.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2352 # 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
2353 # 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
2354 # 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
2355
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2356 TAGFILES =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2357
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2358 # 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
2359 # 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
2360 # 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
2361
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2362 GENERATE_TAGFILE =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2363
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2364 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2365 # the class index. If set to NO, only the inherited external classes will be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2366 # listed.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2367 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2368
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2369 ALLEXTERNALS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2370
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2371 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2372 # in the modules index. If set to NO, only the current project's groups will be
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2373 # listed.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2374 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2375
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2376 EXTERNAL_GROUPS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2377
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2378 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2379 # 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
2380 # be listed.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2381 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2382
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2383 EXTERNAL_PAGES = YES
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2384
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2385 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2386 # Configuration options related to the dot tool
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2387 #---------------------------------------------------------------------------
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2388
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2389 # 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
2390 # 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
2391 # 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
2392 # 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
2393
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2394 DIA_PATH =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2395
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2396 # If set to YES the inheritance and collaboration graphs will hide inheritance
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2397 # 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
2398 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2399
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2400 HIDE_UNDOC_RELATIONS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2401
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2402 # 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
2403 # 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
2404 # 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
2405 # 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
2406 # set to NO
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2407 # The default value is: NO.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2408
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2409 HAVE_DOT = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2410
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2411 # 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
2412 # 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
2413 # 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
2414 # 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
2415 # speed.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2416 # 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
2417 # 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
2418
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2419 DOT_NUM_THREADS = 0
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2420
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2421 # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2422 # subgraphs. When you want a differently looking font in the dot files that
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2423 # doxygen generates you can specify fontname, fontcolor and fontsize attributes.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2424 # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2425 # Edge and Graph Attributes specification</a> You need to make sure dot is able
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2426 # to find the font, which can be done by putting it in a standard location or by
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2427 # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2428 # directory containing the font. Default graphviz fontsize is 14.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2429 # The default value is: fontname=Helvetica,fontsize=10.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2430 # 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
2431
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2432 DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2433
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2434 # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2435 # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2436 # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2437 # arrows shapes.</a>
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2438 # The default value is: labelfontname=Helvetica,labelfontsize=10.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2439 # 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
2440
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2441 DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2442
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2443 # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2444 # around nodes set 'shape=plain' or 'shape=plaintext' <a
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2445 # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2446 # The default value is: shape=box,height=0.2,width=0.4.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2447 # This tag requires that the tag HAVE_DOT is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2448
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2449 DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2450
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2451 # You can set the path where dot can find font specified with fontname in
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2452 # DOT_COMMON_ATTR and others dot attributes.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2453 # 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
2454
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2455 DOT_FONTPATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2456
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2457 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2458 # graph for each documented class showing the direct and indirect inheritance
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2459 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2460 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2461 # to TEXT the direct and indirect inheritance relations will be shown as texts /
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2462 # links.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2463 # Possible values are: NO, YES, TEXT and GRAPH.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2464 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2465
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2466 CLASS_GRAPH = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2467
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2468 # 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
2469 # 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
2470 # 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
2471 # class with other documented classes.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2472 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2473 # 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
2474
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2475 COLLABORATION_GRAPH = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2476
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2477 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2478 # groups, showing the direct groups dependencies. See also the chapter Grouping
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2479 # in the manual.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2480 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2481 # 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
2482
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2483 GROUP_GRAPHS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2484
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2485 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2486 # 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
2487 # Language.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2488 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2489 # 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
2490
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2491 UML_LOOK = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2492
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2493 # 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
2494 # 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
2495 # 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
2496 # 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
2497 # 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
2498 # 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
2499 # 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
2500 # 10.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2501 # Minimum value: 0, maximum value: 100, default value: 10.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2502 # This tag requires that the tag UML_LOOK is set to YES.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2503
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2504 UML_LIMIT_NUM_FIELDS = 10
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2505
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2506 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2507 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2508 # tag is set to YES, doxygen will add type and arguments for attributes and
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2509 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2510 # will not generate fields with class member information in the UML graphs. The
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2511 # class diagrams will look similar to the default class diagrams but using UML
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2512 # notation for the relationships.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2513 # Possible values are: NO, YES and NONE.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2514 # The default value is: NO.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2515 # This tag requires that the tag UML_LOOK is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2516
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2517 DOT_UML_DETAILS = NO
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2518
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2519 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2520 # to display on a single line. If the actual line length exceeds this threshold
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2521 # significantly it will wrapped across multiple lines. Some heuristics are apply
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2522 # to avoid ugly line breaks.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2523 # Minimum value: 0, maximum value: 1000, default value: 17.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2524 # This tag requires that the tag HAVE_DOT is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2525
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2526 DOT_WRAP_THRESHOLD = 17
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2527
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2528 # 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
2529 # 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
2530 # instances.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2531 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2532 # 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
2533
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2534 TEMPLATE_RELATIONS = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2535
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2536 # 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
2537 # 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
2538 # 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
2539 # files.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2540 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2541 # 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
2542
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2543 INCLUDE_GRAPH = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2544
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2545 # 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
2546 # 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
2547 # 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
2548 # files.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2549 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2550 # 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
2551
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2552 INCLUDED_BY_GRAPH = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2553
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2554 # 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
2555 # 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
2556 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2557 # 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
2558 # So in most cases it will be better to enable call graphs for selected
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2559 # functions only using the \callgraph command. Disabling a call graph can be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2560 # accomplished by means of the command \hidecallgraph.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2561 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2562 # 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
2563
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2564 CALL_GRAPH = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2565
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2566 # 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
2567 # 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
2568 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2569 # 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
2570 # So in most cases it will be better to enable caller graphs for selected
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2571 # functions only using the \callergraph command. Disabling a caller graph can be
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2572 # accomplished by means of the command \hidecallergraph.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2573 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2574 # 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
2575
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2576 CALLER_GRAPH = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2577
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2578 # 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
2579 # 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
2580 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2581 # 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
2582
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2583 GRAPHICAL_HIERARCHY = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2584
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2585 # 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
2586 # 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
2587 # 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
2588 # files in the directories.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2589 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2590 # 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
2591
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2592 DIRECTORY_GRAPH = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2593
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2594 # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2595 # of child directories generated in directory dependency graphs by dot.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2596 # Minimum value: 1, maximum value: 25, default value: 1.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2597 # This tag requires that the tag DIRECTORY_GRAPH is set to YES.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2598
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2599 DIR_GRAPH_MAX_DEPTH = 1
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2600
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2601 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2602 # generated by dot. For an explanation of the image formats see the section
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2603 # output formats in the documentation of the dot tool (Graphviz (see:
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2604 # http://www.graphviz.org/)).
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2605 # 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
2606 # 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
2607 # requirement).
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2608 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2609 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2610 # png:gdiplus:gdiplus.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2611 # The default value is: png.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2612 # 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
2613
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2614 DOT_IMAGE_FORMAT = png
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2615
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2616 # 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
2617 # 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
2618 #
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2619 # 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
2620 # 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
2621 # 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
2622 # 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
2623 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2624 # 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
2625
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2626 INTERACTIVE_SVG = NO
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2627
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2628 # 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
2629 # 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
2630 # 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
2631
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2632 DOT_PATH =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2633
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2634 # 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
2635 # 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
2636 # command).
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2637 # 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
2638
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2639 DOTFILE_DIRS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2640
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2641 # 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
2642 # 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
2643 # command).
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2644
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2645 MSCFILE_DIRS =
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2646
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2647 # 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
2648 # 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
2649 # command).
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2650
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2651 DIAFILE_DIRS =
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2652
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2653 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2654 # path where java can find the plantuml.jar file or to the filename of jar file
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2655 # to be used. If left blank, it is assumed PlantUML is not used or called during
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2656 # a preprocessing step. Doxygen will generate a warning when it encounters a
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2657 # \startuml command in this case and will not generate output for the diagram.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2658
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2659 PLANTUML_JAR_PATH =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2660
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2661 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2662 # configuration file for plantuml.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2663
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2664 PLANTUML_CFG_FILE =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2665
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2666 # When using plantuml, the specified paths are searched for files specified by
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2667 # the !include statement in a plantuml block.
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2668
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2669 PLANTUML_INCLUDE_PATH =
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2670
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2671 # 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
2672 # 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
2673 # 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
2674 # 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
2675 # 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
2676 # 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
2677 # 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
2678 # 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
2679 # 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
2680
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2681 DOT_GRAPH_MAX_NODES = 50
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2682
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2683 # 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
2684 # 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
2685 # 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
2686 # 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
2687 # 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
2688 # 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
2689 # 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
2690 # 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
2691 # 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
2692
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2693 MAX_DOT_GRAPH_DEPTH = 0
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2694
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2695 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2696 # 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
2697 # 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
2698 # 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
2699 # The default value is: NO.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2700 # 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
2701
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2702 DOT_MULTI_TARGETS = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2703
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2704 # 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
2705 # 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
2706 # graphs.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2707 # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2708 # graphical representation for inheritance and collaboration diagrams is used.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2709 # The default value is: YES.
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2710 # 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
2711
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2712 GENERATE_LEGEND = YES
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2713
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2714 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2715 # files that are used to generate the various graphs.
711
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2716 #
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2717 # Note: This setting is not only used for dot files but also for msc temporary
71b2f3f63182 update Doxyfile to Doxygen 1.9.6
Mike Becker <universe@uap-core.de>
parents: 502
diff changeset
2718 # files.
208
262c7be94eba added convenience function ucx_map_free_contents()
Mike Becker <universe@uap-core.de>
parents: 192
diff changeset
2719 # The default value is: YES.
114
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2720
5a0859739b76 added doxyfile and documentation for ucx.h
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2721 DOT_CLEANUP = YES

mercurial