1 /** @mainpage OpenOCD Reference Manual
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.
8 @ref primer provide introductory materials for new developers.
10 The List of @ref thelist enumerates opportunities for improving or
11 extending the OpenOCD platform.
15 /** @page primer OpenOCD Technical Primers
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.
24 Contributions or suggestions for new Technical Primers are welcome.
28 /** @page oocd OpenOCD Architecture
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):
60 Obviously, there are some nuances to the stack that are not shown by
61 this linear list of layers.
63 The List of @ref thelist enumerates opportunities for improving or
64 extending the OpenOCD platform.