git.sur5r.net Git - openocd/blob - doc/manual/main.txt

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