[kdbus] Add new library API for common tasks on dbus/kdbus

[platform/upstream/glib.git] / gio / gasyncresult.c

diff --git a/gio/gasyncresult.c b/gio/gasyncresult.c
index 8cba495..0c18b0b 100644 (file)
--- a/gio/gasyncresult.c
+++ b/gio/gasyncresult.c
@@ -13,9 +13,7 @@
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  *
  * Author: Alexander Larsson <alexl@redhat.com>
  */
@@ -30,7 +28,7 @@
  * SECTION:gasyncresult
  * @short_description: Asynchronous Function Results
  * @include: gio/gio.h
- * @see_also: #GSimpleAsyncResult
+ * @see_also: #GTask
  *
  * Provides a base class for implementing asynchronous function results.
  *
@@ -59,10 +57,10 @@
  * however, the "_finish()" function may be called at most once.
  *
  * Example of a typical asynchronous operation flow:
- * |[
+ * |[<!-- language="C" -->
  * void _theoretical_frobnitz_async (Theoretical         *t,
  *                                   GCancellable        *c,
- *                                   GAsyncReadyCallback *cb,
+ *                                   GAsyncReadyCallback  cb,
  *                                   gpointer             u);
  *
  * gboolean _theoretical_frobnitz_finish (Theoretical   *t,
@@ -83,27 +81,37 @@
  *   else
  *     g_printf ("Uh oh!\n");
  *
- *   /<!-- -->* ... *<!-- -->/
+ *   ...
  *
  * }
  *
  * int main (int argc, void *argv[])
  * {
- *    /<!-- -->* ... *<!-- -->/
+ *    ...
  *
  *    _theoretical_frobnitz_async (theoretical_data,
  *                                 NULL,
  *                                 frobnitz_result_func,
  *                                 NULL);
  *
- *    /<!-- -->* ... *<!-- -->/
+ *    ...
  * }
  * ]|
  *
  * The callback for an asynchronous operation is called only once, and is
  * always called, even in the case of a cancelled operation. On cancellation
  * the result is a %G_IO_ERROR_CANCELLED error.
- **/
+ *
+ * ## I/O Priority # {#io-priority}
+ *
+ * Many I/O-related asynchronous operations have a priority parameter,
+ * which is used in certain cases to determine the order in which
+ * operations are executed. They are not used to determine system-wide
+ * I/O scheduling. Priorities are integers, with lower numbers indicating
+ * higher priority. It is recommended to choose priorities between
+ * %G_PRIORITY_LOW and %G_PRIORITY_HIGH, with %G_PRIORITY_DEFAULT
+ * as a default.
+ */
 
 typedef GAsyncResultIface GAsyncResultInterface;
 G_DEFINE_INTERFACE (GAsyncResult, g_async_result, G_TYPE_OBJECT)
@@ -156,20 +164,19 @@ g_async_result_get_source_object (GAsyncResult *res)
 
 /**
  * g_async_result_legacy_propagate_error:
- * @result: a #GAsyncResult
- * @dest: (out): a location to propagate the error to.
+ * @res: a #GAsyncResult
+ * @error: (out): a location to propagate the error to.
  *
- * If @result is a #GSimpleAsyncResult, this is equivalent to
+ * If @res is a #GSimpleAsyncResult, this is equivalent to
  * g_simple_async_result_propagate_error(). Otherwise it returns
  * %FALSE.
  *
- * This can be used for legacy error handling in async
- * <literal>_finish ()</literal> wrapper functions that traditionally
- * handled #GSimpleAsyncResult error returns themselves rather than
- * calling into the virtual method. This should not be used in new
- * code; #GAsyncResult errors that are set by virtual methods should
- * also be extracted by virtual methods, to enable subclasses to chain
- * up correctly.
+ * This can be used for legacy error handling in async *_finish()
+ * wrapper functions that traditionally handled #GSimpleAsyncResult
+ * error returns themselves rather than calling into the virtual method.
+ * This should not be used in new code; #GAsyncResult errors that are
+ * set by virtual methods should also be extracted by virtual methods,
+ * to enable subclasses to chain up correctly.
  *
  * Returns: %TRUE if @error is has been filled in with an error from
  *   @res, %FALSE if not.
@@ -197,13 +204,13 @@ g_async_result_legacy_propagate_error (GAsyncResult  *res,
 
 /**
  * g_async_result_is_tagged:
- * @result: a #GAsyncResult
+ * @res: a #GAsyncResult
  * @source_tag: an application-defined tag
  *
- * Checks if @result has the given @source_tag (generally a function
- * pointer indicating the function @result was created by).
+ * Checks if @res has the given @source_tag (generally a function
+ * pointer indicating the function @res was created by).
  *
- * Returns: %TRUE if @result has the indicated @source_tag, %FALSE if
+ * Returns: %TRUE if @res has the indicated @source_tag, %FALSE if
  *   not.
  *
  * Since: 2.34