Commit | Line | Data |
---|---|---|
32d0add0 | 1 | # Copyright (C) 2014-2015 Free Software Foundation, Inc. |
1e0a5178 SS |
2 | |
3 | # Base doxyfile for GDB. | |
4 | # This file is part of GDB. | |
5 | ||
6 | # This program is free software; you can redistribute it and/or modify | |
7 | # it under the terms of the GNU General Public License as published by | |
8 | # the Free Software Foundation; either version 3 of the License, or | |
9 | # (at your option) any later version. | |
10 | # | |
11 | # This program is distributed in the hope that it will be useful, | |
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | # GNU General Public License for more details. | |
15 | # | |
16 | # You should have received a copy of the GNU General Public License | |
17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | ||
19 | # The definitions in this file are shared by several different | |
20 | # renditions of GDB documentation, and should reflect common | |
21 | # GDB practices and assumptions. | |
22 | ||
23 | # (Note that we are not following a common doxygen practice, which is | |
24 | # to include the entirety of doxygen's large default Doxyfile, and | |
25 | # edit it slightly for the project. Instead, these Doxyfile fragments | |
26 | # include only parameter settings that differ from the default.) | |
27 | ||
28 | PROJECT_NAME = "GDB" | |
29 | ||
30 | # Start out with an everything-is-documented assumption. (Later | |
31 | # on we may want to limit to only specific areas.) | |
32 | ||
33 | EXTRACT_ALL = YES | |
34 | ||
35 | # These are intended for GDB developers, so include anything flagged | |
36 | # "internal". | |
37 | ||
38 | INTERNAL_DOCS = YES | |
39 | ||
40 | # Always dig through subdirectories. | |
41 | ||
42 | RECURSIVE = YES | |
43 | ||
44 | INCLUDE_PATH = @srcdir@/../ @srcdir@/../common @srcdir@/../../include/ | |
45 | ||
46 | # Exclude testsuite and other subdirectories that do not have any code | |
47 | # that goes into GDB or GDBserver. | |
48 | ||
49 | EXCLUDE = @srcdir@/../gdbserver/ \ | |
50 | ../gdbserver/ \ | |
51 | @srcdir@/../gnulib/ \ | |
52 | ../build-gnulib/ \ | |
53 | @srcdir@/../testsuite/ \ | |
54 | ../testsuite/ \ | |
55 | @srcdir@/../stubs/ | |
56 | ||
57 | # Scrub out any stuff that might be a problem for Doxygen. | |
58 | ||
59 | INPUT_FILTER = @srcdir@/filter-for-doxygen | |
60 | ||
61 | # Comment this out (or set to YES) to see lots of finicky complaints. | |
62 | ||
63 | WARN_IF_DOC_ERROR = NO | |
64 | ||
65 | # By default, HTML will be generated. | |
66 | ||
67 | # We are missing javascript to make this work? | |
68 | #HTML_DYNAMIC_SECTIONS = YES | |
69 | ||
70 | # In 1.8 only? | |
71 | #HTML_INDEX_NUM_ENTRIES = 10 | |
72 | ||
73 | # We never have a use for a LaTex version of this. | |
74 | ||
75 | GENERATE_LATEX = NO | |
76 | ||
77 | # We always want to get to sources easily. | |
78 | ||
79 | SOURCE_BROWSER = YES | |
80 | ||
81 | FORCE_LOCAL_INCLUDES = YES | |
82 | ||
83 | # We would like to have full macro expansion, but it's very slow. | |
84 | ||
85 | ENABLE_PREPROCESSING = YES | |
86 | #MACRO_EXPANSION = YES | |
87 | #EXPAND_ONLY_PREDEF = YES | |
88 | #PREDEFINED = __attribute__(x)= __extension__= | |
89 | ||
90 | # Suppress the huge volume of chatter. | |
91 | ||
92 | QUIET = YES |