aboutsummaryrefslogtreecommitdiff
path: root/src/jtag
diff options
context:
space:
mode:
authorSpencer Oliver <spen@spen-soft.co.uk>2012-04-04 13:37:09 +0100
committerSpencer Oliver <spen@spen-soft.co.uk>2012-04-10 12:12:39 +0000
commita2935397b48ce2a1bbb8e49258b340479e0b9c8e (patch)
treed71917a68cb3803f0844596b05cd0a302b5c052e /src/jtag
parente2535e790164c51971094c0ad5418a191ec3b6a5 (diff)
doxygen: remove warnings
Change-Id: I020845a8df7b67f3b6c1a233b3ee07a5d14fa685 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/556 Tested-by: jenkins
Diffstat (limited to 'src/jtag')
-rw-r--r--src/jtag/drivers/OpenULINK/include/msgtypes.h3
-rw-r--r--src/jtag/drivers/OpenULINK/include/reg_ezusb.h3
-rw-r--r--src/jtag/drivers/OpenULINK/src/protocol.c7
-rw-r--r--src/jtag/drivers/OpenULINK/src/usb.c3
4 files changed, 9 insertions, 7 deletions
diff --git a/src/jtag/drivers/OpenULINK/include/msgtypes.h b/src/jtag/drivers/OpenULINK/include/msgtypes.h
index cb356128..18f5a77d 100644
--- a/src/jtag/drivers/OpenULINK/include/msgtypes.h
+++ b/src/jtag/drivers/OpenULINK/include/msgtypes.h
@@ -19,7 +19,8 @@
***************************************************************************/
/**
- * @file Definition of the commands supported by the OpenULINK firmware.
+ * @file
+ * Definition of the commands supported by the OpenULINK firmware.
*
* Basically, two types of commands can be distinguished:
* - Commands with fixed payload size
diff --git a/src/jtag/drivers/OpenULINK/include/reg_ezusb.h b/src/jtag/drivers/OpenULINK/include/reg_ezusb.h
index 3d5c279b..f0c30618 100644
--- a/src/jtag/drivers/OpenULINK/include/reg_ezusb.h
+++ b/src/jtag/drivers/OpenULINK/include/reg_ezusb.h
@@ -22,7 +22,8 @@
#define REG_EZUSB_H
/**
- * @file All information in this file was taken from the EZ-USB Technical
+ * @file
+ * All information in this file was taken from the EZ-USB Technical
* Reference Manual, Cypress Semiconductor, 3901 North First Street
* San Jose, CA 95134 (www.cypress.com).
*
diff --git a/src/jtag/drivers/OpenULINK/src/protocol.c b/src/jtag/drivers/OpenULINK/src/protocol.c
index 1034c04f..9688fbdd 100644
--- a/src/jtag/drivers/OpenULINK/src/protocol.c
+++ b/src/jtag/drivers/OpenULINK/src/protocol.c
@@ -28,7 +28,8 @@
#include "reg_ezusb.h"
/**
- * @file Implementation of the OpenULINK communication protocol.
+ * @file
+ * Implementation of the OpenULINK communication protocol.
*
* The OpenULINK protocol uses one OUT and one IN endpoint. These two endpoints
* are configured to use the maximum packet size for full-speed transfers,
@@ -75,11 +76,9 @@ void execute_set_led_command(void)
/**
* Executes one command and updates global command indexes.
*
- * @param index the index of the Bulk EP2-OUT data buffer at which the
- * command ID is stored.
* @return true if this command was the last command.
* @return false if there are more commands within the current contents of the
- * Bulk EP2-OUT data buffer.
+ * Bulk EP2-OUT data buffer.
*/
bool execute_command(void)
{
diff --git a/src/jtag/drivers/OpenULINK/src/usb.c b/src/jtag/drivers/OpenULINK/src/usb.c
index dd791f1b..a8299103 100644
--- a/src/jtag/drivers/OpenULINK/src/usb.c
+++ b/src/jtag/drivers/OpenULINK/src/usb.c
@@ -19,7 +19,8 @@
***************************************************************************/
/**
- * @file Defines USB descriptors, interrupt routines and helper functions.
+ * @file
+ * Defines USB descriptors, interrupt routines and helper functions.
* To minimize code size, we make the following assumptions:
* - The OpenULINK has exactly one configuration
* - and exactly one alternate setting