From: Matthias Heidbrink <redacted>
Date: Wed, 18 Dec 2013 22:33:45 +0000 (+0100)
Subject: serial-dmm: Commented struct dmm_info.
X-Git-Tag: libsigrok-0.3.0~426
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=5d03743096a1e850c6ccbb1eb902705a62604e80;p=libsigrok.git

serial-dmm: Commented struct dmm_info.
---

diff --git a/hardware/serial-dmm/protocol.h b/hardware/serial-dmm/protocol.h
index 4ad36754..20c5ae71 100644
--- a/hardware/serial-dmm/protocol.h
+++ b/hardware/serial-dmm/protocol.h
@@ -60,17 +60,28 @@ enum {
 #define DMM_COUNT 24
 
 struct dmm_info {
+	/** Manufacturer/brand */
 	char *vendor;
+	/** Model */
 	char *device;
+	/** serialconn string */
 	char *conn;
+	/** Baud rate */
 	uint32_t baudrate;
+	/** Packet size [bytes]. */
 	int packet_size;
+	/** Packet request function. */
 	int (*packet_request)(struct sr_serial_dev_inst *);
+	/** Packet validation function. */
 	gboolean (*packet_valid)(const uint8_t *);
+	/** Packet parsing function. */
 	int (*packet_parse)(const uint8_t *, float *,
 			    struct sr_datafeed_analog *, void *);
+	/** */
 	void (*dmm_details)(struct sr_datafeed_analog *, void *);
+	/** libsigrok driver info struct. */
 	struct sr_dev_driver *di;
+	/** Data reception function. */
 	int (*receive_data)(int, int, void *);
 };