Doxygen consistency fixes (@foo instead of \foo).
This commit is contained in:
parent
8d5228015d
commit
dff0a89435
|
@ -1023,13 +1023,13 @@ struct sr_dev_driver {
|
|||
int (*cleanup) (const struct sr_dev_driver *driver);
|
||||
/** Scan for devices. Driver should do all initialisation required.
|
||||
* Can be called several times, e.g. with different port options.
|
||||
* \retval NULL Error or no devices found.
|
||||
* \retval other GSList of a struct sr_dev_inst for each device.
|
||||
* @retval NULL Error or no devices found.
|
||||
* @retval other GSList of a struct sr_dev_inst for each device.
|
||||
* Must be freed by caller!
|
||||
*/
|
||||
GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
|
||||
/** 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!
|
||||
*/
|
||||
GSList *(*dev_list) (const struct sr_dev_driver *driver);
|
||||
|
|
|
@ -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.
|
||||
* \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, ...)
|
||||
{
|
||||
|
@ -314,8 +314,8 @@ static gint64 calc_timeout_ms(gint64 start_us)
|
|||
}
|
||||
|
||||
/** Read message into buf until "OK" received.
|
||||
* \retval SR_OK Msg received; buf and buflen contain result, if any except OK.
|
||||
* \retval SR_ERR Error, including timeout.
|
||||
* @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
|
||||
* @retval SR_ERR Error, including timeout.
|
||||
*/
|
||||
SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
|
||||
{
|
||||
|
|
|
@ -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 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
|
||||
* default value.
|
||||
*
|
||||
|
|
Loading…
Reference in New Issue