]> sigrok.org Git - libsigrok.git/commitdiff
linsigrok.h: Document meaning of SR_UNIT_CONCENTRATION
authorAlexandru Gagniuc <redacted>
Sat, 15 Dec 2012 17:03:10 +0000 (11:03 -0600)
committerBert Vermeulen <redacted>
Sun, 16 Dec 2012 17:50:23 +0000 (18:50 +0100)
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>
libsigrok.h

index ee1e9e1037fe377bf01022f944b2c1f0045a0bf7..9946691e267503cd6fab4abfbf681da39d83b334 100644 (file)
@@ -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,
 };