aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSpencer Oliver <spen@spen-soft.co.uk>2012-02-06 11:27:04 +0000
committerSpencer Oliver <spen@spen-soft.co.uk>2012-02-06 12:55:03 +0000
commit7719e2188e89a93813caf2ac8cfd7457cb605631 (patch)
tree7f5666dcabcb977c6fb107bebfacb7e2bf314280
parent374127301ec1d72033b9d573b72c7abdfd61990d (diff)
downloadriscv-openocd-7719e2188e89a93813caf2ac8cfd7457cb605631.zip
riscv-openocd-7719e2188e89a93813caf2ac8cfd7457cb605631.tar.gz
riscv-openocd-7719e2188e89a93813caf2ac8cfd7457cb605631.tar.bz2
doxygen: use correct comment syntax
This issue was caused by uncrustify not correctly converting the doxygen comments. Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Change-Id: Ie6dc3b057a08603b670cb27312e5f0d989426e6c Reviewed-on: http://openocd.zylin.com/431 Tested-by: jenkins
-rw-r--r--src/flash/mflash.c2
-rw-r--r--src/flash/nand/core.h2
-rw-r--r--src/flash/nand/driver.h2
-rw-r--r--src/flash/nor/lpc2900.c2
-rw-r--r--src/helper/binarybuffer.c2
-rw-r--r--src/helper/command.c2
-rw-r--r--src/helper/command.h10
-rw-r--r--src/helper/time_support.h10
-rw-r--r--src/jtag/core.c14
9 files changed, 23 insertions, 23 deletions
diff --git a/src/flash/mflash.c b/src/flash/mflash.c
index 3d927c4..bf61a11 100644
--- a/src/flash/mflash.c
+++ b/src/flash/mflash.c
@@ -1395,7 +1395,7 @@ COMMAND_HANDLER(mg_bank_cmd)
mflash_bank = calloc(sizeof(struct mflash_bank), 1);
COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], mflash_bank->base);
- /* / @todo Verify how this parsing should work, then document it. */
+ /** @todo Verify how this parsing should work, then document it. */
char *str;
mflash_bank->rst_pin.num = strtoul(CMD_ARGV[2], &str, 0);
if (*str)
diff --git a/src/flash/nand/core.h b/src/flash/nand/core.h
index 0451084..2f5a2f8 100644
--- a/src/flash/nand/core.h
+++ b/src/flash/nand/core.h
@@ -218,7 +218,7 @@ int nand_calculate_ecc_kw(struct nand_device *nand,
int nand_register_commands(struct command_context *cmd_ctx);
-/* / helper for parsing a nand device command argument string */
+/** helper for parsing a nand device command argument string */
COMMAND_HELPER(nand_command_get_device, unsigned name_index,
struct nand_device **nand);
diff --git a/src/flash/nand/driver.h b/src/flash/nand/driver.h
index caf3219..d49b943 100644
--- a/src/flash/nand/driver.h
+++ b/src/flash/nand/driver.h
@@ -90,7 +90,7 @@ struct nand_flash_controller {
*/
struct nand_flash_controller *nand_driver_find_by_name(const char *name);
-/* / Signature for callback functions passed to nand_driver_walk */
+/** Signature for callback functions passed to nand_driver_walk */
typedef int (*nand_driver_walker_t)(struct nand_flash_controller *c, void *);
/**
* Walk the list of drivers, encapsulating the data structure type.
diff --git a/src/flash/nor/lpc2900.c b/src/flash/nor/lpc2900.c
index f6a981d..5701670 100644
--- a/src/flash/nor/lpc2900.c
+++ b/src/flash/nor/lpc2900.c
@@ -896,7 +896,7 @@ static const struct command_registration lpc2900_command_handlers[] = {
COMMAND_REGISTRATION_DONE
};
-/* / Evaluate flash bank command. */
+/** Evaluate flash bank command. */
FLASH_BANK_COMMAND_HANDLER(lpc2900_flash_bank_command)
{
struct lpc2900_flash_bank *lpc2900_info;
diff --git a/src/helper/binarybuffer.c b/src/helper/binarybuffer.c
index 3f7a876..74af53a 100644
--- a/src/helper/binarybuffer.c
+++ b/src/helper/binarybuffer.c
@@ -238,7 +238,7 @@ char *buf_to_str(const void *_buf, unsigned buf_len, unsigned radix)
return str;
}
-/* / identify radix, and skip radix-prefix (0, 0x or 0X) */
+/** identify radix, and skip radix-prefix (0, 0x or 0X) */
static void str_radix_guess(const char **_str, unsigned *_str_len,
unsigned *_radix)
{
diff --git a/src/helper/command.c b/src/helper/command.c
index 6f7dcad..c218f3f 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -291,7 +291,7 @@ static struct command **command_list_for_parent(
static void command_free(struct command *c)
{
- /* / @todo if command has a handler, unregister its jim command! */
+ /** @todo if command has a handler, unregister its jim command! */
while (NULL != c->children) {
struct command *tmp = c->children;
diff --git a/src/helper/command.h b/src/helper/command.h
index 7c8c012..01316a1 100644
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -52,7 +52,7 @@ enum command_mode {
struct command_context;
-/* / The type signature for command context's output handler. */
+/** The type signature for command context's output handler. */
typedef int (*command_output_handler_t)(struct command_context *context,
const char *line);
@@ -217,7 +217,7 @@ struct command_registration {
void *jim_handler_data;
enum command_mode mode;
const char *help;
- /* / a string listing the options and arguments, required or optional */
+ /** a string listing the options and arguments, required or optional */
const char *usage;
/**
@@ -229,7 +229,7 @@ struct command_registration {
const struct command_registration *chain;
};
-/* / Use this as the last entry in an array of command_registration records. */
+/** Use this as the last entry in an array of command_registration records. */
#define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
/**
@@ -415,10 +415,10 @@ DECLARE_PARSE_WRAPPER(_s8, int8_t);
int command_parse_bool_arg(const char *in, bool *out);
COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
-/* / parses an on/off command argument */
+/** parses an on/off command argument */
#define COMMAND_PARSE_ON_OFF(in, out) \
COMMAND_PARSE_BOOL(in, out, "on", "off")
-/* / parses an enable/disable command argument */
+/** parses an enable/disable command argument */
#define COMMAND_PARSE_ENABLE(in, out) \
COMMAND_PARSE_BOOL(in, out, "enable", "disable")
diff --git a/src/helper/time_support.h b/src/helper/time_support.h
index 8689d70..4c46127 100644
--- a/src/helper/time_support.h
+++ b/src/helper/time_support.h
@@ -41,7 +41,7 @@
int timeval_subtract(struct timeval *result, struct timeval *x, struct timeval *y);
int timeval_add_time(struct timeval *result, long sec, long usec);
-/* / @returns gettimeofday() timeval as 64-bit in ms */
+/** @returns gettimeofday() timeval as 64-bit in ms */
int64_t timeval_ms(void);
struct duration {
@@ -49,14 +49,14 @@ struct duration {
struct timeval elapsed;
};
-/* / Update the duration->start field to start the @a duration measurement. */
+/** Update the duration->start field to start the @a duration measurement. */
int duration_start(struct duration *duration);
-/* / Update the duration->elapsed field to finish the @a duration measurment. */
+/** Update the duration->elapsed field to finish the @a duration measurment. */
int duration_measure(struct duration *duration);
-/* / @returns Elapsed time in seconds. */
+/** @returns Elapsed time in seconds. */
float duration_elapsed(struct duration *duration);
-/* / @returns KB/sec for the elapsed @a duration and @a count bytes. */
+/** @returns KB/sec for the elapsed @a duration and @a count bytes. */
float duration_kbps(struct duration *duration, size_t count);
#endif /* TIME_SUPPORT_H */
diff --git a/src/jtag/core.c b/src/jtag/core.c
index f87a66a..6de168e 100644
--- a/src/jtag/core.c
+++ b/src/jtag/core.c
@@ -113,11 +113,11 @@ static int jtag_ntrst_assert_width; /* width of assertion */
* when an event occurs.
*/
struct jtag_event_callback {
- /* / a event callback */
+ /** a event callback */
jtag_event_handler_t callback;
- /* / the private data to pass to the callback */
+ /** the private data to pass to the callback */
void *priv;
- /* / the next callback */
+ /** the next callback */
struct jtag_event_callback *next;
};
@@ -206,7 +206,7 @@ unsigned jtag_tap_count_enabled(void)
return n;
}
-/* / Append a new TAP to the chain of all taps. */
+/** Append a new TAP to the chain of all taps. */
void jtag_tap_add(struct jtag_tap *t)
{
t->abs_chain_position = jtag_num_taps++;
@@ -716,7 +716,7 @@ void jtag_add_reset(int req_tlr_or_trst, int req_srst)
void jtag_add_sleep(uint32_t us)
{
- /* / @todo Here, keep_alive() appears to be a layering violation!!! */
+ /** @todo Here, keep_alive() appears to be a layering violation!!! */
keep_alive();
jtag_set_error(interface_jtag_add_sleep(us));
}
@@ -1260,7 +1260,7 @@ void jtag_tap_init(struct jtag_tap *tap)
tap->expected_mask = calloc(1, ir_len_bytes);
tap->cur_instr = malloc(ir_len_bytes);
- /* / @todo cope better with ir_length bigger than 32 bits */
+ /** @todo cope better with ir_length bigger than 32 bits */
if (ir_len_bits > 32)
ir_len_bits = 32;
@@ -1286,7 +1286,7 @@ void jtag_tap_free(struct jtag_tap *tap)
{
jtag_unregister_event_callback(&jtag_reset_callback, tap);
- /* / @todo is anything missing? no memory leaks please */
+ /** @todo is anything missing? no memory leaks please */
free((void *)tap->expected);
free((void *)tap->expected_ids);
free((void *)tap->chip);