diff options
| author | Stan Shebs <stan@codesourcery.com> | 2014-02-11 09:31:14 +1030 |
|---|---|---|
| committer | Stan Shebs <stan@adell> | 2014-02-10 19:10:34 -0800 |
| commit | 1e0a51780bc504ff110cc623954cdf9e71a26ad1 (patch) | |
| tree | bc3b3cdaa95f4a3c76ed039af67871cca567627a /gdb/doc/doxy-index.in | |
| parent | 8f3f987531fa46b3383956919ae16461306eeb35 (diff) | |
| download | gdb-1e0a51780bc504ff110cc623954cdf9e71a26ad1.zip gdb-1e0a51780bc504ff110cc623954cdf9e71a26ad1.tar.gz gdb-1e0a51780bc504ff110cc623954cdf9e71a26ad1.tar.bz2 | |
Add Doxygen support to GDB
Diffstat (limited to 'gdb/doc/doxy-index.in')
| -rw-r--r-- | gdb/doc/doxy-index.in | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/gdb/doc/doxy-index.in b/gdb/doc/doxy-index.in new file mode 100644 index 0000000..b869038 --- /dev/null +++ b/gdb/doc/doxy-index.in @@ -0,0 +1,76 @@ +<!-- Copyright (C) 2014 Free Software Foundation, Inc. + +Navigation page for Doxygen-generated GDB info. + +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/>. +--> + +<html lang="en"> +<head> +<title>GDB Internals (Doxygen)</title> +<meta http-equiv="Content-Type" content="text/html"> +<meta name="description" content="GDB Internals (Doxygen)"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<style type="text/css"> +</style> +</head> +<body> + +<p> +This page is the index to doxygen-generated pages describing GDB +internals. + +<p> +These are primarily useful for people working on GDB itself. Users of +GDB, people working with stubs, and people working on frontends to GDB +are all better served by the GDB manual, which is the official +definition for all of GDB's external interfaces. + +<h2> +<a href="gdb-api/index.html">GDB internal API</a> +</h2> + +<p> +The GDB internal API consists of all definitions and functions +that are of interest to multiple areas of the debugger. + +<p> +Note that this internal API reference lists only header files for +which doxygen-type documentation has been added, and explicitly listed +as a part of the API. + +<h2> +<a href="gdb-xref/index.html">GDB full source cross-reference</a> +</h2> + +<p> +This cross-reference includes all of the GDB sources proper, omitting +support libraries such as BFD, and files that are not compiled into +GDB. + +<p> +It is not guaranteed to report all uses of a construct, and you should +independently check non-use of a symbol before trying to remove it. + +<h2> +<a href="gdbserver/index.html">GDBserver source cross-reference</a> +</h2> + +<p> +Similar to the GDB cross-reference, but for GDBserver sources. + +</body> +</html> |