From: Bert Vermeulen <redacted>
Date: Thu, 18 Oct 2012 20:43:03 +0000 (+0200)
Subject: add SR_HWOPT_* documentation
X-Git-Tag: dsupstream~658
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=777bbd5b98873ec20c58613e4dbb48a1836174bd;p=libsigrok.git

add SR_HWOPT_* documentation
---

diff --git a/libsigrok.h b/libsigrok.h
index 251a2e4d..9ee524d9 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -321,13 +321,22 @@ struct sr_hwopt {
 enum {
 	SR_HWOPT_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 
-	/** Some drivers cannot detect the exact model they're talking to. */
+	/** Some drivers cannot detect the exact model they're talking to
+	 * (may be phased out). */
 	SR_HWOPT_MODEL,
 
-	/** Specification on how to connect to a device */
+	/** Specification on how to connect to a device. In combination
+	 * with SR_HWOPT_SERIALCOMM, this is a serial port in the form
+	 * which makes sense to the operating system (/dev/ttyS0).
+	 * Otherwise this specifies a USB device, either in the form of
+	 * <bus>.<address> (decimal, e.g. 1.65) or <vendorid>.<productid>
+	 * (hexadecimal, e.g. 1d6b.0001). */
 	SR_HWOPT_CONN,
 
-	/** Serial communication spec: <data bits><parity><stop bit> e.g. 8n1 */
+	/** Serial communication specification, in the form:
+	 *   <speed>/<data bits><parity><stop bit> e.g.9600/ 8n1
+	 * This is always an optional parameter, since a driver typically
+	 * knows the speed at which the device wants to communicate */
 	SR_HWOPT_SERIALCOMM,
 };