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