30510652980388f548f81910247628967c6225d1
[ginac.git] / doc / reference / DoxyfileTEX
1 # Doxyfile 0.49-991106
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             = NO
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 than the body of a member or
124 # function will be appended as a block of code to the documentation of.
125 # that member or function.
126
127 SOURCE_BROWSER       = YES
128
129 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
130 # will only generate file names in lower case letters. If set to
131 # YES upper case letters are also allowed. This is useful if you have
132 # classes or files whose names only differ in case and if your file system
133 # supports case sensitive file names.
134
135 CASE_SENSE_NAMES     = YES
136
137 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
138 # will generate a verbatim copy of the header file for each class for
139 # which an include is specified. Set to NO to disable this.
140
141 VERBATIM_HEADERS     = YES
142
143 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
144 # will interpret the first line (until the first dot) of a JavaDoc-style
145 # comment as the brief description. If set to NO, the Javadoc-style will
146 # behave just like the Qt-style comments.
147
148 JAVADOC_AUTOBRIEF    = YES
149
150 # if the INHERIT_DOCS tag is set to YES (the default) then an undocumented
151 # member inherits the documentation from any documented member that it
152 # reimplements.
153
154 INHERIT_DOCS         = YES
155
156 # if the INLINE_INFO tag is set to YES (the default) then a tag [inline]
157 # is inserted in the documentation for inline members.
158
159 INLINE_INFO          = YES
160
161 # the TAB_SIZE tag can be used to set the number of spaces in a tab
162 # Doxygen uses this value to replace tabs by spaces in code fragments.
163
164 TAB_SIZE             = 4
165
166 #---------------------------------------------------------------------------
167 # configuration options related to the input files
168 #---------------------------------------------------------------------------
169
170 # The INPUT tag can be used to specify the files and/or directories that contain 
171 # documented source files. You may enter file names like "myfile.cpp" or 
172 # directories like "/usr/src/myproject". Separate the files or directories 
173 # with spaces.
174
175 INPUT                = ../../ginac
176
177 # If the value of the INPUT tag contains directories, you can use the 
178 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
179 # and *.h) to filter out the source-files in the directories. If left 
180 # blank all files are included.
181
182 FILE_PATTERNS        = *.cpp *.h
183
184 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
185 # should be searched for input files as well. Possible values are YES and NO.
186 # If left blank NO is used.
187
188 RECURSIVE            = NO
189
190 # The EXCLUDE tag can be used to specify files and/or directories that should
191 # excluded from the INPUT source files. This way you can easily exclude a 
192 # subdirectory from a directory tree whose root is specified with the INPUT tag.
193
194 EXCLUDE              =
195
196 # If the value of the INPUT tag contains directories, you can use the
197 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
198 # certain files from those directories.
199
200 EXCLUDE_PATTERNS     =
201
202 # The EXAMPLE_PATH tag can be used to specify one or more files or 
203 # directories that contain example code fragments that are included (see 
204 # the \include command).
205
206 EXAMPLE_PATH         =
207
208 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
209 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
210 # and *.h) to filter out the source-files in the directories. If left 
211 # blank all files are included.
212
213 EXAMPLE_PATTERNS     =
214
215 # The IMAGE_PATH tag can be used to specify one or more files or 
216 # directories that contain image that are included in the documentation (see 
217 # the \image command).
218
219 IMAGE_PATH           =
220
221 # If the value of the IMAGE_PATH tag contains directories, you can use the
222 # IMAGE_PATTERNS tag to specify one or more wildcard pattern (like *.gif 
223 # and *.eps) to filter out the image files in the directories. If left 
224 # blank all files are included.
225
226 IMAGE_PATTERNS       =
227
228 # The INPUT_FILTER tag can be used to specify a program that doxygen should
229 # invoke to filter for each input file. Doxygen will invoke the filter program 
230 # by executing (via popen()) the command <filter> <input-file>, where <filter>
231 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
232 # input file. Doxygen will then use the output that the filter program writes
233 # to standard output.
234
235 INPUT_FILTER         =
236
237 #---------------------------------------------------------------------------
238 # configuration options related to the HTML output
239 #---------------------------------------------------------------------------
240
241 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
242 # generate HTML output
243
244 GENERATE_HTML        = NO
245
246 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
247 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
248 # put in front of it. If left blank `html' will be used as the default path.
249
250 HTML_OUTPUT          = .
251
252 # The HTML_HEADER tag can be used to specify a personal HTML header for 
253 # each generated HTML page. If it is left blank doxygen will generate a 
254 # standard header.
255
256 HTML_HEADER          =
257
258 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
259 # each generated HTML page. If it is left blank doxygen will generate a 
260 # standard footer.
261
262 HTML_FOOTER          = Doxyfooter
263
264 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
265 # style sheet that is used by each HTML page. It can be used to 
266 # fine-tune the look of the HTML output. If the tag is left blank doxygen
267 # will generate a default style sheet
268
269 HTML_STYLESHEET      =
270
271 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
272 # files or namespaces will be aligned in HTML using tables. If set to
273 # NO a bullet list will be used.
274
275 HTML_ALIGN_MEMBERS   = YES
276
277 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
278 # will be generated that can be used as input for tools like the
279 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
280 # of the generated HTML documentation.
281
282 GENERATE_HTMLHELP    = NO
283
284 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
285 # of all compounds will be generated. Enable this if the project
286 # contains a lot of classes, structs, unions or interfaces.
287
288 ALPHABETICAL_INDEX   = NO
289
290 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
291 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
292 # in which this list will be split (can be a number in the range [1..20])
293
294 COLS_IN_ALPHA_INDEX  = 5
295
296 #---------------------------------------------------------------------------
297 # configuration options related to the LaTeX output
298 #---------------------------------------------------------------------------
299
300 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
301 # generate Latex output.
302
303 GENERATE_LATEX       = YES
304
305 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
306 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
307 # put in front of it. If left blank `latex' will be used as the default path.
308
309 LATEX_OUTPUT         = latex
310
311 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
312 # LaTeX documents. This may be useful for small projects and may help to
313 # save some trees in general.
314
315 COMPACT_LATEX        = NO
316
317 # The PAPER_TYPE tag can be used to set the paper type that is used
318 # by the printer. Possible values are: a4, a4wide, letter, legal and 
319 # executive. If left blank a4wide will be used.
320
321 PAPER_TYPE           = a4wide
322
323 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
324 # packages that should be included in the LaTeX output.
325
326 EXTRA_PACKAGES       =
327
328 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
329 # the generated latex document. The header should contain everything until
330 # the first chapter. If it is left blank doxygen will generate a 
331 # standard header. Notice: only use this tag if you know what you are doing!
332
333 LATEX_HEADER          =
334
335 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
336 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
337 # contain links (just like the HTML output) instead of page references
338 # This makes the output suitable for online browsing using a pdf viewer.
339
340 PDF_HYPERLINKS       = NO
341
342 #---------------------------------------------------------------------------
343 # configuration options related to the man page output
344 #---------------------------------------------------------------------------
345
346 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
347 # generate man pages
348
349 GENERATE_MAN         = NO
350
351 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
352 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
353 # put in front of it. If left blank `man' will be used as the default path.
354
355 MAN_OUTPUT           =
356
357 # The MAN_EXTENSION tag determines the extension that is added to
358 # the generated man pages (default is the subroutine's section .3)
359
360 MAN_EXTENSION        = .3
361
362 #---------------------------------------------------------------------------
363 # Configuration options related to the preprocessor 
364 #---------------------------------------------------------------------------
365
366 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
367 # evaluate all C-preprocessor directives found in the sources and include
368 # files.
369
370 ENABLE_PREPROCESSING = YES
371
372 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
373 # names in the source code. If set to NO (the default) only conditional 
374 # compilation will be performed.
375
376 MACRO_EXPANSION      = NO
377
378 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
379 # in the INCLUDE_PATH (see below) will be search if a #include is found.
380
381 SEARCH_INCLUDES      = YES
382
383 # The INCLUDE_PATH tag can be used to specify one or more directories that
384 # contain include files that are not input files but should be processed by
385 # the preprocessor.
386
387 INCLUDE_PATH         =
388
389 # The PREDEFINED tag can be used to specify one or more macro names that
390 # are defined before the preprocessor is started (similar to the -D option of
391 # gcc). The argument of the tag is a list of macros of the form: name
392 # or name=definition (no spaces). If the definition and the = are 
393 # omitted =1 is assumed.
394
395 PREDEFINED           =
396
397 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
398 # then the macro expansion is limited to the macros specified with the
399 # PREDEFINED tag.
400
401 EXPAND_ONLY_PREDEF   = NO
402
403 #---------------------------------------------------------------------------
404 # Configuration options related to external references 
405 #---------------------------------------------------------------------------
406
407 # The TAGFILES tag can be used to specify one or more tagfiles. 
408
409 TAGFILES             =
410
411 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
412 # a tag file that is based on the input files it reads.
413
414 GENERATE_TAGFILE     =
415
416 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
417 # in the class index. If set to NO only the inherited external classes
418 # will be listed.
419
420 ALLEXTERNALS         = NO
421
422 # The PERL_PATH should be the absolute path and name of the perl script
423 # interpreter (i.e. the result of `which perl').
424
425 PERL_PATH            = /usr/bin/perl
426
427 #---------------------------------------------------------------------------
428 # Configuration options related to the search engine 
429 #---------------------------------------------------------------------------
430
431 # The SEARCHENGINE tag specifies whether or not a search engine should be 
432 # used. If set to NO the values of all tags below this one will be ignored.
433
434 SEARCHENGINE         = NO
435
436 # The CGI_NAME tag should be the name of the CGI script that
437 # starts the search engine (doxysearch) with the correct parameters.
438 # A script with this name will be generated by doxygen.
439
440 CGI_NAME             = search.cgi
441
442 # The CGI_URL tag should be the absolute URL to the directory where the
443 # cgi binaries are located. See the documentation of your http daemon for 
444 # details.
445
446 CGI_URL              =
447
448 # The DOC_URL tag should be the absolute URL to the directory where the
449 # documentation is located. If left blank the absolute path to the 
450 # documentation, with file:// prepended to it, will be used.
451
452 DOC_URL              =
453
454 # The DOC_ABSPATH tag should be the absolute path to the directory where the
455 # documentation is located. If left blank the directory on the local machine
456 # will be used.
457
458 DOC_ABSPATH          =
459
460 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
461 # is installed.
462
463 BIN_ABSPATH          = /usr/local/bin/
464
465 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
466 # documentation generated for other projects. This allows doxysearch to search
467 # the documentation for these projects as well.
468
469 EXT_DOC_PATHS        =