From 168fcd6ed6fc85490b6d0b098274917dd9d96f57 Mon Sep 17 00:00:00 2001 From: Ian Abbott Date: Fri, 11 May 2012 12:34:31 +0100 Subject: [PATCH] doc/funcref: Moved in comedi_set_global_oor_behavior 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 | 17 ----------------- doc/funcref | 17 +++++++++++++++++ 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/deprecated_funcref.txt b/doc/deprecated_funcref.txt index 7c515f0..9fac2f5 100644 --- a/doc/deprecated_funcref.txt +++ b/doc/deprecated_funcref.txt @@ -31,23 +31,6 @@ Description: and every device has the timer type nanosec_timer, 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 comedi_to_phys when - converting endpoint sample values, that is, sample values - equal to 0 or maxdata. If the out-of-range behavior is set to - COMEDI_OOR_NAN, endpoint values are converted to - NAN. If the - out-of-range behavior is set to COMEDI_OOR_NUMBER, 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 diff --git a/doc/funcref b/doc/funcref index 7620faf..b17d932 100644 --- a/doc/funcref +++ b/doc/funcref @@ -608,6 +608,23 @@ Description: information, this function returns 1. Otherwise, this function returns 0. On error, this function returns -1. +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 + comedi_to_phys when + converting endpoint sample values, that is, sample values + equal to 0 or maxdata. If the out-of-range behavior is set to + COMEDI_OOR_NAN, endpoint values are converted to + NAN. If the + out-of-range behavior is set to COMEDI_OOR_NUMBER, 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 -- 2.26.2