annotate doxygen.conf @ 1678:c029adbabb70

do not try to reload deleted image deleted image is replaced by the next one from the list, keep the old image displayed until the new one is set
author nadvornik
date Fri, 24 Jul 2009 12:56:54 +0000
parents fbd02e4d709e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1454
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1 # Doxyfile 1.5.4
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
2
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
3 # This file describes the settings to be used by the documentation system
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
4 # doxygen (www.doxygen.org) for a project
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
5 #
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
6 # All text after a hash (#) is considered a comment and will be ignored
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
7 # The format is:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
8 # TAG = value [value, ...]
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
9 # For lists items can also be appended using:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
10 # TAG += value [value, ...]
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
11 # Values that contain spaces should be placed between quotes (" ")
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
12
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
13 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
14 # Project related configuration options
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
15 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
16
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
17 # This tag specifies the encoding used for all characters in the config file that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
18 # follow. The default is UTF-8 which is also the encoding used for all text before
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
21 # possible encodings.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
22
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
23 DOXYFILE_ENCODING = UTF-8
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
24
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
26 # by quotes) that should identify the project.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
27
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
28 PROJECT_NAME = $(PROJECT)-$(VERSION)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
29
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
31 # This could be handy for archiving the generated documentation or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
32 # if some version control system is used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
33
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
34 PROJECT_NUMBER =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
35
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
37 # base path where the generated documentation will be put.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
38 # If a relative path is entered, it will be relative to the location
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
39 # where doxygen was started. If left blank the current directory will be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
40
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
41 OUTPUT_DIRECTORY = $(DOCDIR)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
42
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
45 # format and will distribute the generated files over these directories.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
46 # Enabling this option can be useful when feeding doxygen a huge amount of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
47 # source files, where putting all generated files in the same directory would
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
48 # otherwise cause performance problems for the file system.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
49
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
50 CREATE_SUBDIRS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
51
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
53 # documentation generated by doxygen is written. Doxygen will use this
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
54 # information to generate all constant output in the proper language.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
55 # The default language is English, other supported languages are:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
61
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
62 OUTPUT_LANGUAGE = English
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
63
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
65 # include brief member descriptions after the members that are listed in
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
66 # the file and class documentation (similar to JavaDoc).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
67 # Set to NO to disable this.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
68
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
69 BRIEF_MEMBER_DESC = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
70
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
72 # the brief description of a member or function before the detailed description.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
74 # brief descriptions will be completely suppressed.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
75
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
76 REPEAT_BRIEF = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
77
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
78 # This tag implements a quasi-intelligent brief description abbreviator
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
79 # that is used to form the text in various listings. Each string
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
80 # in this list, if found as the leading text of the brief description, will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
81 # stripped from the text and the result after processing the whole list, is
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
82 # used as the annotated text. Otherwise, the brief description is used as-is.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
83 # If left blank, the following values are used ("$name" is automatically
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
84 # replaced with the name of the entity): "The $name class" "The $name widget"
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
85 # "The $name file" "is" "provides" "specifies" "contains"
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
86 # "represents" "a" "an" "the"
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
87
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
88 ABBREVIATE_BRIEF =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
89
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
91 # Doxygen will generate a detailed section even if there is only a brief
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
92 # description.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
93
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
94 ALWAYS_DETAILED_SEC = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
95
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
97 # inherited members of a class in the documentation of that class as if those
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
98 # members were ordinary class members. Constructors, destructors and assignment
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
99 # operators of the base classes will not be shown.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
100
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
101 INLINE_INHERITED_MEMB = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
102
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
104 # path before files name in the file list and in the header files. If set
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
105 # to NO the shortest path that makes the file name unique will be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
106
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
107 FULL_PATH_NAMES = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
108
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
110 # can be used to strip a user-defined part of the path. Stripping is
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
111 # only done if one of the specified strings matches the left-hand part of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
112 # the path. The tag can be used to show relative paths in the file list.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
113 # If left blank the directory from which doxygen is run is used as the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
114 # path to strip.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
115
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
116 STRIP_FROM_PATH = $(SRCDIR)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
117
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
119 # the path mentioned in the documentation of a class, which tells
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
120 # the reader which header file to include in order to use a class.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
121 # If left blank only the name of the header file containing the class
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
122 # definition is used. Otherwise one should specify the include paths that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
123 # are normally passed to the compiler using the -I flag.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
124
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
125 STRIP_FROM_INC_PATH =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
126
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
128 # (but less readable) file names. This can be useful is your file systems
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
129 # doesn't support long names like on DOS, Mac, or CD-ROM.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
130
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
131 SHORT_NAMES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
132
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
134 # will interpret the first line (until the first dot) of a JavaDoc-style
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
135 # comment as the brief description. If set to NO, the JavaDoc
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
136 # comments will behave just like regular Qt-style comments
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
137 # (thus requiring an explicit @brief command for a brief description.)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
138
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
139 JAVADOC_AUTOBRIEF = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
140
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
142 # interpret the first line (until the first dot) of a Qt-style
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
143 # comment as the brief description. If set to NO, the comments
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
144 # will behave just like regular Qt-style comments (thus requiring
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
145 # an explicit \brief command for a brief description.)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
146
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
147 QT_AUTOBRIEF = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
148
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
150 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
151 # comments) as a brief description. This used to be the default behaviour.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
152 # The new default is to treat a multi-line C++ comment block as a detailed
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
153 # description. Set this tag to YES if you prefer the old behaviour instead.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
154
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
155 MULTILINE_CPP_IS_BRIEF = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
156
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
158 # will output the detailed description near the top, like JavaDoc.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
159 # If set to NO, the detailed description appears after the member
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
160 # documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
161
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
162 DETAILS_AT_TOP = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
163
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
165 # member inherits the documentation from any documented member that it
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
166 # re-implements.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
167
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
168 INHERIT_DOCS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
169
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
171 # a new page for each member. If set to NO, the documentation of a member will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
172 # be part of the file/class/namespace that contains it.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
173
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
174 SEPARATE_MEMBER_PAGES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
175
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
176 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
177 # Doxygen uses this value to replace tabs by spaces in code fragments.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
178
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
179 TAB_SIZE = 8
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
180
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
181 # This tag can be used to specify a number of aliases that acts
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
182 # as commands in the documentation. An alias has the form "name=value".
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
184 # put the command \sideeffect (or @sideeffect) in the documentation, which
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
185 # will result in a user-defined paragraph with heading "Side Effects:".
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
186 # You can put \n's in the value part of an alias to insert newlines.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
187
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
188 ALIASES =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
189
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
190 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
191 # sources only. Doxygen will then generate output that is more tailored for C.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
192 # For instance, some of the names that are used will be different. The list
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
193 # of all members will be omitted, etc.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
194
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
195 OPTIMIZE_OUTPUT_FOR_C = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
196
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
197 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
198 # sources only. Doxygen will then generate output that is more tailored for Java.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
199 # For instance, namespaces will be presented as packages, qualified scopes
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
200 # will look different, etc.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
201
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
202 OPTIMIZE_OUTPUT_JAVA = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
203
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
204 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
205 # include (a tag file for) the STL sources as input, then you should
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
206 # set this tag to YES in order to let doxygen match functions declarations and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
207 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
208 # func(std::string) {}). This also make the inheritance and collaboration
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
209 # diagrams that involve STL classes more complete and accurate.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
210
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
211 BUILTIN_STL_SUPPORT = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
212
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
213 # If you use Microsoft's C++/CLI language, you should set this option to YES to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
214 # enable parsing support.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
215
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
216 CPP_CLI_SUPPORT = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
217
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
218 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
219 # Doxygen will parse them like normal C++ but will assume all classes use public
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
220 # instead of private inheritance when no explicit protection keyword is present.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
221
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
222 SIP_SUPPORT = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
223
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
224 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
225 # tag is set to YES, then doxygen will reuse the documentation of the first
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
226 # member in the group (if any) for the other members of the group. By default
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
227 # all members of a group must be documented explicitly.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
228
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
229 DISTRIBUTE_GROUP_DOC = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
230
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
231 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
232 # the same type (for instance a group of public functions) to be put as a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
233 # subgroup of that type (e.g. under the Public Functions section). Set it to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
234 # NO to prevent subgrouping. Alternatively, this can be done per class using
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
235 # the \nosubgrouping command.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
236
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
237 SUBGROUPING = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
238
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
239 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
240 # documented as struct with the name of the typedef. So
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
241 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
242 # with name TypeT. When disabled the typedef will appear as a member of a file,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
243 # namespace, or class. And the struct will be named TypeS. This can typically
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
244 # be useful for C code where the coding convention is that all structs are
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
245 # typedef'ed and only the typedef is referenced never the struct's name.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
246
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
247 TYPEDEF_HIDES_STRUCT = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
248
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
249 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
250 # Build related configuration options
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
251 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
252
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
253 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
254 # documentation are documented, even if no documentation was available.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
255 # Private class members and static file members will be hidden unless
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
256 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
257
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
258 EXTRACT_ALL = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
259
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
260 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
261 # will be included in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
262
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
263 EXTRACT_PRIVATE = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
264
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
265 # If the EXTRACT_STATIC tag is set to YES all static members of a file
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
266 # will be included in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
267
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
268 EXTRACT_STATIC = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
269
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
270 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
271 # defined locally in source files will be included in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
272 # If set to NO only classes defined in header files are included.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
273
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
274 EXTRACT_LOCAL_CLASSES = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
275
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
276 # This flag is only useful for Objective-C code. When set to YES local
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
277 # methods, which are defined in the implementation section but not in
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
278 # the interface are included in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
279 # If set to NO (the default) only methods in the interface are included.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
280
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
281 EXTRACT_LOCAL_METHODS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
282
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
283 # If this flag is set to YES, the members of anonymous namespaces will be extracted
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
284 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
285 # where file will be replaced with the base name of the file that contains the anonymous
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
286 # namespace. By default anonymous namespace are hidden.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
287
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
288 EXTRACT_ANON_NSPACES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
289
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
290 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
291 # undocumented members of documented classes, files or namespaces.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
292 # If set to NO (the default) these members will be included in the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
293 # various overviews, but no documentation section is generated.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
294 # This option has no effect if EXTRACT_ALL is enabled.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
295
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
296 HIDE_UNDOC_MEMBERS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
297
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
298 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
299 # undocumented classes that are normally visible in the class hierarchy.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
300 # If set to NO (the default) these classes will be included in the various
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
301 # overviews. This option has no effect if EXTRACT_ALL is enabled.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
302
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
303 HIDE_UNDOC_CLASSES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
304
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
305 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
306 # friend (class|struct|union) declarations.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
307 # If set to NO (the default) these declarations will be included in the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
308 # documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
309
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
310 HIDE_FRIEND_COMPOUNDS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
311
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
312 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
313 # documentation blocks found inside the body of a function.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
314 # If set to NO (the default) these blocks will be appended to the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
315 # function's detailed documentation block.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
316
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
317 HIDE_IN_BODY_DOCS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
318
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
319 # The INTERNAL_DOCS tag determines if documentation
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
320 # that is typed after a \internal command is included. If the tag is set
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
321 # to NO (the default) then the documentation will be excluded.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
322 # Set it to YES to include the internal documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
323
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
324 INTERNAL_DOCS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
325
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
326 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
327 # file names in lower-case letters. If set to YES upper-case letters are also
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
328 # allowed. This is useful if you have classes or files whose names only differ
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
329 # in case and if your file system supports case sensitive file names. Windows
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
330 # and Mac users are advised to set this option to NO.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
331
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
332 CASE_SENSE_NAMES = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
333
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
334 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
335 # will show members with their full class and namespace scopes in the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
336 # documentation. If set to YES the scope will be hidden.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
337
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
338 HIDE_SCOPE_NAMES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
339
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
340 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
341 # will put a list of the files that are included by a file in the documentation
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
342 # of that file.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
343
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
344 SHOW_INCLUDE_FILES = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
345
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
346 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
347 # is inserted in the documentation for inline members.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
348
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
349 INLINE_INFO = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
350
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
351 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
352 # will sort the (detailed) documentation of file and class members
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
353 # alphabetically by member name. If set to NO the members will appear in
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
354 # declaration order.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
355
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
356 SORT_MEMBER_DOCS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
357
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
358 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
359 # brief documentation of file, namespace and class members alphabetically
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
360 # by member name. If set to NO (the default) the members will appear in
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
361 # declaration order.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
362
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
363 SORT_BRIEF_DOCS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
364
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
365 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
366 # sorted by fully-qualified names, including namespaces. If set to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
367 # NO (the default), the class list will be sorted only by class name,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
368 # not including the namespace part.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
369 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
370 # Note: This option applies only to the class list, not to the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
371 # alphabetical list.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
372
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
373 SORT_BY_SCOPE_NAME = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
374
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
375 # The GENERATE_TODOLIST tag can be used to enable (YES) or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
376 # disable (NO) the todo list. This list is created by putting \todo
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
377 # commands in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
378
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
379 GENERATE_TODOLIST = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
380
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
381 # The GENERATE_TESTLIST tag can be used to enable (YES) or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
382 # disable (NO) the test list. This list is created by putting \test
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
383 # commands in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
384
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
385 GENERATE_TESTLIST = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
386
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
387 # The GENERATE_BUGLIST tag can be used to enable (YES) or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
388 # disable (NO) the bug list. This list is created by putting \bug
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
389 # commands in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
390
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
391 GENERATE_BUGLIST = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
392
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
393 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
394 # disable (NO) the deprecated list. This list is created by putting
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
395 # \deprecated commands in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
396
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
397 GENERATE_DEPRECATEDLIST= YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
398
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
399 # The ENABLED_SECTIONS tag can be used to enable conditional
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
400 # documentation sections, marked by \if sectionname ... \endif.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
401
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
402 ENABLED_SECTIONS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
403
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
404 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
405 # the initial value of a variable or define consists of for it to appear in
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
406 # the documentation. If the initializer consists of more lines than specified
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
407 # here it will be hidden. Use a value of 0 to hide initializers completely.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
408 # The appearance of the initializer of individual variables and defines in the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
409 # documentation can be controlled using \showinitializer or \hideinitializer
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
410 # command in the documentation regardless of this setting.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
411
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
412 MAX_INITIALIZER_LINES = 30
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
413
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
414 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
415 # at the bottom of the documentation of classes and structs. If set to YES the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
416 # list will mention the files that were used to generate the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
417
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
418 SHOW_USED_FILES = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
419
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
420 # If the sources in your project are distributed over multiple directories
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
421 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
422 # in the documentation. The default is NO.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
423
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
424 SHOW_DIRECTORIES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
425
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
426 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
427 # doxygen should invoke to get the current version for each file (typically from the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
428 # version control system). Doxygen will invoke the program by executing (via
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
429 # popen()) the command <command> <input-file>, where <command> is the value of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
430 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
431 # provided by doxygen. Whatever the program writes to standard output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
432 # is used as the file version. See the manual for examples.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
433
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
434 FILE_VERSION_FILTER =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
435
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
436 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
437 # configuration options related to warning and progress messages
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
438 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
439
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
440 # The QUIET tag can be used to turn on/off the messages that are generated
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
441 # by doxygen. Possible values are YES and NO. If left blank NO is used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
442
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
443 QUIET = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
444
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
445 # The WARNINGS tag can be used to turn on/off the warning messages that are
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
446 # generated by doxygen. Possible values are YES and NO. If left blank
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
447 # NO is used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
448
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
449 WARNINGS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
450
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
451 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
452 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
453 # automatically be disabled.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
454
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
455 WARN_IF_UNDOCUMENTED = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
456
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
457 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
458 # potential errors in the documentation, such as not documenting some
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
459 # parameters in a documented function, or documenting parameters that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
460 # don't exist or using markup commands wrongly.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
461
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
462 WARN_IF_DOC_ERROR = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
463
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
464 # This WARN_NO_PARAMDOC option can be abled to get warnings for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
465 # functions that are documented, but have no documentation for their parameters
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
466 # or return value. If set to NO (the default) doxygen will only warn about
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
467 # wrong or incomplete parameter documentation, but not about the absence of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
468 # documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
469
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
470 WARN_NO_PARAMDOC = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
471
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
472 # The WARN_FORMAT tag determines the format of the warning messages that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
473 # doxygen can produce. The string should contain the $file, $line, and $text
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
474 # tags, which will be replaced by the file and line number from which the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
475 # warning originated and the warning text. Optionally the format may contain
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
476 # $version, which will be replaced by the version of the file (if it could
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
477 # be obtained via FILE_VERSION_FILTER)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
478
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
479 WARN_FORMAT = "$file:$line: $text"
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
480
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
481 # The WARN_LOGFILE tag can be used to specify a file to which warning
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
482 # and error messages should be written. If left blank the output is written
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
483 # to stderr.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
484
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
485 WARN_LOGFILE =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
486
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
487 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
488 # configuration options related to the input files
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
489 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
490
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
491 # The INPUT tag can be used to specify the files and/or directories that contain
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
492 # documented source files. You may enter file names like "myfile.cpp" or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
493 # directories like "/usr/src/myproject". Separate the files or directories
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
494 # with spaces.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
495
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
496 INPUT = $(SRCDIR)/src
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
497
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
498 # This tag can be used to specify the character encoding of the source files that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
499 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
500 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
501 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
502
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
503 INPUT_ENCODING = UTF-8
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
504
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
505 # If the value of the INPUT tag contains directories, you can use the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
506 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
507 # and *.h) to filter out the source-files in the directories. If left
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
508 # blank the following patterns are tested:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
509 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
510 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
511
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
512 FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.h *.hh *.hpp *.h++
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
513
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
514 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
515 # should be searched for input files as well. Possible values are YES and NO.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
516 # If left blank NO is used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
517
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
518 RECURSIVE = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
519
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
520 # The EXCLUDE tag can be used to specify files and/or directories that should
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
521 # excluded from the INPUT source files. This way you can easily exclude a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
522 # subdirectory from a directory tree whose root is specified with the INPUT tag.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
523
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
524 EXCLUDE =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
525
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
526 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
527 # directories that are symbolic links (a Unix filesystem feature) are excluded
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
528 # from the input.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
529
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
530 EXCLUDE_SYMLINKS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
531
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
532 # If the value of the INPUT tag contains directories, you can use the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
533 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
534 # certain files from those directories. Note that the wildcards are matched
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
535 # against the file with absolute path, so to exclude all test directories
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
536 # for example use the pattern */test/*
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
537
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
538 EXCLUDE_PATTERNS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
539
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
540 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
541 # (namespaces, classes, functions, etc.) that should be excluded from the output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
542 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
543 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
544
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
545 EXCLUDE_SYMBOLS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
546
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
547 # The EXAMPLE_PATH tag can be used to specify one or more files or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
548 # directories that contain example code fragments that are included (see
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
549 # the \include command).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
550
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
551 EXAMPLE_PATH =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
552
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
553 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
554 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
555 # and *.h) to filter out the source-files in the directories. If left
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
556 # blank all files are included.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
557
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
558 EXAMPLE_PATTERNS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
559
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
560 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
561 # searched for input files to be used with the \include or \dontinclude
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
562 # commands irrespective of the value of the RECURSIVE tag.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
563 # Possible values are YES and NO. If left blank NO is used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
564
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
565 EXAMPLE_RECURSIVE = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
566
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
567 # The IMAGE_PATH tag can be used to specify one or more files or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
568 # directories that contain image that are included in the documentation (see
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
569 # the \image command).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
570
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
571 IMAGE_PATH =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
572
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
573 # The INPUT_FILTER tag can be used to specify a program that doxygen should
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
574 # invoke to filter for each input file. Doxygen will invoke the filter program
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
575 # by executing (via popen()) the command <filter> <input-file>, where <filter>
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
576 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
577 # input file. Doxygen will then use the output that the filter program writes
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
578 # to standard output. If FILTER_PATTERNS is specified, this tag will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
579 # ignored.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
580
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
581 INPUT_FILTER =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
582
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
583 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
584 # basis. Doxygen will compare the file name with each pattern and apply the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
585 # filter if there is a match. The filters are a list of the form:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
586 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
587 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
588 # is applied to all files.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
589
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
590 FILTER_PATTERNS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
591
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
592 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
593 # INPUT_FILTER) will be used to filter the input files when producing source
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
594 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
595
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
596 FILTER_SOURCE_FILES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
597
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
598 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
599 # configuration options related to source browsing
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
600 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
601
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
602 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
603 # be generated. Documented entities will be cross-referenced with these sources.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
604 # Note: To get rid of all source code in the generated output, make sure also
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
605 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
606 # then you must also enable this option. If you don't then doxygen will produce
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
607 # a warning and turn it on anyway
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
608
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
609 SOURCE_BROWSER = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
610
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
611 # Setting the INLINE_SOURCES tag to YES will include the body
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
612 # of functions and classes directly in the documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
613
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
614 INLINE_SOURCES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
615
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
616 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
617 # doxygen to hide any special comment blocks from generated source code
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
618 # fragments. Normal C and C++ comments will always remain visible.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
619
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
620 STRIP_CODE_COMMENTS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
621
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
622 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
623 # then for each documented function all documented
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
624 # functions referencing it will be listed.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
625
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
626 REFERENCED_BY_RELATION = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
627
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
628 # If the REFERENCES_RELATION tag is set to YES (the default)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
629 # then for each documented function all documented entities
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
630 # called/used by that function will be listed.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
631
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
632 REFERENCES_RELATION = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
633
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
634 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
635 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
636 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
637 # link to the source code. Otherwise they will link to the documentstion.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
638
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
639 REFERENCES_LINK_SOURCE = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
640
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
641 # If the USE_HTAGS tag is set to YES then the references to source code
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
642 # will point to the HTML generated by the htags(1) tool instead of doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
643 # built-in source browser. The htags tool is part of GNU's global source
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
644 # tagging system (see http://www.gnu.org/software/global/global.html). You
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
645 # will need version 4.8.6 or higher.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
646
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
647 USE_HTAGS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
648
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
649 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
650 # will generate a verbatim copy of the header file for each class for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
651 # which an include is specified. Set to NO to disable this.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
652
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
653 VERBATIM_HEADERS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
654
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
655 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
656 # configuration options related to the alphabetical class index
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
657 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
658
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
659 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
660 # of all compounds will be generated. Enable this if the project
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
661 # contains a lot of classes, structs, unions or interfaces.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
662
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
663 ALPHABETICAL_INDEX = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
664
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
665 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
666 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
667 # in which this list will be split (can be a number in the range [1..20])
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
668
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
669 COLS_IN_ALPHA_INDEX = 5
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
670
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
671 # In case all classes in a project start with a common prefix, all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
672 # classes will be put under the same header in the alphabetical index.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
673 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
674 # should be ignored while generating the index headers.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
675
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
676 IGNORE_PREFIX =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
677
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
678 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
679 # configuration options related to the HTML output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
680 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
681
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
682 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
683 # generate HTML output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
684
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
685 GENERATE_HTML = $(GENERATE_HTML)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
686
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
687 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
688 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
689 # put in front of it. If left blank `html' will be used as the default path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
690
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
691 HTML_OUTPUT = html
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
692
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
693 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
694 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
695 # doxygen will generate files with .html extension.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
696
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
697 HTML_FILE_EXTENSION = .html
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
698
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
699 # The HTML_HEADER tag can be used to specify a personal HTML header for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
700 # each generated HTML page. If it is left blank doxygen will generate a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
701 # standard header.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
702
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
703 HTML_HEADER =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
704
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
705 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
706 # each generated HTML page. If it is left blank doxygen will generate a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
707 # standard footer.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
708
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
709 HTML_FOOTER =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
710
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
711 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
712 # style sheet that is used by each HTML page. It can be used to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
713 # fine-tune the look of the HTML output. If the tag is left blank doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
714 # will generate a default style sheet. Note that doxygen will try to copy
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
715 # the style sheet file to the HTML output directory, so don't put your own
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
716 # stylesheet in the HTML output directory as well, or it will be erased!
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
717
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
718 HTML_STYLESHEET =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
719
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
720 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
721 # files or namespaces will be aligned in HTML using tables. If set to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
722 # NO a bullet list will be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
723
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
724 HTML_ALIGN_MEMBERS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
725
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
726 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
727 # will be generated that can be used as input for tools like the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
728 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
729 # of the generated HTML documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
730
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
731 GENERATE_HTMLHELP = $(GENERATE_HTMLHELP)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
732
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
733 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
734 # documentation will contain sections that can be hidden and shown after the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
735 # page has loaded. For this to work a browser that supports
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
736 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
737 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
738
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
739 HTML_DYNAMIC_SECTIONS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
740
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
741 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
742 # be used to specify the file name of the resulting .chm file. You
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
743 # can add a path in front of the file if the result should not be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
744 # written to the html output directory.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
745
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
746 CHM_FILE = ../$(PROJECT).chm
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
747
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
748 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
749 # be used to specify the location (absolute path including file name) of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
750 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
751 # the HTML help compiler on the generated index.hhp.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
752
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
753 HHC_LOCATION = $(HHC_PATH)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
754
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
755 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
756 # controls if a separate .chi index file is generated (YES) or that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
757 # it should be included in the master .chm file (NO).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
758
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
759 GENERATE_CHI = $(GENERATE_CHI)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
760
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
761 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
762 # controls whether a binary table of contents is generated (YES) or a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
763 # normal table of contents (NO) in the .chm file.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
764
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
765 BINARY_TOC = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
766
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
767 # The TOC_EXPAND flag can be set to YES to add extra items for group members
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
768 # to the contents of the HTML help documentation and to the tree view.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
769
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
770 TOC_EXPAND = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
771
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
772 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
773 # top of each HTML page. The value NO (the default) enables the index and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
774 # the value YES disables it.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
775
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
776 DISABLE_INDEX = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
777
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
778 # This tag can be used to set the number of enum values (range [1..20])
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
779 # that doxygen will group on one line in the generated HTML documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
780
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
781 ENUM_VALUES_PER_LINE = 4
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
782
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
783 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
784 # generated containing a tree-like index structure (just like the one that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
785 # is generated for HTML Help). For this to work a browser that supports
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
786 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
787 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
788 # probably better off using the HTML help feature.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
789
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
790 GENERATE_TREEVIEW = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
791
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
792 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
793 # used to set the initial width (in pixels) of the frame in which the tree
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
794 # is shown.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
795
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
796 TREEVIEW_WIDTH = 250
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
797
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
798 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
799 # configuration options related to the LaTeX output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
800 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
801
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
802 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
803 # generate Latex output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
804
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
805 GENERATE_LATEX = $(GENERATE_LATEX)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
806
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
807 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
808 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
809 # put in front of it. If left blank `latex' will be used as the default path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
810
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
811 LATEX_OUTPUT = latex
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
812
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
813 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
814 # invoked. If left blank `latex' will be used as the default command name.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
815
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
816 LATEX_CMD_NAME =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
817
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
818 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
819 # generate index for LaTeX. If left blank `makeindex' will be used as the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
820 # default command name.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
821
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
822 MAKEINDEX_CMD_NAME =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
823
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
824 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
825 # LaTeX documents. This may be useful for small projects and may help to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
826 # save some trees in general.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
827
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
828 COMPACT_LATEX = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
829
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
830 # The PAPER_TYPE tag can be used to set the paper type that is used
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
831 # by the printer. Possible values are: a4, a4wide, letter, legal and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
832 # executive. If left blank a4wide will be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
833
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
834 PAPER_TYPE = $(PAPER_SIZE)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
835
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
836 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
837 # packages that should be included in the LaTeX output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
838
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
839 EXTRA_PACKAGES =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
840
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
841 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
842 # the generated latex document. The header should contain everything until
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
843 # the first chapter. If it is left blank doxygen will generate a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
844 # standard header. Notice: only use this tag if you know what you are doing!
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
845
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
846 LATEX_HEADER =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
847
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
848 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
849 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
850 # contain links (just like the HTML output) instead of page references
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
851 # This makes the output suitable for online browsing using a pdf viewer.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
852
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
853 PDF_HYPERLINKS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
854
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
855 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
856 # plain latex in the generated Makefile. Set this option to YES to get a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
857 # higher quality PDF documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
858
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
859 USE_PDFLATEX = $(GENERATE_PDF)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
860
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
861 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
862 # command to the generated LaTeX files. This will instruct LaTeX to keep
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
863 # running if errors occur, instead of asking the user for help.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
864 # This option is also used when generating formulas in HTML.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
865
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
866 LATEX_BATCHMODE = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
867
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
868 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
869 # include the index chapters (such as File Index, Compound Index, etc.)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
870 # in the output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
871
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
872 LATEX_HIDE_INDICES = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
873
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
874 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
875 # configuration options related to the RTF output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
876 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
877
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
878 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
879 # The RTF output is optimized for Word 97 and may not look very pretty with
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
880 # other RTF readers or editors.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
881
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
882 GENERATE_RTF = $(GENERATE_RTF)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
883
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
884 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
885 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
886 # put in front of it. If left blank `rtf' will be used as the default path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
887
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
888 RTF_OUTPUT = rtf
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
889
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
890 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
891 # RTF documents. This may be useful for small projects and may help to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
892 # save some trees in general.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
893
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
894 COMPACT_RTF = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
895
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
896 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
897 # will contain hyperlink fields. The RTF file will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
898 # contain links (just like the HTML output) instead of page references.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
899 # This makes the output suitable for online browsing using WORD or other
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
900 # programs which support those fields.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
901 # Note: wordpad (write) and others do not support links.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
902
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
903 RTF_HYPERLINKS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
904
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
905 # Load stylesheet definitions from file. Syntax is similar to doxygen's
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
906 # config file, i.e. a series of assignments. You only have to provide
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
907 # replacements, missing definitions are set to their default value.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
908
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
909 RTF_STYLESHEET_FILE =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
910
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
911 # Set optional variables used in the generation of an rtf document.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
912 # Syntax is similar to doxygen's config file.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
913
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
914 RTF_EXTENSIONS_FILE =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
915
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
916 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
917 # configuration options related to the man page output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
918 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
919
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
920 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
921 # generate man pages
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
922
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
923 GENERATE_MAN = $(GENERATE_MAN)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
924
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
925 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
926 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
927 # put in front of it. If left blank `man' will be used as the default path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
928
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
929 MAN_OUTPUT = man
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
930
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
931 # The MAN_EXTENSION tag determines the extension that is added to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
932 # the generated man pages (default is the subroutine's section .3)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
933
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
934 MAN_EXTENSION = .3
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
935
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
936 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
937 # then it will generate one additional man file for each entity
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
938 # documented in the real man page(s). These additional files
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
939 # only source the real man page, but without them the man command
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
940 # would be unable to find the correct page. The default is NO.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
941
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
942 MAN_LINKS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
943
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
944 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
945 # configuration options related to the XML output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
946 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
947
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
948 # If the GENERATE_XML tag is set to YES Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
949 # generate an XML file that captures the structure of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
950 # the code including all documentation.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
951
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
952 GENERATE_XML = $(GENERATE_XML)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
953
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
954 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
955 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
956 # put in front of it. If left blank `xml' will be used as the default path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
957
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
958 XML_OUTPUT = xml
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
959
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
960 # The XML_SCHEMA tag can be used to specify an XML schema,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
961 # which can be used by a validating XML parser to check the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
962 # syntax of the XML files.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
963
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
964 XML_SCHEMA =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
965
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
966 # The XML_DTD tag can be used to specify an XML DTD,
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
967 # which can be used by a validating XML parser to check the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
968 # syntax of the XML files.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
969
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
970 XML_DTD =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
971
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
972 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
973 # dump the program listings (including syntax highlighting
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
974 # and cross-referencing information) to the XML output. Note that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
975 # enabling this will significantly increase the size of the XML output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
976
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
977 XML_PROGRAMLISTING = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
978
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
979 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
980 # configuration options for the AutoGen Definitions output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
981 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
982
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
983 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
984 # generate an AutoGen Definitions (see autogen.sf.net) file
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
985 # that captures the structure of the code including all
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
986 # documentation. Note that this feature is still experimental
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
987 # and incomplete at the moment.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
988
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
989 GENERATE_AUTOGEN_DEF = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
990
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
991 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
992 # configuration options related to the Perl module output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
993 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
994
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
995 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
996 # generate a Perl module file that captures the structure of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
997 # the code including all documentation. Note that this
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
998 # feature is still experimental and incomplete at the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
999 # moment.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1000
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1001 GENERATE_PERLMOD = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1002
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1003 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1004 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1005 # to generate PDF and DVI output from the Perl module output.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1006
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1007 PERLMOD_LATEX = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1008
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1009 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1010 # nicely formatted so it can be parsed by a human reader. This is useful
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1011 # if you want to understand what is going on. On the other hand, if this
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1012 # tag is set to NO the size of the Perl module output will be much smaller
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1013 # and Perl will parse it just the same.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1014
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1015 PERLMOD_PRETTY = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1016
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1017 # The names of the make variables in the generated doxyrules.make file
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1018 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1019 # This is useful so different doxyrules.make files included by the same
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1020 # Makefile don't overwrite each other's variables.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1021
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1022 PERLMOD_MAKEVAR_PREFIX =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1023
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1024 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1025 # Configuration options related to the preprocessor
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1026 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1027
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1028 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1029 # evaluate all C-preprocessor directives found in the sources and include
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1030 # files.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1031
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1032 ENABLE_PREPROCESSING = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1033
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1034 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1035 # names in the source code. If set to NO (the default) only conditional
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1036 # compilation will be performed. Macro expansion can be done in a controlled
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1037 # way by setting EXPAND_ONLY_PREDEF to YES.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1038
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1039 MACRO_EXPANSION = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1040
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1041 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1042 # then the macro expansion is limited to the macros specified with the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1043 # PREDEFINED and EXPAND_AS_DEFINED tags.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1044
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1045 EXPAND_ONLY_PREDEF = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1046
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1047 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1048 # in the INCLUDE_PATH (see below) will be search if a #include is found.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1049
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1050 SEARCH_INCLUDES = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1051
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1052 # The INCLUDE_PATH tag can be used to specify one or more directories that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1053 # contain include files that are not input files but should be processed by
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1054 # the preprocessor.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1055
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1056 INCLUDE_PATH = .
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1057
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1058 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1059 # patterns (like *.h and *.hpp) to filter out the header-files in the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1060 # directories. If left blank, the patterns specified with FILE_PATTERNS will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1061 # be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1062
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1063 INCLUDE_FILE_PATTERNS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1064
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1065 # The PREDEFINED tag can be used to specify one or more macro names that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1066 # are defined before the preprocessor is started (similar to the -D option of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1067 # gcc). The argument of the tag is a list of macros of the form: name
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1068 # or name=definition (no spaces). If the definition and the = are
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1069 # omitted =1 is assumed. To prevent a macro definition from being
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1070 # undefined via #undef or recursively expanded use the := operator
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1071 # instead of the = operator.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1072
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1073 PREDEFINED = _DOXYGEN
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1074
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1075 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1076 # this tag can be used to specify a list of macro names that should be expanded.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1077 # The macro definition that is found in the sources will be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1078 # Use the PREDEFINED tag if you want to use a different macro definition.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1079
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1080 EXPAND_AS_DEFINED =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1081
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1082 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1083 # doxygen's preprocessor will remove all function-like macros that are alone
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1084 # on a line, have an all uppercase name, and do not end with a semicolon. Such
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1085 # function macros are typically used for boiler-plate code, and will confuse
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1086 # the parser if not removed.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1087
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1088 SKIP_FUNCTION_MACROS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1089
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1090 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1091 # Configuration::additions related to external references
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1092 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1093
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1094 # The TAGFILES option can be used to specify one or more tagfiles.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1095 # Optionally an initial location of the external documentation
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1096 # can be added for each tagfile. The format of a tag file without
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1097 # this location is as follows:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1098 # TAGFILES = file1 file2 ...
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1099 # Adding location for the tag files is done as follows:
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1100 # TAGFILES = file1=loc1 "file2 = loc2" ...
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1101 # where "loc1" and "loc2" can be relative or absolute paths or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1102 # URLs. If a location is present for each tag, the installdox tool
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1103 # does not have to be run to correct the links.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1104 # Note that each tag file must have a unique name
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1105 # (where the name does NOT include the path)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1106 # If a tag file is not located in the directory in which doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1107 # is run, you must also specify the path to the tagfile here.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1108
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1109 TAGFILES =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1110
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1111 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1112 # a tag file that is based on the input files it reads.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1113
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1114 GENERATE_TAGFILE = $(DOCDIR)/$(PROJECT).tag
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1115
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1116 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1117 # in the class index. If set to NO only the inherited external classes
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1118 # will be listed.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1119
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1120 ALLEXTERNALS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1121
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1122 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1123 # in the modules index. If set to NO, only the current project's groups will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1124 # be listed.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1125
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1126 EXTERNAL_GROUPS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1127
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1128 # The PERL_PATH should be the absolute path and name of the perl script
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1129 # interpreter (i.e. the result of `which perl').
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1130
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1131 PERL_PATH = /usr/bin/perl
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1132
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1133 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1134 # Configuration options related to the dot tool
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1135 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1136
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1137 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1138 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1139 # or super classes. Setting the tag to NO turns the diagrams off. Note that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1140 # this option is superseded by the HAVE_DOT option below. This is only a
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1141 # fallback. It is recommended to install and use dot, since it yields more
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1142 # powerful graphs.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1143
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1144 CLASS_DIAGRAMS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1145
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1146 # You can define message sequence charts within doxygen comments using the \msc
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1147 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1148 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1149 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1150 # be found in the default search path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1151
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1152 MSCGEN_PATH =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1153
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1154 # If set to YES, the inheritance and collaboration graphs will hide
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1155 # inheritance and usage relations if the target is undocumented
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1156 # or is not a class.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1157
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1158 HIDE_UNDOC_RELATIONS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1159
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1160 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1161 # available from the path. This tool is part of Graphviz, a graph visualization
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1162 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1163 # have no effect if this option is set to NO (the default)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1164
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1165 #HAVE_DOT = $(HAVE_DOT)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1166 HAVE_DOT = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1167
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1168 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1169 # will generate a graph for each documented class showing the direct and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1170 # indirect inheritance relations. Setting this tag to YES will force the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1171 # the CLASS_DIAGRAMS tag to NO.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1172
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1173 CLASS_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1174
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1175 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1176 # will generate a graph for each documented class showing the direct and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1177 # indirect implementation dependencies (inheritance, containment, and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1178 # class references variables) of the class with other documented classes.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1179
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1180 COLLABORATION_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1181
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1182 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1183 # will generate a graph for groups, showing the direct groups dependencies
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1184
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1185 GROUP_GRAPHS = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1186
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1187 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1188 # collaboration diagrams in a style similar to the OMG's Unified Modeling
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1189 # Language.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1190
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1191 UML_LOOK = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1192
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1193 # If set to YES, the inheritance and collaboration graphs will show the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1194 # relations between templates and their instances.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1195
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1196 TEMPLATE_RELATIONS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1197
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1198 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1199 # tags are set to YES then doxygen will generate a graph for each documented
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1200 # file showing the direct and indirect include dependencies of the file with
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1201 # other documented files.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1202
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1203 INCLUDE_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1204
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1205 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1206 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1207 # documented header file showing the documented files that directly or
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1208 # indirectly include this file.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1209
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1210 INCLUDED_BY_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1211
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1212 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1213 # generate a call dependency graph for every global function or class method.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1214 # Note that enabling this option will significantly increase the time of a run.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1215 # So in most cases it will be better to enable call graphs for selected
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1216 # functions only using the \callgraph command.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1217
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1218 CALL_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1219
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1220 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1221 # generate a caller dependency graph for every global function or class method.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1222 # Note that enabling this option will significantly increase the time of a run.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1223 # So in most cases it will be better to enable caller graphs for selected
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1224 # functions only using the \callergraph command.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1225
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1226 CALLER_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1227
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1228 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1229 # will graphical hierarchy of all classes instead of a textual one.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1230
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1231 GRAPHICAL_HIERARCHY = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1232
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1233 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1234 # then doxygen will show the dependencies a directory has on other directories
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1235 # in a graphical way. The dependency relations are determined by the #include
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1236 # relations between the files in the directories.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1237
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1238 DIRECTORY_GRAPH = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1239
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1240 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1241 # generated by dot. Possible values are png, jpg, or gif
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1242 # If left blank png will be used.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1243
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1244 DOT_IMAGE_FORMAT = png
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1245
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1246 # The tag DOT_PATH can be used to specify the path where the dot tool can be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1247 # found. If left blank, it is assumed the dot tool can be found in the path.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1248
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1249 DOT_PATH =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1250
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1251 # The DOTFILE_DIRS tag can be used to specify one or more directories that
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1252 # contain dot files that are included in the documentation (see the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1253 # \dotfile command).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1254
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1255 DOTFILE_DIRS =
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1256
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1257 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1258 # nodes that will be shown in the graph. If the number of nodes in a graph
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1259 # becomes larger than this value, doxygen will truncate the graph, which is
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1260 # visualized by representing a node as a red box. Note that doxygen if the number
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1261 # of direct children of the root node in a graph is already larger than
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1262 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1263 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1264
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1265 DOT_GRAPH_MAX_NODES = 50
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1266
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1267 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1268 # graphs generated by dot. A depth value of 3 means that only nodes reachable
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1269 # from the root by following a path via at most 3 edges will be shown. Nodes
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1270 # that lay further from the root node will be omitted. Note that setting this
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1271 # option to 1 or 2 may greatly reduce the computation time needed for large
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1272 # code bases. Also note that the size of a graph can be further restricted by
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1273 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1274
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1275 MAX_DOT_GRAPH_DEPTH = 0
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1276
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1277 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1278 # background. This is disabled by default, which results in a white background.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1279 # Warning: Depending on the platform used, enabling this option may lead to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1280 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1281 # read).
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1282
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1283 DOT_TRANSPARENT = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1284
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1285 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1286 # files in one run (i.e. multiple -o and -T options on the command line). This
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1287 # makes dot run faster, but since only newer versions of dot (>1.8.10)
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1288 # support this, this feature is disabled by default.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1289
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1290 DOT_MULTI_TARGETS = NO
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1291
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1292 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1293 # generate a legend page explaining the meaning of the various boxes and
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1294 # arrows in the dot generated graphs.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1295
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1296 GENERATE_LEGEND = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1297
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1298 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1299 # remove the intermediate dot files that are used to generate
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1300 # the various graphs.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1301
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1302 DOT_CLEANUP = YES
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1303
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1304 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1305 # Configuration::additions related to the search engine
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1306 #---------------------------------------------------------------------------
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1307
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1308 # The SEARCHENGINE tag specifies whether or not a search engine should be
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1309 # used. If set to NO the values of all tags below this one will be ignored.
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1310
fbd02e4d709e Preliminary support for doxygen: make doxygen-doc will create documentation from sources in doc/doxygen directory.
zas_
parents:
diff changeset
1311 SEARCHENGINE = NO