[Openocd-svn] r2025 - in trunk/src: helper jtag target

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

Author: zwelch
Date: 2009-06-03 06:37:51 +0200 (Wed, 03 Jun 2009)
New Revision: 2025

Modified:
   trunk/src/helper/jim.h
   trunk/src/jtag/ft2232.c
   trunk/src/jtag/jtag.h
   trunk/src/target/target.h
Log:
Improve in-source documentation that was causing Doxygen warnings.

Modified: trunk/src/helper/jim.h
===================================================================
--- trunk/src/helper/jim.h	2009-06-03 02:57:55 UTC (rev 2024)
+++ trunk/src/helper/jim.h	2009-06-03 04:37:51 UTC (rev 2025)
@@ -1058,6 +1058,7 @@
  *
  * \param goi     - get opt info
  * \param puthere - where param is put
+ * \param len     - return its length
  */
 JIM_STATIC int JIM_API( Jim_GetOpt_String )( Jim_GetOptInfo *goi, char **puthere, int *len );
 

Modified: trunk/src/jtag/ft2232.c
===================================================================
--- trunk/src/jtag/ft2232.c	2009-06-03 02:57:55 UTC (rev 2024)
+++ trunk/src/jtag/ft2232.c	2009-06-03 04:37:51 UTC (rev 2025)
@@ -83,12 +83,14 @@
 
 
 /**
- * Function ft2232_stableclocks
- * will send out \a num_cycles on the TCK line while the TAP(s)
- * are in a stable state.  Calling code must ensure that current state is
- * stable, that verification is not done in here.
- * @param num_cycles is the count of clocks cycles to send.
- * @return int - ERROR_OK or ERROR_JTAG_QUEUE_FAILED
+ * Send out \a num_cycles on the TCK line while the TAP(s) are in a
+ * stable state.  Calling code must ensure that current state is stable,
+ * that verification is not done in here.
+ *
+ * @param num_cycles The number of clocks cycles to send.
+ * @param cmd The command to send.
+ *
+ * @returns ERROR_OK on success, or ERROR_JTAG_QUEUE_FAILED on failure.
  */
 static int ft2232_stableclocks(int num_cycles, jtag_command_t* cmd);
 
@@ -231,19 +233,21 @@
 
 
 /**
- * Function clock_tms
- * clocks out \a bit_count bits on the TMS line, starting with the least
+ * Clocks out \a bit_count bits on the TMS line, starting with the least
  * significant bit of tms_bits and progressing to more significant bits.
  * Rigorous state transition logging is done here via tap_set_state().
  *
- * @param pmsse_cmd is one of the MPSSE TMS oriented commands such as 0x4b or 0x6b.  See
- *   the MPSSE spec referenced above for their functionality. The MPSSE command
- *   "Clock Data to TMS/CS Pin (no Read)" is often used for this, 0x4b.
+ * @param mpsse_cmd One of the MPSSE TMS oriented commands such as
+ * 	0x4b or 0x6b.  See the MPSSE spec referenced above for their
+ * 	functionality. The MPSSE command "Clock Data to TMS/CS Pin (no Read)"
+ * 	is often used for this, 0x4b.
  *
- * @param tms_bits holds the sequence of bits to send.
- * @param tms_count tells how many bits in the sequence.
- * @param tdi_bit is a single bit which is passed on to TDI before the first TCK cycle
- *   and is held static for the duration of TMS clocking.  See the MPSSE spec referenced above.
+ * @param tms_bits Holds the sequence of bits to send.
+ * @param tms_count Tells how many bits in the sequence.
+ * @param tdi_bit A single bit to pass on to TDI before the first TCK
+ * 	cycle and held static for the duration of TMS clocking.
+ *
+ * See the MPSSE spec referenced above.
  */
 static void clock_tms( u8 mpsse_cmd, int tms_bits, int tms_count, bool tdi_bit )
 {

Modified: trunk/src/jtag/jtag.h
===================================================================
--- trunk/src/jtag/jtag.h	2009-06-03 02:57:55 UTC (rev 2024)
+++ trunk/src/jtag/jtag.h	2009-06-03 04:37:51 UTC (rev 2025)
@@ -515,7 +515,7 @@
  * @param data3 An integer big enough to use as an @c int or a pointer.
  *
  */
-extern void jtag_add_callback4(jtag_callback_t, u8 *in,
+extern void jtag_add_callback4(jtag_callback_t f, u8 *in,
 		jtag_callback_data_t data1, jtag_callback_data_t data2,
 		jtag_callback_data_t data3);
 

Modified: trunk/src/target/target.h
===================================================================
--- trunk/src/target/target.h	2009-06-03 02:57:55 UTC (rev 2024)
+++ trunk/src/target/target.h	2009-06-03 04:37:51 UTC (rev 2025)
@@ -325,7 +325,7 @@
 		int timeout_ms, void *arch_info);
 
 /**
- * Read @count items of @a size bytes from the memory of @a target at
+ * Read @a count items of @a size bytes from the memory of @a target at
  * the @a address given.
  *
  * This routine is a wrapper for target->type->read_memory.
@@ -333,7 +333,7 @@
 extern int target_read_memory(struct target_s *target,
 		u32 address, u32 size, u32 count, u8 *buffer);
 /**
- * Write @count items of @a size bytes to the memory of @a target at
+ * Write @a count items of @a size bytes to the memory of @a target at
  * the @a address given.
  *
  * This routine is wrapper for target->type->write_memory.
@@ -342,7 +342,7 @@
 		u32 address, u32 size, u32 count, u8 *buffer);
 
 /**
- * Write @count items of 4 bytes to the memory of @a target at
+ * Write @a count items of 4 bytes to the memory of @a target at
  * the @a address given.  Because it operates only on whole words,
  * this should be faster than target_write_memory().
  *