X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=1b9c600077d1928bd569ff76d3d11ed464a032b0;hb=f0554946600a7db68f9ef33d25646f17562bf284;hp=30b8d1d4b2f668d4dce56de5550463487d0b00de;hpb=ac2926b37be8c569c5ca7f163a9219b08805fdd2;p=libsigrok.git diff --git a/std.c b/std.c index 30b8d1d4..1b9c6000 100644 --- a/std.c +++ b/std.c @@ -110,7 +110,7 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, #ifdef HAVE_LIBSERIALPORT -/* +/** * Standard serial driver dev_open() helper. * * This function can be used to implement the dev_open() driver API @@ -136,7 +136,7 @@ SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi) return SR_OK; } -/* +/** * Standard serial driver dev_close() helper. * * This function can be used to implement the dev_close() driver API @@ -160,7 +160,7 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) return SR_OK; } -/* +/** * Standard sr_session_stop() API helper. * * This function can be used to simplify most (serial port based) driver's @@ -173,7 +173,7 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) * Must not be NULL. * @param serial The serial device instance (struct serial_dev_inst *). * Must not be NULL. - * @param prefix A driver-specific prefix string used for log messages. + * @param[in] prefix A driver-specific prefix string used for log messages. * Must not be NULL. An empty string is allowed. * * @retval SR_OK Success. @@ -182,7 +182,7 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) * @retval SR_ERR Other errors. */ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, - void *cb_data, dev_close_t dev_close_fn, + void *cb_data, dev_close_callback dev_close_fn, struct sr_serial_dev_inst *serial, const char *prefix) { int ret; @@ -224,9 +224,11 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, #endif -/* +/** * Standard driver dev_clear() helper. * + * Clear driver, this means, close all instances. + * * This function can be used to implement the dev_clear() driver API * callback. dev_close() is called before every sr_dev_inst is cleared. * @@ -243,7 +245,7 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, * @return SR_OK on success. */ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, - std_dev_clear_t clear_private) + std_dev_clear_callback clear_private) { struct drv_context *drvc; struct sr_dev_inst *sdi; @@ -287,4 +289,3 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, return ret; } -