Fixes unknown meaning in GAppLaunchContext docs. Clarify asynchronous ops.

* gappinfo.c:
	  Fixes unknown meaning in GAppLaunchContext docs.
	* gfile.c:
	  Clarify asynchronous ops.
	* gfileattribute.c:
	  Fix entity tag docs.
	* gicon.c:
	* gthemedicon.c:
	  Provides missing gtk-doc section, fixes API docs slighly.
	* gsimpleasyncresult.c:
	  Fill in missing info in docs.
	* gunixinputstream.c:
	* gunixoutputstream.c:
	  Be more expressive in short description.
	* gunixvolume.c:
	  Remove gtk-doc stubs for non-public API.


svn path=/trunk/; revision=5994
This commit is contained in:
Andrew Walton
2007-11-29 10:18:55 +00:00
parent 09471fec46
commit 0c867d3444
10 changed files with 123 additions and 69 deletions

View File

@@ -61,6 +61,10 @@
* need better control of how asynchronous operations are completed, it is
* important to understand this functionality.
*
* GSimpleAsyncResults are tagged with the calling function to ensure that
* asynchronous functions and their finishing functions are used together
* correctly.
*
* To create a new #GSimpleAsyncResult, call g_simple_async_result_new(). If
* the result needs to be created for a #GError, use
* g_simple_async_result_new_from_error(). If a #GError is not available (e.g.
@@ -167,10 +171,10 @@ g_simple_async_result_init (GSimpleAsyncResult *simple)
/**
* g_simple_async_result_new:
* @source_object: a #GObject.
* @source_object: a #GObject the asynchronous function was called with.
* @callback: a #GAsyncReadyCallback.
* @user_data: user data passed to @callback.
* @source_tag:
* @source_tag: the asynchronous function.
*
* Creates a #GSimpleAsyncResult.
*
@@ -323,7 +327,7 @@ g_simple_async_result_get_source_tag (GSimpleAsyncResult *simple)
* @simple: a #GSimpleAsyncResult.
* @dest: a location to propegate the error to.
*
* Propegates an error from within the simple asynchronous result to
* Propagates an error from within the simple asynchronous result to
* a given destination.
*
* Returns: %TRUE if the error was propegated to @dest. %FALSE otherwise.
@@ -645,7 +649,7 @@ g_simple_async_result_run_in_thread (GSimpleAsyncResult *simple,
/**
* g_simple_async_report_error_in_idle:
* @object:
* @object: a #GObject.
* @callback: a #GAsyncReadyCallback.
* @user_data: user data passed to @callback.
* @domain: a #GQuark containing the error domain (usually #G_IO_ERROR).