From: Frank Mori Hess <fmhess@speakeasy.net>
Date: Mon, 11 Feb 2008 16:25:15 +0000 (+0000)
Subject: Added a link and remove some wrong (obsolete?) bits in the description
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=a7ece13dbdcb5bab15ebe4084e33bf7b7fef19d3;p=comedilib.git

Added a link and remove some wrong (obsolete?) bits in the description
of comedi_cancel().
---

diff --git a/doc/command_funcref.txt b/doc/command_funcref.txt
index d4500f1..d5755d5 100644
--- a/doc/command_funcref.txt
+++ b/doc/command_funcref.txt
@@ -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