Document API change for GPGME_EVENT_DONE from 2009.
authorWerner Koch <wk@gnupg.org>
Mon, 19 Aug 2013 18:43:19 +0000 (20:43 +0200)
committerWerner Koch <wk@gnupg.org>
Mon, 19 Aug 2013 18:43:19 +0000 (20:43 +0200)
* doc/gpgme.texi (I/O Callback Interface): Fix description for the
event arg.
--

With commit c8e934b2 (2009-10-26) gpgme_io_event_done_data_t was
introduced to replace the use of gpg_error_t with GPGME_EVENT_DONE.
Unfortunately this was not documented.  Maybe at that time the event
code was considered internal and its use in GPA was not known.  Too
bad.

doc/gpgme.texi

index 4ec0bfe..18b3c94 100644 (file)
@@ -5335,9 +5335,9 @@ callback handlers must not be run before this event is signalled.
 @item GPGME_EVENT_DONE
 The operation is finished, the last I/O callback for this operation
 was removed.  The accompanying @var{type_data} points to a
-@code{gpgme_error_t} variable that contains the status of the operation
-that finished.  This event is signalled after the last I/O callback
-has been removed.
+@code{struct gpgme_io_event_done_data} variable that contains the
+status of the operation that finished.  This event is signalled after
+the last I/O callback has been removed.
 
 @item GPGME_EVENT_NEXT_KEY
 In a @code{gpgme_op_keylist_start} operation, the next key was