BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doxygen consistency fixes (@foo instead of \foo).

This commit is contained in:
Uwe Hermann 2015-08-05 17:23:54 +02:00
parent 8d5228015d
commit dff0a89435
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/libsigrok/libsigrok.h
View File

@ -1023,13 +1023,13 @@ struct sr_dev_driver {
int (*cleanup) (const struct sr_dev_driver *driver); int (*cleanup) (const struct sr_dev_driver *driver);
/** Scan for devices. Driver should do all initialisation required. /** Scan for devices. Driver should do all initialisation required.
* Can be called several times, e.g. with different port options. * Can be called several times, e.g. with different port options.
* \retval NULL Error or no devices found. * @retval NULL Error or no devices found.
* \retval other GSList of a struct sr_dev_inst for each device. * @retval other GSList of a struct sr_dev_inst for each device.
* Must be freed by caller! * Must be freed by caller!
*/ */
GSList *(*scan) (struct sr_dev_driver *driver, GSList *options); GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
/** Get list of device instances the driver knows about. /** Get list of device instances the driver knows about.
* \returns NULL or GSList of a struct sr_dev_inst for each device. * @returns NULL or GSList of a struct sr_dev_inst for each device.
* Must not be freed by caller! * Must not be freed by caller!
*/ */
GSList *(*dev_list) (const struct sr_dev_driver *driver); GSList *(*dev_list) (const struct sr_dev_driver *driver);

6
src/hardware/motech-lps-30x/api.c
View File

@ -201,7 +201,7 @@ SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...)
} }
/** Send command and read reply string. /** Send command and read reply string.
* \param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated. * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
*/ */
SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...) SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...)
{ {
@ -314,8 +314,8 @@ static gint64 calc_timeout_ms(gint64 start_us)
} }
/** Read message into buf until "OK" received. /** Read message into buf until "OK" received.
* \retval SR_OK Msg received; buf and buflen contain result, if any except OK. * @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
* \retval SR_ERR Error, including timeout. * @retval SR_ERR Error, including timeout.
*/ */
SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen) SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
{ {

2
src/input/input.c
View File

@ -233,7 +233,7 @@ SR_API void sr_input_options_free(const struct sr_option **options)
* *
* @param imod The input module to use. Must not be NULL. * @param imod The input module to use. Must not be NULL.
* @param options GHashTable consisting of keys corresponding with * @param options GHashTable consisting of keys corresponding with
* the module options \c id field. The values should be GVariant * the module options @c id field. The values should be GVariant
* pointers with sunk references, of the same GVariantType as the option's * pointers with sunk references, of the same GVariantType as the option's
* default value. * default value.
* *