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