From 2d0e1dbc025c631ab6b2e741a7c115d07ffee9f3 Mon Sep 17 00:00:00 2001
From: zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>
Date: Wed, 3 Jun 2009 04:44:38 +0000
Subject: [PATCH] Improve remaining documentation that was causing Doxygen
warnings.
git-svn-id: svn://svn.berlios.de/openocd/trunk@2026 b42882b7-edfa-0310-969c-e2dbd0fdcd60
---
TODO | 10 +++++++---
doc/manual/primer/patches.txt | 2 +-
doc/manual/scripting.txt | 2 +-
3 files changed, 9 insertions(+), 5 deletions(-)
diff --git a/TODO b/TODO
index ad0b8e5c6..998521e53 100644
--- a/TODO
+++ b/TODO
@@ -44,10 +44,14 @@ The following tasks have been suggeted for cleaning up the JTAG layer:
- 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 ØH. Michael Bruck also interested in this.
- Encapsulate cmd_queue_cur_state and related varaible handling.
@@ -223,7 +227,7 @@ These ideas were first introduced here:
- 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
diff --git a/doc/manual/primer/patches.txt b/doc/manual/primer/patches.txt
index e104e4ff1..a3d0453f2 100644
--- a/doc/manual/primer/patches.txt
+++ b/doc/manual/primer/patches.txt
@@ -206,5 +206,5 @@ that they spend doing these tasks.
*/
/** @file
-This file contains the @ref patchprimer page.
+This file contains the @ref primerpatches page.
*/
diff --git a/doc/manual/scripting.txt b/doc/manual/scripting.txt
index b3d5a1560..09b69d38b 100644
--- a/doc/manual/scripting.txt
+++ b/doc/manual/scripting.txt
@@ -25,7 +25,7 @@ Default implementation of procedures in tcl/procedures.tcl.
- 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
--
GitLab