doxygen: fix some function prototype description
authorAntonio Borneo <borneo.antonio@gmail.com>
Sat, 22 Jan 2022 23:37:10 +0000 (00:37 +0100)
committerAntonio Borneo <borneo.antonio@gmail.com>
Mon, 14 Feb 2022 15:11:21 +0000 (15:11 +0000)
Change-Id: I49311a643ea73143839d2f6bde976cfd76f8c67f
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/6830
Tested-by: jenkins
src/jtag/drivers/jlink.c
src/jtag/drivers/ulink.c
src/jtag/jtag.h

index fdf4ae778ddeb7c97ef9bdf0c02236316130066a..5c218742b44295951bcaf26f4b261bf5691783ae 100644 (file)
@@ -114,8 +114,6 @@ static int jlink_flush(void);
  * @param in A pointer to store TDO data to, if NULL the data will be discarded.
  * @param in_offset A bit offset for TDO data.
  * @param length Amount of bits to transfer out and in.
- *
- * @retval This function doesn't return any value.
  */
 static void jlink_clock_data(const uint8_t *out, unsigned out_offset,
                             const uint8_t *tms_out, unsigned tms_offset,
index 3ae5cac620ee72b4a9cbab23ca048f4395f20e09..20a036a78ec000095fc7174c8a30057a4b7702b4 100644 (file)
@@ -604,8 +604,6 @@ static int ulink_get_queue_size(struct ulink *device,
  * Clear the OpenULINK command queue.
  *
  * @param device pointer to struct ulink identifying ULINK driver instance.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
  */
 static void ulink_clear_queue(struct ulink *device)
 {
index def594ee3ff5fb86dd3ddbee33b84afeaacd719b..4ec2f1e311dc31f3ea114e3be921c976c2e7c680 100644 (file)
@@ -546,7 +546,8 @@ int jtag_srst_asserted(int *srst_asserted);
  * @param field Pointer to scan field.
  * @param value Pointer to scan value.
  * @param mask Pointer to scan mask; may be NULL.
- * @returns Nothing, but calls jtag_set_error() on any error.
+ *
+ * returns Nothing, but calls jtag_set_error() on any error.
  */
 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask);