summaryrefslogtreecommitdiff
path: root/gdb/doc/Doxyfile-gdb-api.in
diff options
context:
space:
mode:
authorStan Shebs <stan@codesourcery.com>2014-02-11 09:31:14 +1030
committerStan Shebs <stan@adell>2014-02-10 19:10:34 -0800
commit1e0a51780bc504ff110cc623954cdf9e71a26ad1 (patch)
treebc3b3cdaa95f4a3c76ed039af67871cca567627a /gdb/doc/Doxyfile-gdb-api.in
parent8f3f987531fa46b3383956919ae16461306eeb35 (diff)
downloadbinutils-gdb-1e0a51780bc504ff110cc623954cdf9e71a26ad1.tar.gz
Add Doxygen support to GDB
Diffstat (limited to 'gdb/doc/Doxyfile-gdb-api.in')
-rw-r--r--gdb/doc/Doxyfile-gdb-api.in38
1 files changed, 38 insertions, 0 deletions
diff --git a/gdb/doc/Doxyfile-gdb-api.in b/gdb/doc/Doxyfile-gdb-api.in
new file mode 100644
index 00000000000..02f8bddba8d
--- /dev/null
+++ b/gdb/doc/Doxyfile-gdb-api.in
@@ -0,0 +1,38 @@
+# Copyright (C) 2014 Free Software Foundation, Inc.
+
+# Doxygen file for GDB internal API.
+# This file is part of GDB.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+@INCLUDE = Doxyfile-base
+
+PROJECT_NAME = "GDB (API)"
+
+# Enumerate the files to process. In general these should be header
+# files with definitions of general interest, rather than ones that
+# are specific to a single target or configuration. (The cross
+# reference pages are available to developers wanting a list of
+# everything.)
+
+INPUT = @srcdir@/../defs.h \
+ @srcdir@/../minsyms.h \
+ @srcdir@/../utils.h
+
+HTML_OUTPUT = ./doxy/gdb-api
+
+# Suppress classes/structs local to source files, they are unlikely
+# to be of general API interest.
+
+EXTRACT_LOCAL_CLASSES = NO