device.c: Add missing @since markers.

[libsigrok.git] / device.c

diff --git a/device.c b/device.c
index a49faa8d595df9c05743adb9ec5fbce6b79898e2..327ddc73df50b723ee7a314970046dfb764b4eda 100644 (file)
--- a/device.c
+++ b/device.c
@@ -258,10 +258,11 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
        for (l = sdi->probes; l; l = l->next) {
                probe = l->data;
                g_free(probe->name);
+               g_free(probe->trigger);
                g_free(probe);
        }
+       g_slist_free(sdi->probes);
 
-       g_free(sdi->priv);
        g_free(sdi->vendor);
        g_free(sdi->model);
        g_free(sdi->version);
@@ -291,9 +292,7 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 /** @private */
 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 {
-       (void)usb;
-
-       /* Nothing to do for this device instance type. */
+       g_free(usb);
 }
 
 #endif
@@ -345,6 +344,16 @@ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
        g_free(serial);
 }
 
+/**
+ * Get the list of devices/instances of the specified driver.
+ *
+ * @param driver The driver to use. Must not be NULL.
+ *
+ * @return The list of devices/instances of this driver, or NULL upon errors
+ *         or if the list is empty.
+ *
+ * @since 0.1.0 (but the API changed in 0.2.0)
+ */
 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
 {
        if (driver && driver->dev_list)
@@ -353,6 +362,15 @@ SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
                return NULL;
 }
 
+/**
+ * Clear all devices/instances of the specified driver.
+ *
+ * @param driver The driver to use. Must not be NULL.
+ *
+ * @return SR_OK upon success, a negative error code upon errors.
+ *
+ * @since 0.2.0
+ */
 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
 {
        if (driver && driver->dev_clear)
@@ -361,6 +379,15 @@ SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
                return SR_OK;
 }
 
+/**
+ * Open the specified device.
+ *
+ * @param sdi Device instance to use. Must not be NULL.
+ *
+ * @return SR_OK upon success, a negative error code upon errors.
+ *
+ * @since 0.2.0
+ */
 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
 {
        int ret;
@@ -373,6 +400,15 @@ SR_API int sr_dev_open(struct sr_dev_inst *sdi)
        return ret;
 }
 
+/**
+ * Close the specified device.
+ *
+ * @param sdi Device instance to use. Must not be NULL.
+ *
+ * @return SR_OK upon success, a negative error code upon errors.
+ *
+ * @since 0.2.0
+ */
 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
 {
        int ret;