Added a link and remove some wrong (obsolete?) bits in the description
authorFrank Mori Hess <fmhess@speakeasy.net>
Mon, 11 Feb 2008 16:25:15 +0000 (16:25 +0000)
committerFrank Mori Hess <fmhess@speakeasy.net>
Mon, 11 Feb 2008 16:25:15 +0000 (16:25 +0000)
of comedi_cancel().

doc/command_funcref.txt

index d4500f11ce460573174986bae6941da724ec0c0a..d5755d5e59a83ec16e8bc3be1a3273921b26a3c5 100644 (file)
@@ -3,12 +3,13 @@ Retval: int
 Param: comedi_t * device
 Param: unsigned int subdevice
 Description:
- The function comedi_cancel() can be used to stop a Comedi command
- previously started by comedi_command() that is still in progress
- on the subdevice indicated by the parameters device and subdevice.
- This may not return the subdevice to a ready state, since there may
- be samples in the buffer that need to be read.
-
+ The function comedi_cancel() can be used to stop a command
+ previously started by
+ <link linkend="func-ref-comedi-command"><function>comedi_command</function></link>
+ which is still in progress
+ on the subdevice indicated by the parameters <parameter>device</parameter>
+ and <parameter>subdevice</parameter>.
+Returns:
  If successful, 0 is returned, otherwise -1.
 
 Function: comedi_command -- start streaming input/output