Mercurial > octave
annotate doc/doxyhtml/Doxyfile.in @ 27919:1891570abac8
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2020.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 22:29:51 -0500 |
parents | b442ec6dda5c |
children | bd51beb6205e |
rev | line source |
---|---|
16222
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
1 # -*- mode: conf; -*- |
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
2 |
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
3 ## Copyright (C) 2013-2020 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this distribution |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
6 ## or <https://octave.org/COPYRIGHT.html/>. |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
7 ## |
22799
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
8 ## |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
9 ## This file is part of Octave. |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
10 ## |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24193
diff
changeset
|
11 ## Octave is free software: you can redistribute it and/or modify it |
22799
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
12 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24193
diff
changeset
|
13 ## the Free Software Foundation, either version 3 of the License, or |
22799
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
14 ## (at your option) any later version. |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
15 ## |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
16 ## Octave is distributed in the hope that it will be useful, but |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
17 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
18 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
19 ## GNU General Public License for more details. |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
20 ## |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
21 ## You should have received a copy of the GNU General Public License |
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
22 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24193
diff
changeset
|
23 ## <https://www.gnu.org/licenses/>. |
22799
592fa741e0aa
add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents:
22201
diff
changeset
|
24 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
25 # Doxyfile for Doxygen 1.8.11 |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
26 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
27 # This file describes the settings to be used by the documentation system |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
28 # doxygen (www.doxygen.org) for GNU Octave. |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
29 # |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
30 # All text after a double hash (##) is considered a comment and is placed in |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
31 # front of the TAG it is preceding. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
32 # |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
33 # All text after a single hash (#) is considered a comment and will be ignored. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
34 # The format is: |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
35 # TAG = value [value, ...] |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
36 # For lists, items can also be appended using: |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
37 # TAG += value [value, ...] |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
38 # Values that contain spaces should be placed between quotes (\" \"). |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
39 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
40 #--------------------------------------------------------------------------- |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
41 # Project related configuration options |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
42 #--------------------------------------------------------------------------- |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
43 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
44 # This tag specifies the encoding used for all characters in the config file |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
45 # that follow. The default is UTF-8 which is also the encoding used for all text |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
46 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
24893
a3eb0d746042
doc: use canonical https URLs for all external gnu.org references
Mike Miller <mtmiller@octave.org>
parents:
24873
diff
changeset
|
47 # built into libc) for the transcoding. See https://www.gnu.org/software/libiconv |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
48 # for the list of possible encodings. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
49 # The default value is: UTF-8. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
50 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
51 DOXYFILE_ENCODING = UTF-8 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
52 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
53 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
54 # double-quotes, unless you are using Doxywizard) that should identify the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
55 # project for which the documentation is generated. This name is used in the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
56 # title of most generated pages and in a few other places. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
57 # The default value is: My Project. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
58 |
16222
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
59 PROJECT_NAME = "GNU Octave" |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
60 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
61 # The public stable API version (unrelated to the internal API version). |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
62 |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
63 PROJECT_NUMBER = @PACKAGE_VERSION@ |
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
64 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
65 # Using the PROJECT_BRIEF tag one can provide an optional one line description |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
66 # for a project that appears at the top of each page and should give viewer a |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
67 # quick idea about the purpose of the project. Keep the description short. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
68 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
69 PROJECT_BRIEF = "A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab" |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
70 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
71 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
72 # in the documentation. The maximum height of the logo should not exceed 55 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
73 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
74 # the logo to the output directory. |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
75 |
21298
31cd45258fc6
maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents:
20240
diff
changeset
|
76 PROJECT_LOGO = @abs_top_builddir@/etc/icons/octave-logo-48.png |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
77 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
78 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
79 # into which the generated documentation will be written. If a relative path is |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
80 # entered, it will be relative to the location where doxygen was started. If |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
81 # left blank the current directory will be used. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
82 |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
83 OUTPUT_DIRECTORY = @abs_top_builddir@/doc |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
84 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
85 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
86 # directories (in 2 levels) under the output directory of each output format and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
87 # will distribute the generated files over these directories. Enabling this |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
88 # option can be useful when feeding doxygen a huge amount of source files, where |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
89 # putting all generated files in the same directory would otherwise causes |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
90 # performance problems for the file system. |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
91 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
92 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
93 CREATE_SUBDIRS = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
94 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
96 # characters to appear in the names of generated files. If set to NO, non-ASCII |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
97 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
98 # U+3044. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
99 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
100 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
101 ALLOW_UNICODE_NAMES = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
102 |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
103 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
104 # documentation generated by doxygen is written. Doxygen will use this |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
105 # information to generate all constant output in the proper language. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
106 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
107 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
108 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
109 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
110 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
111 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
112 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
113 # Ukrainian and Vietnamese. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
114 # The default value is: English. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
115 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
116 OUTPUT_LANGUAGE = English |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
117 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
119 # descriptions after the members that are listed in the file and class |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
120 # documentation (similar to Javadoc). Set to NO to disable this. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
121 # The default value is: YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
122 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
123 BRIEF_MEMBER_DESC = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
124 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
126 # description of a member or function before the detailed description |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
127 # |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
128 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
129 # brief descriptions will be completely suppressed. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
130 # The default value is: YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
131 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
132 REPEAT_BRIEF = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
133 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
134 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
135 # Doxygen will generate a detailed section even if there is only a brief |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
136 # description. |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
137 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
138 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
139 ALWAYS_DETAILED_SEC = NO |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
140 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
141 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
142 # inherited members of a class in the documentation of that class as if those |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
143 # members were ordinary class members. Constructors, destructors and assignment |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
144 # operators of the base classes will not be shown. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
145 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
146 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
147 INLINE_INHERITED_MEMB = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
148 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
149 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
150 # before files name in the file list and in the header files. If set to NO the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
151 # shortest path that makes the file name unique will be used |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
152 # The default value is: YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
153 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
154 FULL_PATH_NAMES = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
155 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
156 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
157 # Stripping is only done if one of the specified strings matches the left-hand |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
158 # part of the path. The tag can be used to show relative paths in the file list. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
159 # If left blank the directory from which doxygen is run is used as the path to |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
160 # strip. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
161 # |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
162 # Note that you can specify absolute paths here, but also relative paths, which |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
163 # will be relative from the directory where doxygen is started. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
164 # This tag requires that the tag FULL_PATH_NAMES is set to YES. |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
165 |
21298
31cd45258fc6
maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents:
20240
diff
changeset
|
166 STRIP_FROM_PATH = @abs_top_srcdir@ |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
167 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
168 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
169 # first line (until the first dot) of a Javadoc-style comment as the brief |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
170 # description. If set to NO, the Javadoc-style will behave just like regular Qt- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
171 # style comments (thus requiring an explicit @brief command for a brief |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
172 # description.) |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
173 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
174 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
175 JAVADOC_AUTOBRIEF = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
176 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
177 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
178 # line (until the first dot) of a Qt-style comment as the brief description. If |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
179 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
180 # requiring an explicit \brief command for a brief description.) |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
181 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
182 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
183 QT_AUTOBRIEF = NO |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
184 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
185 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
186 # documentation from any documented member that it re-implements. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
187 # The default value is: YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
188 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
189 INHERIT_DOCS = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
190 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
191 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
192 # page for each member. If set to NO, the documentation of a member will be part |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
193 # of the file/class/namespace that contains it. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
194 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
195 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
196 SEPARATE_MEMBER_PAGES = NO |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
197 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
198 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
199 # uses this value to replace tabs by spaces in code fragments. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
200 # Minimum value: 1, maximum value: 16, default value: 4. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
201 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
202 TAB_SIZE = 2 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
203 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
204 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
205 # according to the Markdown format, which allows for more readable |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
206 # documentation. See http://daringfireball.net/projects/markdown/ for details. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
207 # The output of markdown processing is further processed by doxygen, so you can |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
208 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
209 # case of backward compatibilities issues. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
210 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
211 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
212 MARKDOWN_SUPPORT = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
213 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
214 # When enabled doxygen tries to link words that correspond to documented |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
215 # classes, or namespaces to their corresponding documentation. Such a link can |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
216 # be prevented in individual cases by putting a % sign in front of the word or |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
217 # globally by setting AUTOLINK_SUPPORT to NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
218 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
219 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
220 AUTOLINK_SUPPORT = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
221 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
222 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
223 # to include (a tag file for) the STL sources as input, then you should set this |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
224 # tag to YES in order to let doxygen match functions declarations and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
225 # definitions whose arguments contain STL classes (e.g. func(std::string); |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
226 # versus func(std::string) {}). This also make the inheritance and collaboration |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
227 # diagrams that involve STL classes more complete and accurate. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
228 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
229 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
230 BUILTIN_STL_SUPPORT = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
231 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
232 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
233 # tag is set to YES then doxygen will reuse the documentation of the first |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
234 # member in the group (if any) for the other members of the group. By default |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
235 # all members of a group must be documented explicitly. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
236 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
237 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
238 DISTRIBUTE_GROUP_DOC = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
239 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
240 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
241 # cache is used to resolve symbols given their name and scope. Since this can be |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
242 # an expensive process and often the same symbol appears multiple times in the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
243 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
244 # doxygen will become slower. If the cache is too large, memory is wasted. The |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
245 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
246 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
247 # symbols. At the end of a run doxygen will report the cache usage and suggest |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
248 # the optimal cache size from a speed point of view. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
249 # Minimum value: 0, maximum value: 9, default value: 0. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
250 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
251 LOOKUP_CACHE_SIZE = 2 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
252 |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
253 #--------------------------------------------------------------------------- |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
254 # Build related configuration options |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
255 #--------------------------------------------------------------------------- |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
256 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
257 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
258 # documentation are documented, even if no documentation was available. Private |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
259 # class members and static file members will be hidden unless the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
260 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
261 # Note: This will also disable the warnings about undocumented members that are |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
262 # normally produced when WARNINGS is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
263 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
264 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
265 EXTRACT_ALL = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
266 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
267 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
268 # be included in the documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
269 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
270 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
271 EXTRACT_PRIVATE = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
272 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
273 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
274 # scope will be included in the documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
275 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
276 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
277 EXTRACT_PACKAGE = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
278 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
279 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
280 # included in the documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
281 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
282 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
283 EXTRACT_STATIC = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
284 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
285 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
286 # locally in source files will be included in the documentation. If set to NO, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
287 # only classes defined in header files are included. Does not have any effect |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
288 # for Java sources. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
289 # The default value is: YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
290 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
291 EXTRACT_LOCAL_CLASSES = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
292 |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
293 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
294 # If this flag is set to YES, the members of anonymous namespaces will be |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
295 # extracted and appear in the documentation as a namespace called |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
296 # 'anonymous_namespace{file}', where file will be replaced with the base name of |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
297 # the file that contains the anonymous namespace. By default anonymous namespace |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
298 # are hidden. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
299 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
300 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
301 EXTRACT_ANON_NSPACES = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
302 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
303 # The INTERNAL_DOCS tag determines if documentation that is typed after a |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
304 # \internal command is included. If the tag is set to NO then the documentation |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
305 # will be excluded. Set it to YES to include the internal documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
306 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
307 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
308 INTERNAL_DOCS = NO |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
309 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
310 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
311 # names in lower-case letters. If set to YES, upper-case letters are also |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
312 # allowed. This is useful if you have classes or files whose names only differ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
313 # in case and if your file system supports case sensitive file names. Windows |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
314 # and Mac users are advised to set this option to NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
315 # The default value is: system dependent. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
316 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
317 CASE_SENSE_NAMES = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
318 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
319 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
320 # files with double quotes in the documentation rather than with sharp brackets. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
321 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
322 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
323 FORCE_LOCAL_INCLUDES = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
324 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
325 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
326 # documentation for inline members. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
327 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
328 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
329 INLINE_INFO = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
330 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
331 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
332 # (detailed) documentation of file and class members alphabetically by member |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
333 # name. If set to NO, the members will appear in declaration order. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
334 # The default value is: YES. |
16222
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
335 |
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
336 SORT_MEMBER_DOCS = YES |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
337 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
338 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
339 # descriptions of file, namespace and class members alphabetically by member |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
340 # name. If set to NO, the members will appear in declaration order. Note that |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
341 # this will also influence the order of the classes in the class list. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
342 # The default value is: NO. |
16222
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
343 |
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
344 SORT_BRIEF_DOCS = YES |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
345 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
346 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
347 # (brief and detailed) documentation of class members so that constructors and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
348 # destructors are listed first. If set to NO the constructors will appear in the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
349 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
350 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
351 # member documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
352 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
353 # detailed member documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
354 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
355 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
356 SORT_MEMBERS_CTORS_1ST = YES |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
357 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
358 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
359 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
360 # page. This will remove the Namespaces entry from the Quick Index and from the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
361 # Folder Tree View (if specified). |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
362 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
363 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
364 SHOW_NAMESPACES = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
365 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
366 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
367 # Configuration options related to warning and progress messages |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
368 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
369 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
370 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
371 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
372 # Configuration options related to the input files |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
373 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
374 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
375 # The INPUT tag is used to specify the files and/or directories that contain |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
376 # documented source files. You may enter file names like myfile.cpp or |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
377 # directories like /usr/src/myproject. Separate the files or directories with |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
378 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
379 # Note: If this tag is empty the current directory is searched. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
380 |
24193
b7e5486e7bff
doc: Doxygen documentation with more descriptive pages.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24163
diff
changeset
|
381 INPUT = @abs_top_srcdir@/src/ \ |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
382 @abs_top_srcdir@/liboctave/ \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
383 @abs_top_srcdir@/libinterp \ |
24193
b7e5486e7bff
doc: Doxygen documentation with more descriptive pages.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24163
diff
changeset
|
384 @abs_top_srcdir@/libgui \ |
b7e5486e7bff
doc: Doxygen documentation with more descriptive pages.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24163
diff
changeset
|
385 @abs_top_srcdir@/etc/HACKING.md \ |
b7e5486e7bff
doc: Doxygen documentation with more descriptive pages.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24163
diff
changeset
|
386 @abs_top_srcdir@/doc/doxyhtml/pages \ |
b7e5486e7bff
doc: Doxygen documentation with more descriptive pages.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24163
diff
changeset
|
387 @abs_top_builddir@/doc/doxyhtml/pages |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
388 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
389 # This tag can be used to specify the character encoding of the source files |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
390 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
391 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
24893
a3eb0d746042
doc: use canonical https URLs for all external gnu.org references
Mike Miller <mtmiller@octave.org>
parents:
24873
diff
changeset
|
392 # documentation (see: https://www.gnu.org/software/libiconv) for the list of |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
393 # possible encodings. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
394 # The default value is: UTF-8. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
395 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
396 INPUT_ENCODING = UTF-8 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
397 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
398 # The RECURSIVE tag can be used to specify whether or not subdirectories should |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
399 # be searched for input files as well. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
400 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
401 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
402 RECURSIVE = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
403 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
404 # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
405 # that contain example code fragments that are included (see the \include |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
406 # command). |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
407 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
408 EXAMPLE_PATH = @abs_top_srcdir@/examples/ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
409 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
410 # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
411 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
412 # *.h) to filter out the source-files in the directories. If left blank all |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
413 # files are included. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
414 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
415 EXAMPLE_PATTERNS = |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
416 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
417 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
418 # searched for input files to be used with the \include or \dontinclude commands |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
419 # irrespective of the value of the RECURSIVE tag. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
420 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
421 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
422 EXAMPLE_RECURSIVE = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
423 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
424 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
425 # Configuration options related to source browsing |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
426 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
427 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
428 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
429 # generated. Documented entities will be cross-referenced with these sources. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
430 # |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
431 # Note: To get rid of all source code in the generated output, make sure that |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
432 # also VERBATIM_HEADERS is set to NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
433 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
434 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
435 SOURCE_BROWSER = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
436 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
437 # Setting the INLINE_SOURCES tag to YES will include the body of functions, |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
438 # classes and enums directly into the documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
439 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
440 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
441 INLINE_SOURCES = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
442 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
443 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
444 # special comment blocks from generated source code fragments. Normal C, C++ and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
445 # Fortran comments will always remain visible. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
446 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
447 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
448 STRIP_CODE_COMMENTS = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
449 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
450 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
451 # function all documented functions referencing it will be listed. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
452 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
453 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
454 REFERENCED_BY_RELATION = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
455 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
456 # If the REFERENCES_RELATION tag is set to YES then for each documented function |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
457 # all documented entities called/used by that function will be listed. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
458 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
459 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
460 REFERENCES_RELATION = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
461 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
462 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
463 # to YES then the hyperlinks from functions in REFERENCES_RELATION and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
464 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
465 # link to the documentation. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
466 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
467 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
468 REFERENCES_LINK_SOURCE = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
469 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
470 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
471 # Configuration options related to the HTML output |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
472 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
473 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
474 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
475 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
476 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
477 GENERATE_HTML = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
478 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
479 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
480 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
481 # it. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
482 # The default directory is: html. i.e. @abs_top_builddir@/doc/doxyhtml |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
483 # This tag requires that the tag GENERATE_HTML is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
484 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
485 HTML_OUTPUT = doxyhtml |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
486 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
487 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
488 # page will contain the date and time when the page was generated. Setting this |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
489 # to YES can help to show when doxygen was last run and thus if the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
490 # documentation is up to date. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
491 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
492 # This tag requires that the tag GENERATE_HTML is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
493 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
494 HTML_TIMESTAMP = YES |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
495 |
24873
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
496 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
497 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
498 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
499 # (.qch) of the generated HTML documentation. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
500 # The default value is: NO. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
501 # This tag requires that the tag GENERATE_HTML is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
502 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
503 GENERATE_QHP = YES |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
504 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
505 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
506 # the file name of the resulting .qch file. The path specified is relative to |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
507 # the HTML output folder. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
508 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
509 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
510 QCH_FILE = ./octave-cpp-api.qch |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
511 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
512 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
513 # Project output. For more information please see Qt Help Project / Namespace |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
514 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
515 # The default value is: org.doxygen.Project. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
516 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
517 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
518 QHP_NAMESPACE = org.octave.cpp-api |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
519 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
520 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
521 # Help Project output. For more information please see Qt Help Project / Virtual |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
522 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
523 # folders). |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
524 # The default value is: doc. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
525 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
526 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
527 QHP_VIRTUAL_FOLDER = doc |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
528 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
529 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
530 # filter to add. For more information please see Qt Help Project / Custom |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
531 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
532 # filters). |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
533 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
534 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
535 QHP_CUST_FILTER_NAME = "Octave C++ API" |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
536 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
537 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
538 # custom filter to add. For more information please see Qt Help Project / Custom |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
539 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
540 # filters). |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
541 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
542 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
543 QHP_CUST_FILTER_ATTRS = "core cpp" |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
544 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
545 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
546 # project's filter section matches. Qt Help Project / Filter Attributes (see: |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
547 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
548 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
549 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
550 QHP_SECT_FILTER_ATTRS = "core cpp" |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
551 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
552 # The QHG_LOCATION tag can be used to specify the location of Qt's |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
553 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
554 # generated .qhp file. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
555 # This tag requires that the tag GENERATE_QHP is set to YES. |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
556 |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
557 QHG_LOCATION = @QHELPGENERATOR@ |
486bc22482ca
Improve Doxygen generation.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
24534
diff
changeset
|
558 |
24163
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
559 # If you want full control over the layout of the generated HTML pages it might |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
560 # be necessary to disable the index and replace it with your own. The |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
561 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
562 # of each HTML page. A value of NO enables the index and the value YES disables |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
563 # it. Since the tabs in the index contain the same information as the navigation |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
564 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
565 # The default value is: NO. |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
566 # This tag requires that the tag GENERATE_HTML is set to YES. |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
567 |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
568 DISABLE_INDEX = YES |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
569 |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
570 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
571 # structure should be generated to display hierarchical information. If the tag |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
572 # value is set to YES, a side panel will be generated containing a tree-like |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
573 # index structure (just like the one that is generated for HTML Help). For this |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
574 # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
575 # (i.e. any modern browser). Windows users are probably better off using the |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
576 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
577 # further fine-tune the look of the index. As an example, the default style |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
578 # sheet generated by doxygen has an example that shows how to put an image at |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
579 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
580 # the same information as the tab index, you could consider setting |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
581 # DISABLE_INDEX to YES when enabling this option. |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
582 # The default value is: NO. |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
583 # This tag requires that the tag GENERATE_HTML is set to YES. |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
584 |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
585 GENERATE_TREEVIEW = YES |
7ff6daa6b558
doc: use tree view in Doxygen documentation and add README and etc/HACKING.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24110
diff
changeset
|
586 |
24895
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
587 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
588 # the HTML output. The underlying search engine uses javascript and DHTML and |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
589 # should work on any modern browser. Note that when using HTML help |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
590 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
591 # there is already a search function so this one should typically be disabled. |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
592 # For large projects the javascript based search engine can be slow, then |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
593 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
594 # search using the keyboard; to jump to the search box use <access key> + S |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
595 # (what the <access key> is depends on the OS and browser, but it is typically |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
596 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
597 # key> to jump into the search results window, the results can be navigated |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
598 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
599 # the search. The filter options can be selected when the cursor is inside the |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
600 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
601 # to select a filter and <Enter> or <escape> to activate or cancel the filter |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
602 # option. |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
603 # The default value is: YES. |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
604 # This tag requires that the tag GENERATE_HTML is set to YES. |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
605 |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
606 SEARCHENGINE = YES |
088506eadb44
Enable build of a reduced Doxygen version for compressed Qt help file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
24893
diff
changeset
|
607 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
608 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
609 # Configuration options related to the LaTeX output |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
610 #--------------------------------------------------------------------------- |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
611 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
612 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
613 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
614 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
615 GENERATE_LATEX = NO |
23055
3fc927d86fe6
* Doxyfile.in: Set LOOKUP_CACHE_SIZE to 2.
John W. Eaton <jwe@octave.org>
parents:
22799
diff
changeset
|
616 |
17114
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
617 #--------------------------------------------------------------------------- |
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
618 # Configuration options related to the preprocessor |
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
619 #--------------------------------------------------------------------------- |
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
620 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
621 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
622 # C-preprocessor directives found in the sources and include files. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
623 # The default value is: YES. |
17114
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
624 |
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
625 ENABLE_PREPROCESSING = YES |
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
626 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
627 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
628 # in the source code. If set to NO, only conditional compilation will be |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
629 # performed. Macro expansion can be done in a controlled way by setting |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
630 # EXPAND_ONLY_PREDEF to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
631 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
632 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
633 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
634 MACRO_EXPANSION = YES |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
635 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
636 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
637 # the macro expansion is limited to the macros specified with the PREDEFINED and |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
638 # EXPAND_AS_DEFINED tags. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
639 # The default value is: NO. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
640 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
641 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
642 EXPAND_ONLY_PREDEF = NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
643 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
644 # If the SEARCH_INCLUDES tag is set to YES, the include files in the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
645 # INCLUDE_PATH will be searched if a #include is found. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
646 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
647 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
648 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
649 SEARCH_INCLUDES = YES |
20240
35fc5ea83030
Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents:
17221
diff
changeset
|
650 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
651 # The INCLUDE_PATH tag can be used to specify one or more directories that |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
652 # contain include files that are not input files but should be processed by the |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
653 # preprocessor. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
654 # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
20240
35fc5ea83030
Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents:
17221
diff
changeset
|
655 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
656 INCLUDE_PATH = @abs_top_srcdir@/libgnu \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
657 @abs_top_srcdir@/libinterp/corefcn \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
658 @abs_top_srcdir@/libinterp/octave-value \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
659 @abs_top_srcdir@/libinterp/operators \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
660 @abs_top_srcdir@/libinterp/parse-tree \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
661 @abs_top_srcdir@/libinterp/template-inst \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
662 @abs_top_srcdir@/liboctave/array \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
663 @abs_top_srcdir@/liboctave/numeric \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
664 @abs_top_srcdir@/liboctave/operators \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
665 @abs_top_srcdir@/liboctave/system \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
666 @abs_top_srcdir@/liboctave/util \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
667 @abs_top_srcdir@/src |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
668 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
669 # The PREDEFINED tag can be used to specify one or more macro names that are |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
670 # defined before the preprocessor is started (similar to the -D option of e.g. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
671 # gcc). The argument of the tag is a list of macros of the form: name or |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
672 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
673 # is assumed. To prevent a macro definition from being undefined via #undef or |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
674 # recursively expanded use the := operator instead of the = operator. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
675 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
676 # |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21298
diff
changeset
|
677 # So that features that are behind #if defined (HAVE_FOO) macros |
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21298
diff
changeset
|
678 # get processed by Doxygen |
17114
1c421f01b737
* Doxyfile.in: Add HAVE_FOO macros so that code behind them gets Doxygenised
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17106
diff
changeset
|
679 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
680 PREDEFINED = HAVE_ARPACK=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
681 HAVE_CCOLAMD=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
682 HAVE_CHOLMOD=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
683 HAVE_CURL=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
684 HAVE_CXSPARSE=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
685 HAVE_FFTW=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
686 HAVE_FFTW3=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
687 HAVE_FFTW3F=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
688 HAVE_FFTW3F_THREADS=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
689 HAVE_FFTW3_THREADS=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
690 HAVE_FREETYPE=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
691 HAVE_GLPK=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
692 HAVE_HDF5=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
693 HAVE_JAVA=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
694 HAVE_LLVM=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
695 HAVE_MAGICK=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
696 HAVE_OPENGL=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
697 HAVE_OPENMP=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
698 HAVE_PCRE_COMPILE=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
699 HAVE_PCRE_H=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
700 HAVE_QHULL=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
701 HAVE_QRUPDATE=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
702 HAVE_QRUPDATE_LUU=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
703 HAVE_QSCINTILLA=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
704 HAVE_QT=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
705 HAVE_UMFPACK=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
706 HAVE_X_WINDOWS=1 \ |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
707 HAVE_ZLIB=1 |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
708 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
709 #--------------------------------------------------------------------------- |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
710 # Configuration options related to the dot tool |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
711 #--------------------------------------------------------------------------- |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
712 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
713 # If set to YES the inheritance and collaboration graphs will hide inheritance |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
714 # and usage relations if the target is undocumented or is not a class. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
715 # The default value is: YES. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
716 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
717 HIDE_UNDOC_RELATIONS = NO |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
718 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
719 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
720 # available from the path. This tool is part of Graphviz (see: |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
721 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
722 # Bell Labs. The other options in this section have no effect if this option is |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
723 # set to NO |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
724 # The default value is: NO. |
16218
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
725 |
e16080e36cf9
Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff
changeset
|
726 HAVE_DOT = YES |
16222
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
727 |
40e34895a987
Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16218
diff
changeset
|
728 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
729 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
730 # that will be shown in the graph. If the number of nodes in a graph becomes |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
731 # larger than this value, doxygen will truncate the graph, which is visualized |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
732 # by representing a node as a red box. Note that doxygen if the number of direct |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
733 # children of the root node in a graph is already larger than |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
734 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
735 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
736 # Minimum value: 0, maximum value: 10000, default value: 50. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
737 # This tag requires that the tag HAVE_DOT is set to YES. |
17102
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
738 # Some of our dependency graphs are really huge... |
c48625614ea6
Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
16222
diff
changeset
|
739 |
20240
35fc5ea83030
Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents:
17221
diff
changeset
|
740 DOT_GRAPH_MAX_NODES = 100 |
24110
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
741 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
742 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
743 # files that are used to generate the various graphs. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
744 # The default value is: YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
745 # This tag requires that the tag HAVE_DOT is set to YES. |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
746 |
194558542203
doc/doxyhtml/Doxyfile.in: Update comments, enable grouping and HTML timestamps.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
23221
diff
changeset
|
747 DOT_CLEANUP = YES |