doc/funcref: Moved in comedi_set_global_oor_behavior
authorIan Abbott <abbotti@mev.co.uk>
Fri, 11 May 2012 11:34:31 +0000 (12:34 +0100)
committerIan Abbott <abbotti@mev.co.uk>
Fri, 11 May 2012 11:34:31 +0000 (12:34 +0100)
Moved function comedi_set_global_oor_behavior out of the deprecated
section as it is associated with the comedi_to_phys function.

doc/deprecated_funcref.txt
doc/funcref

index 7c515f0eb224b852f7b5fbab210496cbeba5500c..9fac2f5c04a109b869c7ff12a4514aff1662b282 100644 (file)
@@ -31,23 +31,6 @@ Description:
  and every device has the timer type <constant>nanosec_timer</constant>, indicating
  that timer values are simply a time specified in nanoseconds.
 
-Function: comedi_set_global_oor_behavior -- out-of-range behavior
-Retval: int
-Param: enum comedi_oor_behavior behavior
-Status: deprecated
-Description:
- This function changes the Comedilib out-of-range behavior.
- This currently affects the behavior of <function>comedi_to_phys</function> when
- converting endpoint sample values, that is, sample values
- equal to <literal>0</literal> or <parameter
- class="function">maxdata</parameter>.  If the out-of-range behavior is set to
- <constant>COMEDI_OOR_NAN</constant>, endpoint values are converted to
- <constant>NAN</constant>.  If the
- out-of-range behavior is set to <constant>COMEDI_OOR_NUMBER</constant>, the endpoint
- values are converted similarly to other values.
-
- The previous out-of-range behavior is returned.
-
 Function: comedi_sv_init -- slowly-varying inputs
 Retval: int
 Param: comedi_sv_t * sv
index 7620faf841146918bea8d33e3304e3d6eb1fdfde..b17d9328da73c3bf84a666b284b6ca095259057d 100644 (file)
@@ -608,6 +608,23 @@ Description:
  information, this function returns <literal>1</literal>.  Otherwise, this function
  returns <literal>0</literal>.  On error, this function returns <literal>-1</literal>.
 
+Function: comedi_set_global_oor_behavior -- out-of-range behavior
+Retval: enum comedi_oor_behavior
+Param: enum comedi_oor_behavior behavior
+Description:
+ This function changes the Comedilib out-of-range behavior.
+ This currently affects the behavior of
+ <function>comedi_to_phys</function> when
+ converting endpoint sample values, that is, sample values
+ equal to <literal>0</literal> or <parameter
+ class="function">maxdata</parameter>.  If the out-of-range behavior is set to
+ <constant>COMEDI_OOR_NAN</constant>, endpoint values are converted to
+ <constant>NAN</constant>.  If the
+ out-of-range behavior is set to <constant>COMEDI_OOR_NUMBER</constant>, the endpoint
+ values are converted similarly to other values.
+Returns:
+ The previous out-of-range behavior is returned.
+
 Function: comedi_to_phys -- convert sample to physical units
 Retval: double
 Param: lsampl_t data