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 primertcl
  22 - @subpage primerjtag
  23
  24 Contributions or suggestions for new Technical Primers are welcome.
  25
  26  */
  27
  28 /** @page oocd OpenOCD Architecture
  29
  30 The OpenOCD library consists of several APIs that build together to
  31 provide the support functionality.  The following list shows how these
  32 modules are stacked in the current implementation (from bottom to top):
  33
  34 - @subpage helperdocs
  35   - @ref helperporting
  36   - @ref helperjim
  37   - @ref helpercommand
  38   - @ref helperlogging
  39 - @subpage jtagdocs
  40   - @ref jtagcable
  41   - @ref jtagtap
  42   - @ref jtagmdriver
  43   - @ref jtagdriver
  44 - @subpage targetdocs
  45   - @ref targetarm
  46   - @ref targetnotarm
  47   - @ref targetregister
  48   - @ref targetimage
  49   - @ref targettrace
  50 - @subpage flashdocs
  51   - @ref flashcfi
  52   - @ref flashnand
  53   - @ref flashtarget
  54 - @subpage serverdocs
  55   - @ref servergdb
  56   - @ref servertelnet
  57   - @ref serverhttp
  58 - @subpage appdocs
  59
  60 Obviously, there are some nuances to the stack that are not shown by
  61 this linear list of layers.
  62
  63 The List of @ref thelist enumerates opportunities for improving or
  64 extending the OpenOCD platform.
  65
  66  */