From 624aa80f8478a9beb3ee9497a535a80ec2d42638 Mon Sep 17 00:00:00 2001 From: zwelch Date: Wed, 13 May 2009 08:58:08 +0000 Subject: 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 --- doc/manual/helper.txt | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 doc/manual/helper.txt (limited to 'doc/manual/helper.txt') 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. + + */ -- cgit v1.2.3