From: Ian Abbott <abbotti@mev.co.uk>
Date: Fri, 20 Apr 2012 12:28:15 +0000 (+0100)
Subject: doc/reference.xml: Added section for comedi_polynomial_t.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=a61c28c6966d31cf40e50b4de1a4f257df61dcc0;p=comedilib.git

doc/reference.xml: Added section for comedi_polynomial_t.

The tutorial.xml contained links to a missing section for the
comedi_polynomial_t type, so I added one.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
---

diff --git a/doc/reference.xml b/doc/reference.xml
index d12aaeb..465ea2e 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -696,6 +696,33 @@ a list of instructions.
 
 </section>
 
+<section id="ref-type-comedi-polynomial-t">
+<title>
+comedi_polynomial_t
+</title>
+
+<programlisting>
+#define COMEDI_MAX_NUM_POLYNOMIAL_COEFFICIENTS 4
+typedef struct {
+  double coefficients[COMEDI_MAX_NUM_POLYNOMIAL_COEFFICIENTS];
+  double expansion_origin;
+  unsigned order;
+} comedi_polynomial_t;
+</programlisting>
+
+<para>
+A comedi_polynomial_t holds calibration data for a channel of a
+subdevice.  It is initialized by the
+<link linkend="func-ref-comedi-get-hardcal-converter"><function>comedi_get_hardcal_converter</function></link>
+or <link linkend="func-ref-comedi-get-softcal-converter"><function>comedi_get_softcal_converter</function></link>
+calibration functions and is passed to the
+<link linkend="func-ref-comedi-to-physical"><function>comedi_to_physical</function></link>
+and <link linkend="func-ref-comedi-from-physical"><function>comedi_from_physical</function></link>
+raw/physical conversion functions.
+</para>
+
+</section>
+
 </section>
 
 	<section id="functionreference">