From: Gerd von Egidy <opensource@intra2net.com>
Date: Fri, 15 Feb 2008 18:18:29 +0000 (+0000)
Subject: libftdi: (gerd) improve async documentation (#1270)
X-Git-Tag: v0.11~4
X-Git-Url: http://developer.intra2net.com/git/?p=libftdi;a=commitdiff_plain;h=84f85aaa33a7d2ee7080acfbe56dabc0ca317411

libftdi: (gerd) improve async documentation (#1270)
---

diff --git a/src/ftdi.c b/src/ftdi.c
index 73f91a3..b284209 100644
--- a/src/ftdi.c
+++ b/src/ftdi.c
@@ -738,7 +738,7 @@ struct usb_dev_handle {
   // some other stuff coming here we don't need
 };
 
-/*
+/**
     Check for pending async urbs
     \internal
 */
@@ -757,8 +757,14 @@ static int _usb_get_async_urbs_pending(struct ftdi_context *ftdi)
     return pending;
 }
 
-/*
-    FIXME: Gerd, what does this function do exactly?
+/**
+    Wait until one or more async URBs are completed by the kernel and mark their
+    positions in the async-buffer as unused
+
+    \param ftdi pointer to ftdi_context
+    \param wait_for_more if != 0 wait for more than one write to complete
+    \param timeout_msec max milliseconds to wait
+
     \internal
 */
 static void _usb_async_cleanup(struct ftdi_context *ftdi, int wait_for_more, int timeout_msec)
@@ -806,7 +812,8 @@ static void _usb_async_cleanup(struct ftdi_context *ftdi, int wait_for_more, int
 }
 
 /**
-    Wait until at least one async write is complete
+    Wait until one or more async URBs are completed by the kernel and mark their
+    positions in the async-buffer as unused.
 
     \param ftdi pointer to ftdi_context
     \param wait_for_more if != 0 wait for more than one write to complete (until write timeout)