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