docs,libmm-glib: provide per-version indices

1 files changed, 80 insertions, 32 deletions

diff --git a/libmm-glib/mm-modem-simple.c b/libmm-glib/mm-modem-simple.c
index 56102fd2..c4e099b8 100644
--- a/libmm-glib/mm-modem-simple.c
+++ b/libmm-glib/mm-modem-simple.c
@@ -35,7 +35,8 @@
  * The #MMModemSimple is an object providing access to the methods, signals and
  * properties of the Simple interface.
  *
- * The Simple interface is exposed on modems which are not in %MM_MODEM_STATE_FAILED state.
+ * The Simple interface is exposed on modems which are not in
+ * %MM_MODEM_STATE_FAILED state.
  */
 
 G_DEFINE_TYPE (MMModemSimple, mm_modem_simple, MM_GDBUS_TYPE_MODEM_SIMPLE_PROXY)
@@ -49,6 +50,8 @@ G_DEFINE_TYPE (MMModemSimple, mm_modem_simple, MM_GDBUS_TYPE_MODEM_SIMPLE_PROXY)
  * Gets the DBus path of the #MMObject which implements this interface.
  *
  * Returns: (transfer none): The DBus path of the #MMObject object.
+ *
+ * Since: 1.0
  */
 const gchar *
 mm_modem_simple_get_path (MMModemSimple *self)
@@ -63,9 +66,13 @@ mm_modem_simple_get_path (MMModemSimple *self)
  * mm_modem_simple_dup_path:
  * @self: A #MMModemSimple.
  *
- * Gets a copy of the DBus path of the #MMObject object which implements this interface.
+ * Gets a copy of the DBus path of the #MMObject object which implements this
+ * interface.
+ *
+ * Returns: (transfer full): The DBus path of the #MMObject. The returned value
+ * should be freed with g_free().
  *
- * Returns: (transfer full): The DBus path of the #MMObject. The returned value should be freed with g_free().
+ * Since: 1.0
  */
 gchar *
 mm_modem_simple_dup_path (MMModemSimple *self)
