[Galago-commits] r2841 - in trunk/libgalago: . libgalago

[galago-commits at freedesktop.org]

Author: chipx86
Date: 2006-06-12 01:52:29 -0700 (Mon, 12 Jun 2006)
New Revision: 2841

Modified:
   trunk/libgalago/ChangeLog
   trunk/libgalago/libgalago/galago-core.c
   trunk/libgalago/libgalago/galago-service.c
Log:
Documentation fixes.


Modified: trunk/libgalago/ChangeLog
===================================================================
--- trunk/libgalago/ChangeLog	2006-06-12 08:49:02 UTC (rev 2840)
+++ trunk/libgalago/ChangeLog	2006-06-12 08:52:29 UTC (rev 2841)
@@ -1,3 +1,9 @@
+Mon Jun 12 01:51:43 PDT 2006  Christian Hammond <chipx86 at chipx86.com>
+
+	* libgalago/galago-core.c:
+	* libgalago/galago-service.c:
+	  - Documentation fixes.
+
 Mon Jun 12 01:48:44 PDT 2006  Christian Hammond <chipx86 at chipx86.com>
 
 	* libgalago/galago-core.c:

Modified: trunk/libgalago/libgalago/galago-core.c
===================================================================
--- trunk/libgalago/libgalago/galago-core.c	2006-06-12 08:49:02 UTC (rev 2840)
+++ trunk/libgalago/libgalago/galago-core.c	2006-06-12 08:52:29 UTC (rev 2841)
@@ -1243,6 +1243,41 @@
 	return service;
 }
 
+/**
+ * galago_get_service_async:
+ * @id:        The service ID.
+ * @cb:        The callback function that will be passed the service.
+ * @user_data: Custom data to pass to the callback function.
+ * @free_func: Optional function to free @user_data when the request completes.
+ *
+ * Asynchronously retrieves the service with the specified ID.
+ *
+ * For example:
+ * <informalexample>
+ * <programlisting>
+ *  static void
+ *  service_received_cb(GalagoCore *core,
+ *                      GalagoService *service,
+ *                      gpointer user_data)
+ *  {
+ *  }
+ *  
+ *  static void
+ *  get_jabber_service(void)
+ *  {
+ *      GalagoCallHandle handle;
+ *  
+ *      handle = galago_get_service_async("jabber", service_received_cb,
+ *                                        NULL, NULL);
+ *  }
+ * </programlisting>
+ * </informalexample>
+ *
+ * Returns: A valid #GalagoCallHandle on success. On error, this will return
+ *          %GALAGO_CALL_HANDLE_INVALID.
+ *
+ * Since: 0.5.2
+ */
 GalagoCallHandle
 galago_get_service_async(const char *id,
 						 GalagoCoreServiceCb cb,

Modified: trunk/libgalago/libgalago/galago-service.c
===================================================================
--- trunk/libgalago/libgalago/galago-service.c	2006-06-12 08:49:02 UTC (rev 2840)
+++ trunk/libgalago/libgalago/galago-service.c	2006-06-12 08:52:29 UTC (rev 2841)
@@ -681,8 +681,9 @@
  *  {
  *      GalagoCallHandle handle;
  *  
- *      handle = galago_service_get_account(service, "Bob",
- *                                          account_received_cb, NULL, NULL);
+ *      handle = galago_service_get_account_async(service, "Bob",
+ *                                                account_received_cb,
+ *                                                NULL, NULL);
  *  }
  * </programlisting>
  * </informalexample>