doc/manual/main.txt

   1 /** @mainpage OpenOCD Reference Manual
   2
   3 @ref oocd explains how the code has been organized into layers
   4 of APIs and gives an overview of how they fit together.  These pages
   5 attempt to give developers a high-level perspective of the various
   6 code modules provided by OpenOCD.
   7
   8 @ref primer provide introductory materials for new developers.
   9
  10 The List of @ref thelist enumerates opportunities for improving or
  11 extending the OpenOCD platform.
  12
  13  */
  14
  15 /** @page primer OpenOCD Technical Primers
  16
  17 This pages lists Technical Primers available for OpenOCD Developers.
  18 They seek to provide information to pull novices up the learning curves
  19 associated with the fundamental technologies used by OpenOCD.
  20
  21 - @subpage primerjtag
  22
  23 Contributions or suggestions for new Technical Primers are welcome.
  24
  25  */
  26
  27 /** @page oocd OpenOCD Architecture
  28
  29 The OpenOCD library consists of several APIs that build together to
  30 provide the support functionality.  The following list shows how these
  31 modules are stacked in the current implementation (from bottom to top):
  32
  33 - @subpage helperdocs
  34   - @ref helperporting
  35   - @ref helperjim
  36   - @ref helpercommand
  37   - @ref helperlogging
  38 - @subpage jtagdocs
  39   - @ref jtagcable
  40   - @ref jtagtap
  41   - @ref jtagmdriver
  42   - @ref jtagdriver
  43 - @subpage targetdocs
  44   - @ref targetarm
  45   - @ref targetnotarm
  46   - @ref targetregister
  47   - @ref targetimage
  48   - @ref targettrace
  49 - @subpage flashdocs
  50   - @ref flashcfi
  51   - @ref flashnand
  52   - @ref flashtarget
  53 - @subpage serverdocs
  54   - @ref servergdb
  55   - @ref servertelnet
  56   - @ref serverhttp
  57 - @subpage appdocs
  58
  59 Obviously, there are some nuances to the stack that are not shown by
  60 this linear list of layers.
  61
  62 The List of @ref thelist enumerates opportunities for improving or
  63 extending the OpenOCD platform.
  64
  65  */