Autodoc updated.
authormazze <mazze@fb15a70f-31f2-0310-bbcc-cdcc74a49acc>
Wed, 21 Nov 2012 20:33:49 +0000 (21 20:33 +0000)
committermazze <mazze@fb15a70f-31f2-0310-bbcc-cdcc74a49acc>
Wed, 21 Nov 2012 20:33:49 +0000 (21 20:33 +0000)
git-svn-id: https://svn.aros.org/svn/aros/trunk/AROS@46061 fb15a70f-31f2-0310-bbcc-cdcc74a49acc

rom/dos/abortpkt.c

index f7ea037..3dec6f8 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright © 1995-2011, The AROS Development Team. All rights reserved.
+    Copyright © 1995-2012, The AROS Development Team. All rights reserved.
     $Id$
 
     Desc:
         struct DosLibrary *, DOSBase, 44, Dos)
 
 /*  FUNCTION
+        This function does currently nothing. You can use WaitForChar()
+        to poll for characters from an interactive handler.
+
+        The planned purpose of this function is:
         Tries to abort an asynchronous packet. There is no guarantee
-        that this succeeds. You must wait for the packet to return
-        before you can reuse or deallocate it.
+        that this succeeds. You must wait with WaitPkt() for the packet
+        to return before you can reuse or deallocate it.
 
     INPUTS
-        port - the message port to where the packet was sent
-        pkt  - the packet to be aborted
+        port -- the message port to where the packet was sent
+        pkt  -- the packet to be aborted
 
     RESULT
 
@@ -43,6 +47,7 @@
     BUGS
 
     SEE ALSO
+        SendPkt(), WaitForChar(), WaitPkt()
 
     INTERNALS