@@ -85,12 +92,16 @@ mm_modem_simple_dup_path (MMModemSimple *self)
 /**
  * mm_modem_simple_connect_finish:
  * @self: A #MMModemSimple.
- * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_simple_connect().
+ * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ *  mm_modem_simple_connect().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with mm_modem_simple_connect().
  *
- * Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
+ * Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The
+ * returned value must be freed with g_object_ref().
+ *
+ * Since: 1.0
  */
 MMBearer *
 mm_modem_simple_connect_finish (MMModemSimple *self,
@@ -159,15 +170,21 @@ simple_connect_ready (MMModemSimple *self,
  * @self: A #MMModemSimple.
  * @properties: (transfer none): A #MMSimpleConnectProperties bundle.
  * @cancellable: (allow-none): A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
+ * @callback: A #GAsyncReadyCallback to call when the request is satisfied or
+ *  %NULL.
  * @user_data: User data to pass to @callback.
  *
  * Asynchronously requests to connect the modem using the given @properties.
  *
- * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
- * You can then call mm_modem_simple_connect_finish() to get the result of the operation.
+ * When the operation is finished, @callback will be invoked in the
+ * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
+ * of the thread you are calling this method from. You can then call
+ * mm_modem_simple_connect_finish() to get the result of the operation.
  *
- * See mm_modem_simple_connect_sync() for the synchronous, blocking version of this method.
+ * See mm_modem_simple_connect_sync() for the synchronous, blocking version of
+ * this method.
+ *
+ * Since: 1.0
  */
 void
 mm_modem_simple_connect (MMModemSimple *self,
@@ -203,10 +220,13 @@ mm_modem_simple_connect (MMModemSimple *self,
  *
  * Synchronously requests to connect the modem using the given @properties.
  *
- * The calling thread is blocked until a reply is received. See mm_modem_simple_connect()
- * for the asynchronous version of this method.
+ * The calling thread is blocked until a reply is received. See
+ * mm_modem_simple_connect() for the asynchronous version of this method.
+ *
+ * Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The
+ * returned value must be freed with g_object_ref().
  *
- * Returns: (transfer full): A #MMBearer, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
+ * Since: 1.0
  */
 MMBearer *
 mm_modem_simple_connect_sync (MMModemSimple *self,
@@ -249,12 +269,16 @@ mm_modem_simple_connect_sync (MMModemSimple *self,
 /**
  * mm_modem_simple_disconnect_finish:
  * @self: A #MMModemSimple.
- * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_simple_disconnect().
+ * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ *  mm_modem_simple_disconnect().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with mm_modem_simple_disconnect().
  *
- * Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is set.
+ * Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is
+ * set.
+ *
+ * Since: 1.0
  */
 gboolean
 mm_modem_simple_disconnect_finish (MMModemSimple *self,
@@ -269,17 +293,24 @@ mm_modem_simple_disconnect_finish (MMModemSimple *self,
 /**
  * mm_modem_simple_disconnect:
  * @self: A #MMModemSimple.
- * @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to disconnect all connected bearers.
+ * @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to
+ *  disconnect all connected bearers.
  * @cancellable: (allow-none): A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
+ * @callback: A #GAsyncReadyCallback to call when the request is satisfied or
+ *  %NULL.
  * @user_data: User data to pass to @callback.
  *
  * Asynchronously requests to disconnect the modem.
  *
- * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
- * You can then call mm_modem_simple_disconnect_finish() to get the result of the operation.
+ * When the operation is finished, @callback will be invoked in the
+ * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
+ * of the thread you are calling this method from. You can then call
+ * mm_modem_simple_disconnect_finish() to get the result of the operation.
  *
- * See mm_modem_simple_disconnect_sync() for the synchronous, blocking version of this method.
+ * See mm_modem_simple_disconnect_sync() for the synchronous, blocking version
+ * of this method.
+ *
+ * Since: 1.0
  */
 void
 mm_modem_simple_disconnect (MMModemSimple *self,
@@ -300,16 +331,20 @@ mm_modem_simple_disconnect (MMModemSimple *self,
 /**
  * mm_modem_simple_disconnect_sync:
  * @self: A #MMModemSimple.
- * @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to disconnect all connected bearers.
+ * @bearer: (allow-none): Path of the bearer to disconnect, or %NULL to
+ *  disconnect all connected bearers.
  * @cancellable: (allow-none): A #GCancellable or %NULL.
  * @error: Return location for error or %NULL.
  *
  * Synchronously requests to disconnect the modem.
  *
- * The calling thread is blocked until a reply is received. See mm_modem_simple_disconnect()
- * for the asynchronous version of this method.
+ * The calling thread is blocked until a reply is received. See
+ * mm_modem_simple_disconnect() for the asynchronous version of this method.
+ *
+ * Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is
+ * set.
  *
- * Returns: %TRUE if the modem is successfully disconnected, %FALSE if @error is set.
+ * Since: 1.0
  */
 gboolean
 mm_modem_simple_disconnect_sync (MMModemSimple *self,
@@ -330,12 +365,16 @@ mm_modem_simple_disconnect_sync (MMModemSimple *self,
 /**
  * mm_modem_simple_get_status_finish:
  * @self: A #MMModemSimple.
- * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_simple_connect().
+ * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ *  mm_modem_simple_connect().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with mm_modem_simple_get_status().
  *
- * Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
+ * Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The
+ * returned value must be freed with g_object_ref().
+ *
+ * Since: 1.0
  */
 MMSimpleStatus *
 mm_modem_simple_get_status_finish (MMModemSimple *self,
@@ -359,15 +398,21 @@ mm_modem_simple_get_status_finish (MMModemSimple *self,
  * mm_modem_simple_get_status:
  * @self: A #MMModemSimple.
  * @cancellable: (allow-none): A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL.
+ * @callback: A #GAsyncReadyCallback to call when the request is satisfied or
+ *  %NULL.
  * @user_data: User data to pass to @callback.
  *
  * Asynchronously requests a compilation of the status of the modem.
  *
- * When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from.
- * You can then call mm_modem_simple_get_status_finish() to get the result of the operation.
+ * When the operation is finished, @callback will be invoked in the
+ * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
+ * of the thread you are calling this method from. You can then call
+ * mm_modem_simple_get_status_finish() to get the result of the operation.
  *
- * See mm_modem_simple_get_status_sync() for the synchronous, blocking version of this method.
+ * See mm_modem_simple_get_status_sync() for the synchronous, blocking version
+ * of this method.
+ *
+ * Since: 1.0
  */
 void
 mm_modem_simple_get_status (MMModemSimple *self,
@@ -391,10 +436,13 @@ mm_modem_simple_get_status (MMModemSimple *self,
  *
  * Synchronously requests a compilation of the status of the modem.
  *
- * The calling thread is blocked until a reply is received. See mm_modem_simple_get_status()
- * for the asynchronous version of this method.
+ * The calling thread is blocked until a reply is received. See
+ * mm_modem_simple_get_status() for the asynchronous version of this method.
+ *
+ * Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The
+ * returned value must be freed with g_object_ref().
  *
- * Returns: (transfer full): A #MMSimpleStatus, or %FALSE if @error is set. The returned value must be freed with g_object_ref().
+ * Since: 1.0
  */
 MMSimpleStatus *
 mm_modem_simple_get_status_sync (MMModemSimple *self,