aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/helper.txt
diff options
context:
space:
mode:
authorzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-05-13 08:58:08 +0000
committerzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-05-13 08:58:08 +0000
commit624aa80f8478a9beb3ee9497a535a80ec2d42638 (patch)
tree0c8539e8b5c80c4d98585cdd048f31663f2cd440 /doc/manual/helper.txt
parent23a07044516db49c31904b912ae189b27123e5a4 (diff)
downloadriscv-openocd-624aa80f8478a9beb3ee9497a535a80ec2d42638.zip
riscv-openocd-624aa80f8478a9beb3ee9497a535a80ec2d42638.tar.gz
riscv-openocd-624aa80f8478a9beb3ee9497a535a80ec2d42638.tar.bz2
Commit skeleton files for high-level developer manual using doxygen.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1771 b42882b7-edfa-0310-969c-e2dbd0fdcd60
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 0000000..91bf2d5
--- /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.
+
+ */