[libgda] Doc. improvements



commit 7dc7a03af870dd1165314875ae12cc4455dcd1da
Author: Vivien Malerba <malerba gnome-db org>
Date:   Mon Mar 11 22:01:01 2013 +0100

    Doc. improvements

 doc/C/prov-writing-virtual-methods.xml     |    6 ++++++
 libgda/thread-wrapper/gda-thread-wrapper.c |    2 ++
 libgda/thread-wrapper/gda-thread-wrapper.h |    2 +-
 3 files changed, 9 insertions(+), 1 deletions(-)
---
diff --git a/doc/C/prov-writing-virtual-methods.xml b/doc/C/prov-writing-virtual-methods.xml
index 9329dc0..6901635 100644
--- a/doc/C/prov-writing-virtual-methods.xml
+++ b/doc/C/prov-writing-virtual-methods.xml
@@ -291,11 +291,17 @@
     <sect2>
       <title>handle_async()</title>
       <para>
+        This method is called by <link 
linkend="gda-connection-async-fetch-result">gda_connection_async_fetch_result().</link>
+      </para>
+      <para>
        This method, if implemented, is called to give the database provider a chance to execute some code in 
case an
        asynchronous statement's execution has been requested. Often providers will send some data over the 
network to the
        database server when the statement_execute() is called, and implement this virtual function as a way 
to get
        some data from the database server to see if the execution is terminated.
       </para>
+      <para>
+        This function must return FALSE in case an error occurs, and TRUE if no error occurred (even if 
nothing was to be done).
+      </para>
     </sect2>
   </sect1>
 
diff --git a/libgda/thread-wrapper/gda-thread-wrapper.c b/libgda/thread-wrapper/gda-thread-wrapper.c
index 5f0f30c..d66026b 100644
--- a/libgda/thread-wrapper/gda-thread-wrapper.c
+++ b/libgda/thread-wrapper/gda-thread-wrapper.c
@@ -963,6 +963,8 @@ gda_thread_wrapper_unset_io_channel (GdaThreadWrapper *wrapper)
  * Once @func's execution is finished, if @arg is not %NULL, the @arg_destroy_func destruction function is 
called
  * on @arg. This call occurs in the thread calling gda_thread_wrapper_fetch_result().
  *
+ * If an error occurred in this function, then the @arg_destroy_func function is not called to free @arg.
+ *
  * Returns: the job ID, or 0 if an error occurred
  *
  * Since: 4.2
diff --git a/libgda/thread-wrapper/gda-thread-wrapper.h b/libgda/thread-wrapper/gda-thread-wrapper.h
index 52555ea..3dbfc11 100644
--- a/libgda/thread-wrapper/gda-thread-wrapper.h
+++ b/libgda/thread-wrapper/gda-thread-wrapper.h
@@ -186,7 +186,7 @@ typedef void (*GdaThreadWrapperCallback) (GdaThreadWrapper *wrapper, gpointer in
  * simply dispatch all the execution requests to its private <emphasis>worker</emphasis> thread and report 
the
  * execution's status only to the thread which made the request.
  *
- * The user can also specify a callback function to be called when an object exmits a signal while being
+ * The user can also specify a callback function to be called when an object emits a signal while being
  * used by the worker thread, see the gda_thread_wrapper_connect_raw() method.
  *
  * The following diagram illustrates the conceptual working of the #GdaThreadWrapper object: here two user 
threads


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]