summaryrefslogtreecommitdiff
path: root/doc/manual/helper.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/helper.txt')
-rw-r--r--doc/manual/helper.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/manual/helper.txt b/doc/manual/helper.txt
new file mode 100644
index 00000000..91bf2d51
--- /dev/null
+++ b/doc/manual/helper.txt
@@ -0,0 +1,48 @@
+/** @page helperdocs OpenOCD Helper APIs
+
+OpenOCD uses several low-level APIs as the foundation for high-level APIs:
+
+ - @subpage helperporting
+ - @subpage helperjim
+ - @subpage helpercommand
+ - @subpage helperlogging
+ - @subpage helperbuffers
+
+This section needs to be expanded.
+
+ */
+
+/** @page helperporting OpenOCD Types/Portability APIs
+
+This section needs to be expanded to describe OpenOCD's type and
+portability API.
+
+ */
+
+/** @page helperjim OpenOCD Jim API
+
+The Jim API provides access to a small-footprint TCL implementation.
+
+Visit http://jim.berlios.de/ for more information on Jim.
+
+This section needs to be expanded to describe OpenOCD's Jim API.
+
+ */
+
+/** @page helpercommand OpenOCD Command API
+
+This section needs to be expanded to describe OpenOCD's Command API.
+
+ */
+
+/** @page helperlogging OpenOCD Logging API
+
+This section needs to be expanded to describe OpenOCD's Logging API.
+
+ */
+
+/** @page helperbuffers OpenOCD Byte Buffer API
+
+This section needs to be expanded to describe OpenOCD's Byte Buffer API.
+
+ */