]> Shamusworld >> Repos - architektonas/blob - dxflib/doxygen.cfg
Removed Snapper class; still refactoring Snapper/Preview...
[architektonas] / dxflib / doxygen.cfg
1 # Doxyfile 0.49-991003
2
3 # This file describes the settings to be used by doxygen for a project
4 #
5 # Doxygen is an automatic documentation system. dxflib uses it for
6 # generating the source documentation in dxflib/src/doc/html/
7 #
8 # All text after a hash (#) is considered a comment and will be ignored
9 # The format is:
10 #       TAG = value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # General configuration options
15 #---------------------------------------------------------------------------
16
17 # The PROJECT_NAME tag is a single word (or a sequence of word surrounded
18 # by quotes) that should identify the project. 
19
20 PROJECT_NAME         = dxflib
21
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or 
24 # if some version control system is used.
25
26 PROJECT_NUMBER       =
27
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
29 # base path where the generated documentation will be put. 
30 # If a relative path is entered, it will be relative to the location 
31 # where doxygen was started. If left blank the current directory will be used.
32
33 OUTPUT_DIRECTORY     = 
34
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are: 
39 # Dutch, French, Italian, Czech, Swedish, German and Japanese
40
41 OUTPUT_LANGUAGE      = English
42
43 # The QUIET tag can be used to turn on/off the messages that are generated
44 # by doxygen. Possible values are YES and NO. If left blank NO is used.
45
46 QUIET                = NO
47
48 # The WARNINGS tag can be used to turn on/off the warning messages that are
49 # generated by doxygen. Possible values are YES and NO. If left blank
50 # NO is used.
51
52 WARNINGS             = YES
53
54 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
55 # top of each HTML page. The value NO (the default) enables the index and
56 # the value YES disables it.
57
58 DISABLE_INDEX        = NO
59
60 # If the EXTRACT_ALL tag is set to YES all classes and functions will be
61 # included in the documentation, even if no documentation was available.
62
63 EXTRACT_ALL          = NO
64
65 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
66 # will be included in the documentation.
67
68 EXTRACT_PRIVATE      = NO
69
70 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
71 # undocumented members inside documented classes or files.
72
73 HIDE_UNDOC_MEMBERS   = NO
74
75 # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all
76 # undocumented classes.
77
78 HIDE_UNDOC_CLASSES   = NO
79
80 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
81 # include brief member descriptions after the members that are listed in 
82 # the file and class documentation (similar to JavaDoc).
83 # Set to NO to disable this.
84
85 BRIEF_MEMBER_DESC    = YES
86
87 # The INTERNAL_DOCS tag determines if documentation
88 # that is typed after a \internal command is included. If the tag is set 
89 # to NO (the default) then the documentation will be excluded.
90 # Set it to YES to include the internal documentation.
91
92 INTERNAL_DOCS        = NO
93
94 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
95 # the brief description of a member or function before the detailed description.
96 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
97 # brief descriptions will be completely suppressed.
98
99 REPEAT_BRIEF         = YES
100
101 # If the FULL_PATH_NAMES tag is set to YES Doxygen will prepend the full
102 # path before files name in the file list and in the header files. If set
103 # to NO the shortest path that makes the file name unique will be used.
104
105 FULL_PATH_NAMES      = NO
106
107 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
108 # can be used to strip a user defined part of the path. Stripping is
109 # only done if one of the specified strings matches the left-hand part of
110 # the path.
111
112 STRIP_FROM_PATH      =
113
114 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
115 # generate a class diagram (in Html and LaTeX) for classes with base or
116 # super classes. Setting the tag to NO turns the diagrams off.
117
118 CLASS_DIAGRAMS       = YES
119
120 # If the SOURCE_BROWSER tag is set to YES than the body of a member or
121 # function will be appended as a block of code to the documentation of.
122 # that member or function.
123
124 SOURCE_BROWSER       = NO
125
126 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
127 # will only generate file names in lower case letters. If set to
128 # YES upper case letters are also allowed. This is useful if you have
129 # classes or files whose names only differ in case and if your file system
130 # supports case sensitive file names.
131
132 CASE_SENSE_NAMES     = NO
133
134 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
135 # will generate a verbatim copy of the header file for each class for
136 # which an include is specified. Set to NO to disable this.
137
138 VERBATIM_HEADERS     = YES
139
140 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
141 # will interpret the first line (until the first dot) of a JavaDoc-style
142 # comment as the brief description. If set to NO, the Javadoc-style will
143 # behave just like the Qt-style comments.
144
145 JAVADOC_AUTOBRIEF    = YES
146
147 # if the INHERIT_DOCS tag is set to YES (the default) then an undocumented
148 # member inherits the documentation from any documented member that it
149 # reimplements.
150
151 INHERIT_DOCS         = YES
152
153 # if the INLINE_INFO tag is set to YES (the default) then a tag [inline]
154 # is inserted in the documentation for inline members.
155
156 INLINE_INFO          = YES
157
158 #---------------------------------------------------------------------------
159 # configuration options related to the input files
160 #---------------------------------------------------------------------------
161
162 # The INPUT tag can be used to specify the files and/or directories that contain 
163 # documented source files. You may enter file names like "myfile.cpp" or 
164 # directories like "/usr/src/myproject". Separate the files or directories 
165 # with spaces.
166
167 INPUT                = src
168
169 # If the value of the INPUT tag contains directories, you can use the 
170 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
171 # and *.h) to filter out the source-files in the directories. If left 
172 # blank all files are included.
173
174 FILE_PATTERNS        = *.cpp *.h
175
176 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
177 # should be searched for input files as well. Possible values are YES and NO.
178 # If left blank NO is used.
179
180 RECURSIVE            = NO
181
182 # The EXCLUDE tag can be used to specify files and/or directories that should
183 # excluded from the INPUT source files. This way you can easily exclude a 
184 # subdirectory from a directory tree whose root is specified with the INPUT tag.
185
186 EXCLUDE              =
187
188 # If the value of the INPUT tag contains directories, you can use the
189 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
190 # certain files from those directories.
191
192 EXCLUDE_PATTERNS     =
193
194 # The EXAMPLE_PATH tag can be used to specify one or more files or 
195 # directories that contain example code fragments that are included (see 
196 # the \include command).
197
198 EXAMPLE_PATH         =
199
200 # The INPUT_FILTER tag can be used to specify a program that doxygen should
201 # invoke to filter for each input file. Doxygen will invoke the filter program 
202 # by executing (via popen()) the command <filter> <input-file>, where <filter>
203 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
204 # input file. Doxygen will then use the output that the filter program writes
205 # to standard output.
206
207 INPUT_FILTER         =
208
209 #---------------------------------------------------------------------------
210 # configuration options related to the HTML output
211 #---------------------------------------------------------------------------
212
213 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
214 # generate HTML output
215
216 GENERATE_HTML        = YES
217
218 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
219 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
220 # put in front of it. If left blank `html' will be used as the default path.
221
222 HTML_OUTPUT          = doc/classref/html/en
223
224 # The HTML_HEADER tag can be used to specify a personal HTML header for 
225 # each generated HTML page. If it is left blank doxygen will generate a 
226 # standard header.
227
228 HTML_HEADER          = doc/classref/html/doxyheader.html
229
230 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
231 # each generated HTML page. If it is left blank doxygen will generate a 
232 # standard footer.
233
234 HTML_FOOTER          = doc/classref/html/doxyfooter.html
235
236 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
237 # files or namespaces will be aligned in HTML using tables. If set to
238 # NO a bullet list will be used.
239
240 HTML_ALIGN_MEMBERS   = YES
241
242 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
243 # will be generated that can be used as input for tools like the
244 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
245 # of the generated HTML documentation.
246
247 GENERATE_HTMLHELP    = NO
248
249 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
250 # of all compounds will be generated. Enable this if the project
251 # contains a lot of classes, structs, unions or interfaces.
252
253 ALPHABETICAL_INDEX   = NO
254
255 #---------------------------------------------------------------------------
256 # configuration options related to the LaTeX output
257 #---------------------------------------------------------------------------
258
259 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
260 # generate Latex output.
261
262 GENERATE_LATEX       = NO
263
264 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
265 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
266 # put in front of it. If left blank `latex' will be used as the default path.
267
268 LATEX_OUTPUT         = 
269
270 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
271 # LaTeX documents. This may be useful for small projects and may help to
272 # save some trees in general.
273
274 COMPACT_LATEX        = NO
275
276 # The PAPER_TYPE tag can be used to set the paper type that is used
277 # by the printer. Possible values are: a4, a4wide, letter, legal and 
278 # executive. If left blank a4wide will be used.
279
280 PAPER_TYPE           = a4wide
281
282 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
283 # packages that should be included in the LaTeX output.
284
285 EXTRA_PACKAGES       =
286
287 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
288 # the generated latex document. The header should contain everything until
289 # the first chapter. If it is left blank doxygen will generate a 
290 # standard header. Notice: only use this tag if you know what you are doing!
291
292 LATEX_HEADER          =
293
294 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
295 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
296 # contain links (just like the HTML output) instead of page references
297 # This makes the output suitable for online browsing using a pdf viewer.
298
299 PDF_HYPERLINKS       = NO
300
301 #---------------------------------------------------------------------------
302 # configuration options related to the man page output
303 #---------------------------------------------------------------------------
304
305 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
306 # generate man pages
307
308 GENERATE_MAN         = NO
309
310 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
311 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
312 # put in front of it. If left blank `man' will be used as the default path.
313
314 MAN_OUTPUT           =
315
316 # The MAN_EXTENSION tag determines the extension that is added to
317 # the generated man pages (default is the subroutine's section .3)
318
319 MAN_EXTENSION        = .3
320
321 #---------------------------------------------------------------------------
322 # Configuration options related to the preprocessor 
323 #---------------------------------------------------------------------------
324
325 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
326 # evaluate all C-preprocessor directives found in the sources and include
327 # files.
328
329 ENABLE_PREPROCESSING = YES
330
331 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
332 # names in the source code. If set to NO (the default) only conditional 
333 # compilation will be performed.
334
335 MACRO_EXPANSION      = NO
336
337 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
338 # in the INCLUDE_PATH (see below) will be search if a #include is found.
339
340 SEARCH_INCLUDES      = YES
341
342 # The INCLUDE_PATH tag can be used to specify one or more directories that
343 # contain include files that are not input files but should be processed by
344 # the preprocessor.
345
346 INCLUDE_PATH         =
347
348 # The PREDEFINED tag can be used to specify one or more macro names that
349 # are defined before the preprocessor is started (similar to the -D option of
350 # gcc). The argument of the tag is a list of macros of the form: name
351 # or name=definition (no spaces). If the definition and the = are 
352 # omitted =1 is assumed.
353
354 PREDEFINED           =
355
356 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
357 # then the macro expansion is limited to the macros specified with the
358 # PREDEFINED tag.
359
360 EXPAND_ONLY_PREDEF   = NO
361
362 #---------------------------------------------------------------------------
363 # Configuration options related to external references 
364 #---------------------------------------------------------------------------
365
366 # The TAGFILES tag can be used to specify one or more tagfiles. 
367
368 TAGFILES             =
369
370 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
371 # a tag file that is based on the input files it reads.
372
373 GENERATE_TAGFILE     =
374
375 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
376 # in the class index. If set to NO only the inherited external classes
377 # will be listed.
378
379 ALLEXTERNALS         = NO
380
381 # The PERL_PATH should be the absolute path and name of the perl script
382 # interpreter (i.e. the result of `which perl').
383
384 PERL_PATH            = /usr/bin/perl
385
386 #---------------------------------------------------------------------------
387 # Configuration options related to the search engine 
388 #---------------------------------------------------------------------------
389
390 # The SEARCHENGINE tag specifies whether or not a search engine should be 
391 # used. If set to NO the values of all tags below this one will be ignored.
392
393 SEARCHENGINE         = NO
394
395 # The CGI_NAME tag should be the name of the CGI script that
396 # starts the search engine (doxysearch) with the correct parameters.
397 # A script with this name will be generated by doxygen.
398
399 CGI_NAME             = search.cgi
400
401 # The CGI_URL tag should be the absolute URL to the directory where the
402 # cgi binaries are located. See the documentation of your http daemon for 
403 # details.
404
405 CGI_URL              =
406
407 # The DOC_URL tag should be the absolute URL to the directory where the
408 # documentation is located. If left blank the absolute path to the 
409 # documentation, with file:// prepended to it, will be used.
410
411 DOC_URL              =
412
413 # The DOC_ABSPATH tag should be the absolute path to the directory where the
414 # documentation is located. If left blank the directory on the local machine
415 # will be used.
416
417 DOC_ABSPATH          =
418
419 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
420 # is installed.
421
422 BIN_ABSPATH          = /usr/local/bin/
423
424 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
425 # documentation generated for other projects. This allows doxysearch to search
426 # the documentation for these projects as well.
427
428 EXT_DOC_PATHS        =