docs,libmm-glib: provide per-version indices

1 files changed, 113 insertions, 46 deletions

diff --git a/libmm-glib/mm-modem-3gpp-ussd.c b/libmm-glib/mm-modem-3gpp-ussd.c
index f77a7f7a..4b975fd9 100644
--- a/libmm-glib/mm-modem-3gpp-ussd.c
+++ b/libmm-glib/mm-modem-3gpp-ussd.c
@@ -49,6 +49,8 @@ G_DEFINE_TYPE (MMModem3gppUssd, mm_modem_3gpp_ussd, MM_GDBUS_TYPE_MODEM3GPP_USSD
  * 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_3gpp_ussd_get_path (MMModem3gppUssd *self)
@@ -63,9 +65,13 @@ mm_modem_3gpp_ussd_get_path (MMModem3gppUssd *self)
  * mm_modem_3gpp_ussd_dup_path:
  * @self: A #MMModem3gppUssd.
  *
- * 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_3gpp_ussd_dup_path (MMModem3gppUssd *self)
@@ -90,10 +96,12 @@ mm_modem_3gpp_ussd_dup_path (MMModem3gppUssd *self)
  *
  * <warning>The returned value is only valid until the property changes so
  * it is only safe to use this function on the thread where
- * @self was constructed. Use mm_modem_3gpp_ussd_dup_network_request() if on another
- * thread.</warning>
+ * @self was constructed. Use mm_modem_3gpp_ussd_dup_network_request() if on
+ * another thread.</warning>
  *
  * Returns: (transfer none): The network request, or %NULL if none available.
+ *
+ * Since: 1.0
  */
 const gchar *
 mm_modem_3gpp_ussd_get_network_request (MMModem3gppUssd *self)
@@ -110,7 +118,10 @@ mm_modem_3gpp_ussd_get_network_request (MMModem3gppUssd *self)
  *
  * Gets a copy of any pending network-initiated request.
  *
- * Returns: (transfer full): The network request, or %NULL if none available. The returned value should be freed with g_free().
+ * Returns: (transfer full): The network request, or %NULL if none available.
+ * The returned value should be freed with g_free().
+ *
+ * Since: 1.0
  */
 gchar *
 mm_modem_3gpp_ussd_dup_network_request (MMModem3gppUssd *self)
@@ -127,14 +138,17 @@ mm_modem_3gpp_ussd_dup_network_request (MMModem3gppUssd *self)
  * mm_modem_3gpp_ussd_get_network_notification:
  * @self: A #MMModem3gppUssd.
  *
- * Gets any pending network-initiated request to which no USSD response is required.
+ * Gets any pending network-initiated request to which no USSD response is
+ * required.
  *
- * <warning>The returned value is only valid until the property changes so
- * it is only safe to use this function on the thread where
- * @self was constructed. Use mm_modem_3gpp_ussd_dup_network_notification() if on another
- * thread.</warning>
+ * <warning>The returned value is only valid until the property changes so it is
+ * only safe to use this function on the thread where @self was constructed. Use
+ * mm_modem_3gpp_ussd_dup_network_notification() if on another thread.</warning>
+ *
+ * Returns: (transfer none): The network notification, or %NULL if none
+ * available.
  *
- * Returns: (transfer none): The network notification, or %NULL if none available.
+ * Since: 1.0
  */
 const gchar *
 mm_modem_3gpp_ussd_get_network_notification (MMModem3gppUssd *self)
@@ -149,9 +163,13 @@ mm_modem_3gpp_ussd_get_network_notification (MMModem3gppUssd *self)
  * mm_modem_3gpp_ussd_dup_network_notification:
  * @self: A #MMModem3gppUssd.
  *
- * Gets a copy of any pending network-initiated request to which no USSD response is required.
+ * Gets a copy of any pending network-initiated request to which no USSD
+ * response is required.
  *
- * Returns: (transfer full): The network notification, or %NULL if none available. The returned value should be freed with g_free().
+ * Returns: (transfer full): The network notification, or %NULL if none
+ * available. The returned value should be freed with g_free().
+ *
+ * Since: 1.0
  */
 gchar *
 mm_modem_3gpp_ussd_dup_network_notification (MMModem3gppUssd *self)
@@ -171,6 +189,8 @@ mm_modem_3gpp_ussd_dup_network_notification (MMModem3gppUssd *self)
  * Get the state of the ongoing USSD session, if any.
  *
  * Returns: A #MMModem3gppUssdSessionState value, specifying the current state.
+ *
+ * Since: 1.0
  */
 MMModem3gppUssdSessionState
 mm_modem_3gpp_ussd_get_state (MMModem3gppUssd *self)
@@ -185,12 +205,16 @@ mm_modem_3gpp_ussd_get_state (MMModem3gppUssd *self)
 /**
  * mm_modem_3gpp_ussd_initiate_finish:
  * @self: A #MMModem3gppUssd.
- * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_ussd_initiate().
+ * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ *  mm_modem_3gpp_ussd_initiate().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with mm_modem_3gpp_ussd_initiate().
  *
- * Returns: The response from the network, if any. The returned value should be freed with g_free().
+ * Returns: The response from the network, if any. The returned value should be
+ * freed with g_free().
+ *
+ * Since: 1.0
  */
 gchar *
 mm_modem_3gpp_ussd_initiate_finish (MMModem3gppUssd *self,
@@ -211,19 +235,26 @@ mm_modem_3gpp_ussd_initiate_finish (MMModem3gppUssd *self,
  * @self: A #MMModem3gppUssd.
  * @command: The command to start the USSD session with.
  * @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 sends a USSD command string to the network initiating a USSD session.
+ * Asynchronously sends a USSD command string to the network initiating a USSD
+ * session.
  *
  * When the request is handled by the network, the method returns the
  * response or an appropriate error. The network may be awaiting further
  * response from the ME after returning from this method and no new command.
  *
- * 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_3gpp_ussd_initiate_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_3gpp_ussd_initiate_finish() to get the result of the operation.
+ *
+ * See mm_modem_3gpp_ussd_initiate_sync() for the synchronous, blocking version
+ * of this method.
  *
- * See mm_modem_3gpp_ussd_initiate_sync() for the synchronous, blocking version of this method.
+ * Since: 1.0
  */
 void
 mm_modem_3gpp_ussd_initiate (MMModem3gppUssd *self,
@@ -244,16 +275,20 @@ mm_modem_3gpp_ussd_initiate (MMModem3gppUssd *self,
  * @cancellable: (allow-none): A #GCancellable or %NULL.
  * @error: Return location for error or %NULL.
  *
- * Synchronously sends a USSD command string to the network initiating a USSD session.
+ * Synchronously sends a USSD command string to the network initiating a USSD
+ * session.
  *
  * When the request is handled by the network, the method returns the
  * response or an appropriate error. The network may be awaiting further
  * response from the ME after returning from this method and no new command.
  *
- * The calling thread is blocked until a reply is received. See mm_modem_3gpp_ussd_initiate()
- * for the asynchronous version of this method.
+ * The calling thread is blocked until a reply is received. See
+ * mm_modem_3gpp_ussd_initiate() for the asynchronous version of this method.
+ *
+ * Returns: The response from the network, if any. The returned value should be
+ * freed with g_free().
  *
- * Returns: The response from the network, if any. The returned value should be freed with g_free().
+ * Since: 1.0
  */
 gchar *
 mm_modem_3gpp_ussd_initiate_sync (MMModem3gppUssd *self,
@@ -275,12 +310,17 @@ mm_modem_3gpp_ussd_initiate_sync (MMModem3gppUssd *self,
 /**
  * mm_modem_3gpp_ussd_respond_finish:
  * @self: A #MMModem3gppUssd.
- * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_ussd_respond().
+ * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ *  mm_modem_3gpp_ussd_respond().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with mm_modem_3gpp_ussd_respond().
  *
- * Returns: The network reply to this response to the network-initiated USSD command. The reply may require further responses. The returned value should be freed with g_free().
+ * Returns: The network reply to this response to the network-initiated USSD
+ * command. The reply may require further responses. The returned value should
+ * be freed with g_free().
+ *
+ * Since: 1.0
  */
 gchar *
 mm_modem_3gpp_ussd_respond_finish (MMModem3gppUssd *self,
@@ -299,19 +339,26 @@ mm_modem_3gpp_ussd_respond_finish (MMModem3gppUssd *self,
 /**
  * mm_modem_3gpp_ussd_respond:
  * @self: A #MMModem3gppUssd.
- * @response: The response to network-initiated USSD command, or a response to a request for further input.
+ * @response: The response to network-initiated USSD command, or a response to a
+ *  request for further input.
  * @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 responds to a USSD request that is either initiated by the
  * mobile network, or that is awaiting further input after a previous call to
  * mm_modem_3gpp_ussd_initiate().
  *
- * 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_3gpp_ussd_respond_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_3gpp_ussd_respond_finish() to get the result of the operation.
+ *
+ * See mm_modem_3gpp_ussd_respond_sync() for the synchronous, blocking version
+ * of this method.
  *
- * See mm_modem_3gpp_ussd_respond_sync() for the synchronous, blocking version of this method.
+ * Since: 1.0
  */
 void
 mm_modem_3gpp_ussd_respond (MMModem3gppUssd *self,
@@ -328,7 +375,8 @@ mm_modem_3gpp_ussd_respond (MMModem3gppUssd *self,
 /**
  * mm_modem_3gpp_ussd_respond_sync:
  * @self: A #MMModem3gppUssd.
- * @response: The response to network-initiated USSD command, or a response to a request for further input.
+ * @response: The response to network-initiated USSD command, or a response to a
+ *  request for further input.
  * @cancellable: (allow-none): A #GCancellable or %NULL.
  * @error: Return location for error or %NULL.
  *
@@ -336,10 +384,14 @@ mm_modem_3gpp_ussd_respond (MMModem3gppUssd *self,
  * mobile network, or that is awaiting further input after a previous call to
  * mm_modem_3gpp_ussd_initiate().
  *
- * The calling thread is blocked until a reply is received. See mm_modem_3gpp_ussd_respond()
- * for the asynchronous version of this method.
+ * The calling thread is blocked until a reply is received. See
+ * mm_modem_3gpp_ussd_respond() for the asynchronous version of this method.
  *
- * Returns: The network reply to this response to the network-initiated USSD command. The reply may require further responses. The returned value should be freed with g_free().
+ * Returns: The network reply to this response to the network-initiated USSD
+ * command. The reply may require further responses. The returned value should
+ * be freed with g_free().
+ *
+ * Since: 1.0
  */
 gchar *
 mm_modem_3gpp_ussd_respond_sync (MMModem3gppUssd *self,
@@ -361,12 +413,16 @@ mm_modem_3gpp_ussd_respond_sync (MMModem3gppUssd *self,
 /**
  * mm_modem_3gpp_ussd_cancel_finish:
  * @self: A #MMModem3gppUssd.
- * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to mm_modem_3gpp_ussd_cancel().
+ * @res: The #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ *  mm_modem_3gpp_ussd_cancel().
  * @error: Return location for error or %NULL.
  *
  * Finishes an operation started with mm_modem_3gpp_ussd_cancel().
  *
- * Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is set.
+ * Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is
+ * set.
+ *
+ * Since: 1.0
  */
 gboolean
 mm_modem_3gpp_ussd_cancel_finish (MMModem3gppUssd *self,
@@ -382,15 +438,22 @@ mm_modem_3gpp_ussd_cancel_finish (MMModem3gppUssd *self,
  * mm_modem_3gpp_ussd_cancel:
  * @self: A #MMModem3gppUssd.
  * @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 cancels an ongoing USSD session, either mobile or network initiated.
+ * Asynchronously cancels an ongoing USSD session, either mobile or network
+ * initiated.
  *
- * 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_3gpp_ussd_cancel_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_3gpp_ussd_cancel_finish() to get the result of the operation.
  *
- * See mm_modem_3gpp_ussd_cancel_sync() for the synchronous, blocking version of this method.
+ * See mm_modem_3gpp_ussd_cancel_sync() for the synchronous, blocking version
+ * of this method.
+ *
+ * Since: 1.0
  */
 void
 mm_modem_3gpp_ussd_cancel (MMModem3gppUssd *self,
@@ -409,12 +472,16 @@ mm_modem_3gpp_ussd_cancel (MMModem3gppUssd *self,
  * @cancellable: (allow-none): A #GCancellable or %NULL.
  * @error: Return location for error or %NULL.
  *
- * Synchronously cancels an ongoing USSD session, either mobile or network initiated.
+ * Synchronously cancels an ongoing USSD session, either mobile or network
+ * initiated.
+ *
+ * The calling thread is blocked until a reply is received. See
+ * mm_modem_3gpp_ussd_cancel() for the asynchronous version of this method.
  *
- * The calling thread is blocked until a reply is received. See mm_modem_3gpp_ussd_cancel()
- * for the asynchronous version of this method.
+ * Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is
+ * set.
  *
- * Returns: %TRUE if the session was successfully cancelled, %FALSE if @error is set.
+ * Since: 1.0
  */
 gboolean
 mm_modem_3gpp_ussd_cancel_sync (MMModem3gppUssd *self,