Mercurial > octave

annotate doc/doxyhtml/Doxyfile.in @ 21298:31cd45258fc6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Fix doxygen build system integration * doc/module.mk (doxyhtml): Add Doxyfile as a prerequisite. (doxyhtml-maintainer-clean): Simplify rule to clean doxyhtml directory. * Doxyfile.in (PROJECT_LOGO): Use correct path to icon. (STRIP_FROM_PATH, INCLUDE_PATH, INPUT, EXAMPLE_PATH): Use abs_top_srcdir. (PREDEFINED): Add HAVE_OPENGL and HAVE_QSCINTILLA to the list, sort.
author Mike Miller <mtmiller@octave.org>
date Thu, 18 Feb 2016 12:10:34 -0800
parents 35fc5ea83030
children aba2e6293dd8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
3 # Doxyfile for Doxygen 1.7.1
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
4
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
5 # 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
6 # 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
7 #
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
8 # All text after a hash (#) is considered a comment and will be ignored
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
9 # The format is:
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
10 # TAG = value [value, ...]
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
11 # For lists items can also be appended using:
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
12 # TAG += value [value, ...]
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
13 # Values that contain spaces should be placed between quotes (" ")
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
14
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
15 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
16 # Project related configuration options
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
17 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
18
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
19 # This tag specifies the encoding used for all characters in the
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
20 # config file that follow. We don't use anything but ASCII, but
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
21 # there's no problem using UTF-8 from now on
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
22
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
23 DOXYFILE_ENCODING = UTF-8
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
24
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
25 # Who we are. :-)
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
26
16222
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
27 PROJECT_NAME = "GNU Octave"
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
28
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
29 PROJECT_BRIEF = "A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab"
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
30
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
31 # The public stable API version (unrelated to the internal API
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
32 # version).
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
33
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
34 PROJECT_NUMBER = @PACKAGE_VERSION@
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
35
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
36 # Our logo!
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
37
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
38 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
39
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
40 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
41 # base path where the generated documentation will be put.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
42
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
43 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
44
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
45 # Create 4096 sub-directories (in 2 levels) under the output directory
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
46 # of each output format and will distribute the generated files over
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
47 # these directories. Enabling this option is useful for us, since
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
48 # feeding doxygen a huge amount of source files would put all
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
49 # generated files in the same directory would otherwise cause
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
50 # performance problems for the file system.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
51
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
52 CREATE_SUBDIRS = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
53
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
54 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
55 # documentation generated by doxygen is written.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
56
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
57 OUTPUT_LANGUAGE = English
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
58
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
59 # Include brief member descriptions after the members that are listed
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
60 # in the file and class documentation (similar to JavaDoc). Set to NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
61 # to disable this.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
62
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
63 BRIEF_MEMBER_DESC = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
64
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
65 # Prepend the brief description of a member or function before the
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
66 # detailed description. Note: if both HIDE_UNDOC_MEMBERS and
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
67 # BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
68 # completely suppressed.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
69
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
70 REPEAT_BRIEF = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
71
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
72 # 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
73 # 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
74 # description.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
75
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
76 ALWAYS_DETAILED_SEC = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
77
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
78 # Show inherited members as if they were part of the current class
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
79
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
80 INLINE_INHERITED_MEMB = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
81
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
82 # Prepend the full path before files name in the file list and in the
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
83 # header files.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
84
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
85 FULL_PATH_NAMES = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
86
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
87 # Remove from the full path names the absolute prefix
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
88
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
89 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
90
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
91 # Interpret the first line (until the first dot) of a JavaDoc-style
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
92 # comment as the brief description (without needing the @brief
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
93 # command).
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
94
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
95 JAVADOC_AUTOBRIEF = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
96
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
97 # Interpret the first line (until the first dot) of a Qt-style comment
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
98 # as the brief descriptio (without needing the \brief command).
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
99
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
100 QT_AUTOBRIEF = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
101
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
102 # Undocumented member inherits the documentation from any documented
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
103 # member that it re-implements.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
104
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
105 INHERIT_DOCS = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
106
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
107 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
108 # a new page for each member. If set to NO, the documentation of a member will
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
109 # be part of the file/class/namespace that contains it.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
110
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
111 SEPARATE_MEMBER_PAGES = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
112
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
113 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
114 # Doxygen uses this value to replace tabs by spaces in code fragments.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
115 # We shouldn't have any tabs in the source code to begin with, however.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
116
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
117 TAB_SIZE = 2
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
118
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
119 # Figure out C++ stdlib classes without needing to parse those files.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
120
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
121 BUILTIN_STL_SUPPORT = YES
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 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
124 # Build related configuration options
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
125 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
126
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
127 # Assume all entities in documentation are documented, even if no
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
128 # documentation was available.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
129
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
130 EXTRACT_ALL = YES
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 # Include all private members of a class.
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 EXTRACT_PRIVATE = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
135
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
136 # Include all static members of a file.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
137
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
138 EXTRACT_STATIC = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
139
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
140 # Include classes (and structs) defined locally in source files in the
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
141 # documentation.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
142
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
143 EXTRACT_LOCAL_CLASSES = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
144
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
145 # We have very few namespaces, so show the ones we have
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
146
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
147 SHOW_NAMESPACES = YES
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
148
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
149 # We don't use namespaces, but if we did, this would extract the
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
150 # anonymous one.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
151
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
152 EXTRACT_ANON_NSPACES = YES
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 # Hide internal docs, those with the \internal command.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
155
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
156 INTERNAL_DOCS = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
157
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
158 # Case-sensitive filenames
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
159
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
160 CASE_SENSE_NAMES = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
161
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
162 # List include files with double quotes in the documentation rather
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
163 # than with sharp brackets.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
164
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
165 FORCE_LOCAL_INCLUDES = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
166
16222
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
167 # Show members alphabetically
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
168
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
169 SORT_MEMBER_DOCS = YES
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
170
16222
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
171 # Also sort the brief descriptions
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
172
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
173 SORT_BRIEF_DOCS = YES
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 # Put ctors first.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
176
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
177 SORT_MEMBERS_CTORS_1ST = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
178
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
179 #---------------------------------------------------------------------------
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
180 # 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
181 #---------------------------------------------------------------------------
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
182
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
183 # On by default, but let's be explicit
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
184
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
185 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
186
17221
a594e0d980eb Expand all macros for doxygen documentation.
Patrick Noffke <patrick.noffke@gmail.com>
parents: 17114
diff changeset
187 # Expand all macros
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
188
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
189 MACRO_EXPANSION = YES
17221
a594e0d980eb Expand all macros for doxygen documentation.
Patrick Noffke <patrick.noffke@gmail.com>
parents: 17114
diff changeset
190 EXPAND_ONLY_PREDEF = NO
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
191
20240
35fc5ea83030 Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents: 17221
diff changeset
192 # We need to specify INCLUDE_PATH otherwise preprocessor will fail to
35fc5ea83030 Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents: 17221
diff changeset
193 # include, and macro expansion will not work.
35fc5ea83030 Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents: 17221
diff changeset
194
35fc5ea83030 Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents: 17221
diff changeset
195 INCLUDE_PATH = \
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
196 @abs_top_srcdir@/libgnu \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
197 @abs_top_srcdir@/libinterp/corefcn \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
198 @abs_top_srcdir@/libinterp/octave-value \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
199 @abs_top_srcdir@/libinterp/operators \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
200 @abs_top_srcdir@/libinterp/parse-tree \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
201 @abs_top_srcdir@/libinterp/template-inst \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
202 @abs_top_srcdir@/liboctave/array \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
203 @abs_top_srcdir@/liboctave/numeric \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
204 @abs_top_srcdir@/liboctave/operators \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
205 @abs_top_srcdir@/liboctave/system \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
206 @abs_top_srcdir@/liboctave/util \
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
207 @abs_top_srcdir@/src
20240
35fc5ea83030 Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents: 17221
diff changeset
208
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
209 # So that features that are behind #ifdef HAVE_FOO macros get processed by Doxygen
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
210
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
211 PREDEFINED = HAVE_ARPACK=1 \
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
212 HAVE_CCOLAMD=1 \
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
213 HAVE_CHOLMOD=1 \
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
214 HAVE_CURL=1 \
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
215 HAVE_CXSPARSE=1 \
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
216 HAVE_FFTW=1 \
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
217 HAVE_FFTW3=1 \
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
218 HAVE_FFTW3F=1 \
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
219 HAVE_FFTW3F_THREADS=1 \
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
220 HAVE_FFTW3_THREADS=1 \
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
221 HAVE_FREETYPE=1 \
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
222 HAVE_GLPK=1 \
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
223 HAVE_HDF5=1 \
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
224 HAVE_LLVM=1 \
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
225 HAVE_MAGICK=1 \
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
226 HAVE_OPENGL=1 \
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
227 HAVE_OPENMP=1 \
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
228 HAVE_PCRE_COMPILE=1 \
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
229 HAVE_PCRE_H=1 \
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
230 HAVE_QHULL=1 \
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
231 HAVE_QRUPDATE=1 \
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
232 HAVE_QRUPDATE_LUU=1 \
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
233 HAVE_QSCINTILLA=1 \
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
234 HAVE_QT=1 \
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
235 HAVE_UMFPACK=1 \
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
236 HAVE_X_WINDOWS=1 \
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
237 HAVE_ZLIB=1
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
238
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
239 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
240 # configuration options related to the input files
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
241 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
242
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
243 # Which directories contain Octave source code
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
244
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
245 INPUT = @abs_top_srcdir@/src/ @abs_top_srcdir@/liboctave/
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
246 INPUT += @abs_top_srcdir@/libinterp @abs_top_srcdir@/libgui
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
247
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
248 # Search subdirectories for input.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
249
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
250 RECURSIVE = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
251
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
252 # Our examples.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
253
21298
31cd45258fc6 maint: Fix doxygen build system integration
Mike Miller <mtmiller@octave.org>
parents: 20240
diff changeset
254 EXAMPLE_PATH = @abs_top_srcdir@/examples/
16218
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 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
257 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
258 # and *.h) to filter out the source-files in the directories. If left
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
259 # blank all files are included.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
260
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
261 EXAMPLE_PATTERNS =
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
262
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
263 # There are no extra C++ files in the examples subdir
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 EXAMPLE_RECURSIVE = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
266
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
267 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
268 # configuration options related to source browsing
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
269 #---------------------------------------------------------------------------
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 # Generate a list of source files will be generated.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
272
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
273 SOURCE_BROWSER = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
274
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
275 # Setting the INLINE_SOURCES tag to YES will include the body
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
276 # of functions and classes directly in the documentation.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
277
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
278 INLINE_SOURCES = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
279
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
280 # Don't hide the special Doxygen comment blocks
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
281
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
282 STRIP_CODE_COMMENTS = NO
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
283
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
284 # For each documented function, list all documented functions
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
285 # referencing it.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
286
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
287 REFERENCED_BY_RELATION = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
288
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
289 # For each documented function all documented entities called/used by
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
290 # that function will be listed.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
291
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
292 REFERENCES_RELATION = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
293
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
294 # References link to documentation, not source code.
16218
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
295
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
296 REFERENCES_LINK_SOURCE = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
297
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
298 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
299 # configuration options related to the HTML output
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
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
302 # Generate HTML
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
303
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
304 GENERATE_HTML = YES
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
305
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
306 # i.e. @abs_top_builddir@/doc/doxyhtml
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 HTML_OUTPUT = doxyhtml
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
309
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
310 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
311 # configuration options related to the LaTeX output
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
312 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
313
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
314 # No LaTeX
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
315
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
316 GENERATE_LATEX = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
317
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
318 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
319 # 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
320 #---------------------------------------------------------------------------
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
321
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
322 # Show undocumented relations
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
323
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
324 HIDE_UNDOC_RELATIONS = NO
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
325
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
326 # Use dot from graphviz to generate class diagrams.
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
327
e16080e36cf9 Doxyfile: new file for generating Doxygen output
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
diff changeset
328 HAVE_DOT = YES
16222
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
329
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
330 # Remove intermediate dot files.
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
331
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
332 DOT_CLEANUP = YES
40e34895a987 Doxyfile: miscellaneous tweaks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16218
diff changeset
333
17102
c48625614ea6 Properly incorporate Doxygen into the build system
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 16222
diff changeset
334 # 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
335
20240
35fc5ea83030 Doxyfile.in: set INCLUDE_PATH required for doxygen macro expansion (bug #45152)
Carnë Draug <carandraug@octave.org>
parents: 17221
diff changeset
336 DOT_GRAPH_MAX_NODES = 100