auracaster/openocd
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doxygen: use correct comment syntax

Browse Source 
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
This commit is contained in:
Spencer Oliver
2012-02-06 11:27:04 +00:00
parent 374127301e
commit 7719e2188e
9 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/helper/binarybuffer.c
View File

@@ -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)
{

2
src/helper/command.c
View File

@@ -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;

10
src/helper/command.h
View File

@@ -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")

10
src/helper/time_support.h
View File

@@ -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 */