[Openocd-svn] r2026 - in trunk: . doc/manual doc/manual/primer

[<zw...@ma...>]

Author: zwelch
Date: 2009-06-03 06:44:38 +0200 (Wed, 03 Jun 2009)
New Revision: 2026

Modified:
   trunk/TODO
   trunk/doc/manual/primer/patches.txt
   trunk/doc/manual/scripting.txt
Log:
Improve remaining documentation that was causing Doxygen warnings.

Modified: trunk/TODO
===================================================================
--- trunk/TODO	2009-06-03 04:37:51 UTC (rev 2025)
+++ trunk/TODO	2009-06-03 04:44:38 UTC (rev 2026)
@@ -44,10 +44,14 @@
 
 - use tap_set_state everywhere to allow logging TAP state transitions
 - rename other tap_states to use standard JTAG names (suggested by ML)
+
 - retire jtag_add_end_state() and replace w/global variable:
   - removes TAP_INVALID as an argument to jtag_add_xxxx().
-  - global variable as argument to jtag_add_xxxx() should be phased out, but
-    it is useful while we need to bug-by-bug compatible while testing changes.
+
+  - global variable as argument to jtag_add_xxxx() should be phased out,
+    but it is useful while we need to bug-by-bug compatible while
+    testing changes.
+
  - Suggested by . Michael Bruck also interested in this.
 - Encapsulate cmd_queue_cur_state and related varaible handling.
 
@@ -223,7 +227,7 @@
 
 - investigate fixes to permit the use of -Wshadow
 - eliminate sources of confusion in @c boostrap script:
-  -# Make @c bootstrap call 'configure --enable-maintainer-mode <opts>'?
+  -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
   -# Add @c buildstrap script to assist with boostrap and configure steps.
 - automatically build tool-chains required for cross-compiling
   - produce mingw32, arm-elf, others using in-tree scripts

Modified: trunk/doc/manual/primer/patches.txt
===================================================================
--- trunk/doc/manual/primer/patches.txt	2009-06-03 04:37:51 UTC (rev 2025)
+++ trunk/doc/manual/primer/patches.txt	2009-06-03 04:44:38 UTC (rev 2026)
@@ -206,5 +206,5 @@
 
  */
 /** @file
-This file contains the @ref patchprimer page.
+This file contains the @ref primerpatches page.
 */

Modified: trunk/doc/manual/scripting.txt
===================================================================
--- trunk/doc/manual/scripting.txt	2009-06-03 04:37:51 UTC (rev 2025)
+++ trunk/doc/manual/scripting.txt	2009-06-03 04:44:38 UTC (rev 2026)
@@ -25,7 +25,7 @@
 - Polymorphic commands for target scripts.
   - there will be added some commands in Tcl that the target
     scripts can replace.
-  - produce <productionfile> <serialnumber>. Default implementation
+  - produce \<productionfile\> \<serialnumber\>. Default implementation
     is to ignore serial number and write a raw binary file
     to beginning of first flash. Target script can dictate
     file format and structure of serialnumber. Tcl allows