From: Aurelien Jacobs <redacted>
Date: Sun, 21 Aug 2016 16:32:38 +0000 (+0200)
Subject: document encoding.digits and spec.spec_digits
X-Git-Tag: libsigrok-0.5.0~248
X-Git-Url: https://sigrok.org/gitweb/?a=commitdiff_plain;h=96117c5660ec218220328d4244bb794be01d5196;hp=b66a0b5bddedfe6399256799bdc783f62dcc7a95;p=libsigrok.git

document encoding.digits and spec.spec_digits
---

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 7d9260ed..8151e53a 100644
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -508,6 +508,11 @@ struct sr_analog_encoding {
 	gboolean is_signed;
 	gboolean is_float;
 	gboolean is_bigendian;
+	/**
+	 * Number of significant digits after the decimal point if positive,
+	 * or number of non-significant digits before the decimal point if
+	 * negative (refers to the value we actually read on the wire).
+	 */
 	int8_t digits;
 	gboolean is_digits_decimal;
 	struct sr_rational scale;
@@ -522,6 +527,12 @@ struct sr_analog_meaning {
 };
 
 struct sr_analog_spec {
+	/**
+ 	 * Number of significant digits after the decimal point if positive,
+	 * or number of non-significant digits before the decimal point if
+	 * negative (refers to vendor specifications/datasheet or actual
+	 * device display).
+	 */
 	int8_t spec_digits;
 };