Revision 18bb522b Doxyfile

View differences:

Doxyfile
43 43

  
44 44
OUTPUT_LANGUAGE        = English
45 45

  
46
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
47
# include brief member descriptions after the members that are listed in
48
# the file and class documentation (similar to JavaDoc).
49
# Set to NO to disable this.
50

  
51
BRIEF_MEMBER_DESC      = YES
52

  
53
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
54
# the brief description of a member or function before the detailed description.
55
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
56
# brief descriptions will be completely suppressed.
57

  
58
REPEAT_BRIEF           = YES
59

  
60
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
61
# Doxygen will generate a detailed section even if there is only a brief
62
# description.
63

  
64
ALWAYS_DETAILED_SEC    = NO
65

  
66
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
67
# members of a class in the documentation of that class as if those members were
68
# ordinary class members. Constructors, destructors and assignment operators of
69
# the base classes will not be shown.
70

  
71
INLINE_INHERITED_MEMB  = NO
72

  
73
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
74
# path before files name in the file list and in the header files. If set
75
# to NO the shortest path that makes the file name unique will be used.
76

  
77
FULL_PATH_NAMES        = YES
78

  
79
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
80
# can be used to strip a user defined part of the path. Stripping is
81
# only done if one of the specified strings matches the left-hand part of
82
# the path. It is allowed to use relative paths in the argument list.
83

  
84
STRIP_FROM_PATH        = .
85

  
86
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
87
# (but less readable) file names. This can be useful is your file systems
88
# doesn't support long names like on DOS, Mac, or CD-ROM.
89

  
90
SHORT_NAMES            = NO
91

  
92
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
93
# will interpret the first line (until the first dot) of a JavaDoc-style
94
# comment as the brief description. If set to NO, the JavaDoc
95
# comments  will behave just like the Qt-style comments (thus requiring an
96
# explict @brief command for a brief description.
97

  
98
JAVADOC_AUTOBRIEF      = YES
99

  
100
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
101
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
102
# comments) as a brief description. This used to be the default behaviour.
103
# The new default is to treat a multi-line C++ comment block as a detailed
104
# description. Set this tag to YES if you prefer the old behaviour instead.
105

  
106
MULTILINE_CPP_IS_BRIEF = NO
107

  
108
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
109
# will output the detailed description near the top, like JavaDoc.
110
# If set to NO, the detailed description appears after the member
111
# documentation.
112

  
113
DETAILS_AT_TOP         = NO
114

  
115
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
116
# member inherits the documentation from any documented member that it
117
# reimplements.
118

  
119
INHERIT_DOCS           = YES
120

  
121
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
122
# Doxygen uses this value to replace tabs by spaces in code fragments.
123

  
124
TAB_SIZE               = 8
125

  
126
# This tag can be used to specify a number of aliases that acts
127
# as commands in the documentation. An alias has the form "name=value".
128
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
129
# put the command \sideeffect (or @sideeffect) in the documentation, which
130
# will result in a user defined paragraph with heading "Side Effects:".
131
# You can put \n's in the value part of an alias to insert newlines.
132

  
133
ALIASES                =
134

  
135
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
136
# only. Doxygen will then generate output that is more tailored for C.
137
# For instance some of the names that are used will be different. The list
138
# of all members will be omitted, etc.
139

  
140
OPTIMIZE_OUTPUT_FOR_C  = YES
141

  
142
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
143
# only. Doxygen will then generate output that is more tailored for Java.
144
# For instance namespaces will be presented as packages, qualified scopes
145
# will look different, etc.
146

  
147
OPTIMIZE_OUTPUT_JAVA   = NO
148

  
46 149
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47 150
# documentation are documented, even if no documentation was available.
48 151
# Private class members and static file members will be hidden unless
......
95 198

  
96 199
HIDE_IN_BODY_DOCS      = NO
97 200

  
98
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
99
# include brief member descriptions after the members that are listed in
100
# the file and class documentation (similar to JavaDoc).
101
# Set to NO to disable this.
102

  
103
BRIEF_MEMBER_DESC      = YES
104

  
105
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
106
# the brief description of a member or function before the detailed description.
107
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
108
# brief descriptions will be completely suppressed.
109

  
110
REPEAT_BRIEF           = YES
111

  
112
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
113
# Doxygen will generate a detailed section even if there is only a brief
114
# description.
115

  
116
ALWAYS_DETAILED_SEC    = NO
117

  
118
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
119
# members of a class in the documentation of that class as if those members were
120
# ordinary class members. Constructors, destructors and assignment operators of
121
# the base classes will not be shown.
122

  
123
INLINE_INHERITED_MEMB  = NO
124

  
125
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
126
# path before files name in the file list and in the header files. If set
127
# to NO the shortest path that makes the file name unique will be used.
128

  
129
FULL_PATH_NAMES        = YES
130

  
131
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132
# can be used to strip a user defined part of the path. Stripping is
133
# only done if one of the specified strings matches the left-hand part of
134
# the path. It is allowed to use relative paths in the argument list.
135

  
136
STRIP_FROM_PATH        = .
137

  
138 201
# The INTERNAL_DOCS tag determines if documentation
139 202
# that is typed after a \internal command is included. If the tag is set
140 203
# to NO (the default) then the documentation will be excluded.
......
150 213

  
151 214
CASE_SENSE_NAMES       = YES
152 215

  
153
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
154
# (but less readable) file names. This can be useful is your file systems
155
# doesn't support long names like on DOS, Mac, or CD-ROM.
156

  
157
SHORT_NAMES            = NO
158

  
159 216
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
160 217
# will show members with their full class and namespace scopes in the
161 218
# documentation. If set to YES the scope will be hidden.
162 219

  
163 220
HIDE_SCOPE_NAMES       = NO
164 221

  
165
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
166
# will generate a verbatim copy of the header file for each class for
167
# which an include is specified. Set to NO to disable this.
168

  
169
VERBATIM_HEADERS       = YES
170

  
171 222
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
172 223
# will put list of the files that are included by a file in the documentation
173 224
# of that file.
174 225

  
175 226
SHOW_INCLUDE_FILES     = YES
176 227

  
177
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
178
# will interpret the first line (until the first dot) of a JavaDoc-style
179
# comment as the brief description. If set to NO, the JavaDoc
180
# comments  will behave just like the Qt-style comments (thus requiring an
181
# explict @brief command for a brief description.
182

  
183
JAVADOC_AUTOBRIEF      = YES
184

  
185
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
186
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
187
# comments) as a brief description. This used to be the default behaviour.
188
# The new default is to treat a multi-line C++ comment block as a detailed
189
# description. Set this tag to YES if you prefer the old behaviour instead.
190

  
191
MULTILINE_CPP_IS_BRIEF = NO
192

  
193
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
194
# will output the detailed description near the top, like JavaDoc.
195
# If set to NO, the detailed description appears after the member
196
# documentation.
197

  
198
DETAILS_AT_TOP         = NO
199

  
200
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
201
# member inherits the documentation from any documented member that it
202
# reimplements.
203

  
204
INHERIT_DOCS           = YES
205

  
206 228
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
207 229
# is inserted in the documentation for inline members.
208 230

  
......
222 244

  
223 245
DISTRIBUTE_GROUP_DOC   = NO
224 246

  
225
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
226
# Doxygen uses this value to replace tabs by spaces in code fragments.
227

  
228
TAB_SIZE               = 8
229

  
230 247
# The GENERATE_TODOLIST tag can be used to enable (YES) or
231 248
# disable (NO) the todo list. This list is created by putting \todo
232 249
# commands in the documentation.
......
251 268

  
252 269
GENERATE_DEPRECATEDLIST= YES
253 270

  
254
# This tag can be used to specify a number of aliases that acts
255
# as commands in the documentation. An alias has the form "name=value".
256
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
257
# put the command \sideeffect (or @sideeffect) in the documentation, which
258
# will result in a user defined paragraph with heading "Side Effects:".
259
# You can put \n's in the value part of an alias to insert newlines.
260

  
261
ALIASES                =
262

  
263 271
# The ENABLED_SECTIONS tag can be used to enable conditional
264 272
# documentation sections, marked by \if sectionname ... \endif.
265 273

  
......
275 283

  
276 284
MAX_INITIALIZER_LINES  = 30
277 285

  
278
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
279
# only. Doxygen will then generate output that is more tailored for C.
280
# For instance some of the names that are used will be different. The list
281
# of all members will be omitted, etc.
282

  
283
OPTIMIZE_OUTPUT_FOR_C  = YES
284

  
285
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
286
# only. Doxygen will then generate output that is more tailored for Java.
287
# For instance namespaces will be presented as packages, qualified scopes
288
# will look different, etc.
289

  
290
OPTIMIZE_OUTPUT_JAVA   = NO
291

  
292 286
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
293 287
# at the bottom of the documentation of classes and structs. If set to YES the
294 288
# list will mention the files that were used to generate the documentation.
......
445 439

  
446 440
REFERENCES_RELATION    = NO
447 441

  
442
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
443
# will generate a verbatim copy of the header file for each class for
444
# which an include is specified. Set to NO to disable this.
445

  
446
VERBATIM_HEADERS       = YES
447

  
448 448
#---------------------------------------------------------------------------
449 449
# configuration options related to the alphabetical class index
450 450
#---------------------------------------------------------------------------

Also available in: Unified diff