From: Alexandru Gagniuc <redacted>
Date: Sat, 15 Dec 2012 17:03:10 +0000 (-0600)
Subject: linsigrok.h: Document meaning of SR_UNIT_CONCENTRATION
X-Git-Tag: dsupstream~445
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=801c7800c6260a2e12aa2618263a717334946eb8;p=libsigrok.git

linsigrok.h: Document meaning of SR_UNIT_CONCENTRATION

Having concentration as a unit is vague, as it can be expressed in
many ways. In the context of sigrok, concentration means a normalized
number from 0 to 1.

Document its meaning.

Signed-off-by: Alexandru Gagniuc <redacted>
---

diff --git a/libsigrok.h b/libsigrok.h
index ee1e9e10..9946691e 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -210,6 +210,11 @@ enum {
 	SR_UNIT_UNITLESS,
 	/** Sound pressure level relative so 20 micropascals. */
 	SR_UNIT_DECIBEL_SPL,
+	/**
+	 * Normalized (0 to 1) concentration of a substance or compound with 0
+	 * representing a concentration of 0%, and 1 being 100%. This is
+	 * represented as the fraction of number of particles of the substance.
+	 */
 	SR_UNIT_CONCENTRATION,
 };