HACKING: "Adding a new hardware driver" chapter.

[libsigrok.git] / device.c

diff --git a/device.c b/device.c
index d5ad7b2b4b7b9763468edc853d509c8223cae521..740ad5077cebcf350e99757e575dc0901c030a13 100644 (file)
--- a/device.c
+++ b/device.c
@@ -19,9 +19,24 @@
 
 #include <stdio.h>
 #include <glib.h>
+#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Device handling in libsigrok.
+ */
+
+/**
+ * @defgroup grp_devices Devices
+ *
+ * Device handling in libsigrok.
+ *
+ * @{
+ */
+
 /** @private */
 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
                gboolean enabled, const char *name)
@@ -152,9 +167,10 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
 }
 
 /**
- * Determine whether the specified device has the specified capability.
+ * Determine whether the specified device instance has the specified
+ * capability.
  *
- * @param dev Pointer to the device instance to be checked. Must not be NULL.
+ * @param sdi Pointer to the device instance to be checked. Must not be NULL.
  *            If the device's 'driver' field is NULL (virtual device), this
  *            function will always return FALSE (virtual devices don't have
  *            a hardware capabilities list).
@@ -316,3 +332,4 @@ SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver)
                return SR_OK;
 }
 
+/** @} */