gdb/doc/doxy-index.in

   1 <!-- Copyright (C) 2014-2024 Free Software Foundation, Inc.
   2
   3 Navigation page for Doxygen-generated GDB info.
   4
   5 This file is part of GDB.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 -->
  20
  21 <html lang="en">
  22 <head>
  23 <title>GDB Internals (Doxygen)</title>
  24 <meta http-equiv="Content-Type" content="text/html">
  25 <meta name="description" content="GDB Internals (Doxygen)">
  26 <meta http-equiv="Content-Style-Type" content="text/css">
  27 <style type="text/css">
  28 </style>
  29 </head>
  30 <body>
  31
  32 <p>
  33 This page is the index to doxygen-generated pages describing GDB
  34 internals.
  35
  36 <p>
  37 These are primarily useful for people working on GDB itself.  Users of
  38 GDB, people working with stubs, and people working on frontends to GDB
  39 are all better served by the GDB manual, which is the official
  40 definition for all of GDB's external interfaces.
  41
  42 <h2>
  43 <a href="gdb-api/index.html">GDB internal API</a>
  44 </h2>
  45
  46 <p>
  47 The GDB internal API consists of all definitions and functions
  48 that are of interest to multiple areas of the debugger.
  49
  50 <p>
  51 Note that this internal API reference lists only header files for
  52 which doxygen-type documentation has been added, and explicitly listed
  53 as a part of the API.
  54
  55 <h2>
  56 <a href="gdb-xref/index.html">GDB full source cross-reference</a>
  57 </h2>
  58
  59 <p>
  60 This cross-reference includes all of the GDB sources proper, omitting
  61 support libraries such as BFD, and files that are not compiled into
  62 GDB.
  63
  64 <p>
  65 It is not guaranteed to report all uses of a construct, and you should
  66 independently check non-use of a symbol before trying to remove it.
  67
  68 <h2>
  69 <a href="gdbserver/index.html">GDBserver source cross-reference</a>
  70 </h2>
  71
  72 <p>
  73 Similar to the GDB cross-reference, but for GDBserver sources.
  74
  75 </body>
  76 </html>