diff options
author | Spencer Oliver <spen@spen-soft.co.uk> | 2012-02-06 11:27:04 +0000 |
---|---|---|
committer | Spencer Oliver <spen@spen-soft.co.uk> | 2012-02-06 12:55:03 +0000 |
commit | 7719e2188e89a93813caf2ac8cfd7457cb605631 (patch) | |
tree | 7f5666dcabcb977c6fb107bebfacb7e2bf314280 /src/helper | |
parent | 374127301ec1d72033b9d573b72c7abdfd61990d (diff) |
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
Diffstat (limited to 'src/helper')
-rw-r--r-- | src/helper/binarybuffer.c | 2 | ||||
-rw-r--r-- | src/helper/command.c | 2 | ||||
-rw-r--r-- | src/helper/command.h | 10 | ||||
-rw-r--r-- | src/helper/time_support.h | 10 |
4 files changed, 12 insertions, 12 deletions
diff --git a/src/helper/binarybuffer.c b/src/helper/binarybuffer.c index 3f7a876b..74af53a9 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 6f7dcadc..c218f3fc 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 7c8c0121..01316a1a 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 8689d706..4c46127d 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 */ |