Skip to content
Snippets Groups Projects
Commit 2d0e1dbc authored by zwelch's avatar zwelch
Browse files

Improve remaining documentation that was causing Doxygen warnings.

git-svn-id: svn://svn.berlios.de/openocd/trunk@2026 b42882b7-edfa-0310-969c-e2dbd0fdcd60
parent 9a5acdc1
No related branches found
No related tags found
No related merge requests found
...@@ -44,10 +44,14 @@ The following tasks have been suggeted for cleaning up the JTAG layer: ...@@ -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 - use tap_set_state everywhere to allow logging TAP state transitions
- rename other tap_states to use standard JTAG names (suggested by ML) - rename other tap_states to use standard JTAG names (suggested by ML)
- retire jtag_add_end_state() and replace w/global variable: - retire jtag_add_end_state() and replace w/global variable:
- removes TAP_INVALID as an argument to jtag_add_xxxx(). - 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. - Suggested by ØH. Michael Bruck also interested in this.
- Encapsulate cmd_queue_cur_state and related varaible handling. - Encapsulate cmd_queue_cur_state and related varaible handling.
...@@ -223,7 +227,7 @@ These ideas were first introduced here: ...@@ -223,7 +227,7 @@ These ideas were first introduced here:
- investigate fixes to permit the use of -Wshadow - investigate fixes to permit the use of -Wshadow
- eliminate sources of confusion in @c boostrap script: - 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. -# Add @c buildstrap script to assist with boostrap and configure steps.
- automatically build tool-chains required for cross-compiling - automatically build tool-chains required for cross-compiling
- produce mingw32, arm-elf, others using in-tree scripts - produce mingw32, arm-elf, others using in-tree scripts
......
...@@ -206,5 +206,5 @@ that they spend doing these tasks. ...@@ -206,5 +206,5 @@ that they spend doing these tasks.
*/ */
/** @file /** @file
This file contains the @ref patchprimer page. This file contains the @ref primerpatches page.
*/ */
...@@ -25,7 +25,7 @@ Default implementation of procedures in tcl/procedures.tcl. ...@@ -25,7 +25,7 @@ Default implementation of procedures in tcl/procedures.tcl.
- Polymorphic commands for target scripts. - Polymorphic commands for target scripts.
- there will be added some commands in Tcl that the target - there will be added some commands in Tcl that the target
scripts can replace. scripts can replace.
- produce <productionfile> <serialnumber>. Default implementation - produce \<productionfile\> \<serialnumber\>. Default implementation
is to ignore serial number and write a raw binary file is to ignore serial number and write a raw binary file
to beginning of first flash. Target script can dictate to beginning of first flash. Target script can dictate
file format and structure of serialnumber. Tcl allows file format and structure of serialnumber. Tcl allows
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment