[jsonrpc-glib/bilelmoussaoui/gi-docgen: 2/2] docs: Make the formatting a bit consistent




commit 77226ca07f7befa9763904490ba7b938e71a8601
Author: Bilal Elmoussaoui <belmouss redhat com>
Date:   Sat Feb 5 17:23:42 2022 +0100

    docs: Make the formatting a bit consistent

 src/jsonrpc-client.c | 70 ++++++++++++++++++++++++++--------------------------
 src/jsonrpc-server.c | 30 +++++++++++-----------
 2 files changed, 50 insertions(+), 50 deletions(-)
---
diff --git a/src/jsonrpc-client.c b/src/jsonrpc-client.c
index 61eb9c9..8373c37 100644
--- a/src/jsonrpc-client.c
+++ b/src/jsonrpc-client.c
@@ -511,7 +511,7 @@ jsonrpc_client_class_init (JsonrpcClientClass *klass)
   /**
    * JsonrpcClient::handle-call:
    * @self: A #JsonrpcClient
-   * @method: the method name
+   * @method: The method name
    * @id: The "id" field of the JSONRPC message
    * @params: (nullable): The "params" field of the JSONRPC message
    *
@@ -548,8 +548,8 @@ jsonrpc_client_class_init (JsonrpcClientClass *klass)
   /**
    * JsonrpcClient::notification:
    * @self: A #JsonrpcClient
-   * @method: the method name of the notification
-   * @params: (nullable): params for the notification
+   * @method: The method name of the notification
+   * @params: (nullable): Params for the notification
    *
    * This signal is emitted when a notification has been received from a
    * peer. Unlike [signal@Client::handle-call], this does not have an "id"
@@ -881,7 +881,7 @@ jsonrpc_client_call_sync_cb (GObject      *object,
 /**
  * jsonrpc_client_call:
  * @self: A #JsonrpcClient
- * @method: the name of the method to call
+ * @method: The name of the method to call
  * @params: (transfer none) (nullable): A [struct@GLib.Variant] of parameters or %NULL
  * @cancellable: (nullable): A #GCancellable or %NULL
  * @return_value: (nullable) (out): A location for a [struct@GLib.Variant]
@@ -942,13 +942,13 @@ jsonrpc_client_call (JsonrpcClient  *self,
 /**
  * jsonrpc_client_call_with_id_async:
  * @self: A #JsonrpcClient
- * @method: the name of the method to call
+ * @method: The name of the method to call
  * @params: (transfer none) (nullable): A [struct@GLib.Variant] of parameters or %NULL
- * @id: (out) (transfer full) (optional): a location for a [struct@GLib.Variant]
+ * @id: (out) (transfer full) (optional): A location for a [struct@GLib.Variant]
  *   describing the identifier used for the method call, or %NULL.
  * @cancellable: (nullable): A #GCancellable or %NULL
- * @callback: a callback to executed upon completion
- * @user_data: user data for @callback
+ * @callback: Callback to executed upon completion
+ * @user_data: User data for @callback
  *
  * Asynchronously calls @method with @params on the remote peer.
  *
@@ -1040,7 +1040,7 @@ jsonrpc_client_call_with_id_async (JsonrpcClient       *self,
 /**
  * jsonrpc_client_call_async:
  * @self: A #JsonrpcClient
- * @method: the name of the method to call
+ * @method: The name of the method to call
  * @params: (transfer none) (nullable): A [struct@GLib.Variant] of parameters or %NULL
  * @cancellable: (nullable): A #GCancellable or %NULL
  * @callback: a callback to executed upon completion
@@ -1129,7 +1129,7 @@ jsonrpc_client_send_notification_write_cb (GObject      *object,
 /**
  * jsonrpc_client_send_notification:
  * @self: A #JsonrpcClient
- * @method: the name of the method to call
+ * @method: The name of the method to call
  * @params: (transfer none) (nullable): A [struct@GLib.Variant] of parameters or %NULL
  * @cancellable: (nullable): A #GCancellable or %NULL
  *
@@ -1181,7 +1181,7 @@ jsonrpc_client_send_notification (JsonrpcClient  *self,
 /**
  * jsonrpc_client_send_notification_async:
  * @self: A #JsonrpcClient
- * @method: the name of the method to call
+ * @method: The name of the method to call
  * @params: (transfer none) (nullable): A [struct@GLib.Variant] of parameters or %NULL
  * @cancellable: (nullable): A #GCancellable or %NULL
  *
@@ -1400,13 +1400,13 @@ jsonrpc_client_reply_error_cb (GObject      *object,
 
 /**
  * jsonrpc_client_reply_error_async:
- * @self: a #JsonrpcClient
- * @id: (transfer none): a [struct@GLib.Variant] containing the call id
- * @code: the error code
- * @message: (nullable): an optional error message
- * @cancellable: (nullable): a #GCancellable, or %NULL
- * @callback: (nullable): a #GAsyncReadyCallback or %NULL
- * @user_data: closure data for @callback
+ * @self: A #JsonrpcClient
+ * @id: (transfer none): A [struct@GLib.Variant] containing the call id
+ * @code: The error code
+ * @message: (nullable): An optional error message
+ * @cancellable: (nullable): A #GCancellable, or %NULL
+ * @callback: (nullable): A #GAsyncReadyCallback or %NULL
+ * @user_data: Closure data for @callback
  *
  * Asynchronously replies to the peer, sending a JSON-RPC error message.
  *
@@ -1481,11 +1481,11 @@ jsonrpc_client_reply_error_finish (JsonrpcClient  *self,
 
 /**
  * jsonrpc_client_reply:
- * @self: a #JsonrpcClient
- * @id: (transfer none) the id of the message to reply
- * @result: (transfer none) (nullable): the return value or %NULL
- * @cancellable: (nullable): a #GCancellable, or %NULL
- * @error: a #GError, or %NULL
+ * @self: A #JsonrpcClient
+ * @id: (transfer none): The id of the message to reply
+ * @result: (transfer none) (nullable): The return value or %NULL
+ * @cancellable: (nullable): A #GCancellable, or %NULL
+ * @error: A #GError, or %NULL
  *
  * Synchronous variant of [method@Client.reply_async].
  *
@@ -1547,12 +1547,12 @@ jsonrpc_client_reply_cb (GObject      *object,
 
 /**
  * jsonrcp_client_reply_async:
- * @self: a #JsonrpcClient
- * @id: (transfer none): the id of the message to reply
- * @result: (transfer none) (nullable): the return value or %NULL
- * @cancellable: a #GCancellable, or %NULL
- * @callback: (nullable): a #GAsyncReadyCallback or %NULL
- * @user_data: closure data for @callback
+ * @self: A #JsonrpcClient
+ * @id: (transfer none): The id of the message to reply
+ * @result: (transfer none) (nullable): The return value or %NULL
+ * @cancellable: A #GCancellable, or %NULL
+ * @callback: (nullable): A #GAsyncReadyCallback or %NULL
+ * @user_data: Closure data for @callback
  *
  * This function will reply to a method call identified by @id with the
  * result provided. If @result is %NULL, then a null JSON node is returned
@@ -1619,9 +1619,9 @@ jsonrpc_client_reply_async (JsonrpcClient       *self,
 
 /**
  * jsonrpc_client_reply_finish:
- * @self: a #JsonrpcClient
+ * @self: A #JsonrpcClient
  * @result: A #GAsyncResult
- * @error: a location for a #GError or %NULL
+ * @error: A location for a #GError or %NULL
  *
  * Completes an asynchronous request to [method@Client.reply_async].
  *
@@ -1642,7 +1642,7 @@ jsonrpc_client_reply_finish (JsonrpcClient  *self,
 
 /**
  * jsonrpc_client_start_listening:
- * @self: a #JsonrpcClient
+ * @self: A #JsonrpcClient
  *
  * This function requests that client start processing incoming
  * messages from the peer.
@@ -1681,7 +1681,7 @@ jsonrpc_client_start_listening (JsonrpcClient *self)
 
 /**
  * jsonrpc_client_get_use_gvariant:
- * @self: a #JsonrpcClient
+ * @self: A #JsonrpcClient
  *
  * Gets the [property@Client:use-gvariant] property.
  *
@@ -1703,8 +1703,8 @@ jsonrpc_client_get_use_gvariant (JsonrpcClient *self)
 
 /**
  * jsonrpc_client_set_use_gvariant:
- * @self: a #JsonrpcClient
- * @use_gvariant: if [struct@GLib.Variant] should be used
+ * @self: A #JsonrpcClient
+ * @use_gvariant: If [struct@GLib.Variant] should be used
  *
  * Sets the [property@Client:use-gvariant] property.
  *
diff --git a/src/jsonrpc-server.c b/src/jsonrpc-server.c
index 5142f94..6617f90 100644
--- a/src/jsonrpc-server.c
+++ b/src/jsonrpc-server.c
@@ -133,11 +133,11 @@ jsonrpc_server_class_init (JsonrpcServerClass *klass)
 
   /**
    * JsonrpcServer::handle-call:
-   * @self: a #JsonrpcServer
-   * @client: a #JsonrpcClient
-   * @method: the method that was called
-   * @id: the identifier of the method call
-   * @params: the parameters of the method call
+   * @self: A #JsonrpcServer
+   * @client: A #JsonrpcClient
+   * @method: The method that was called
+   * @id: The identifier of the method call
+   * @params: The parameters of the method call
    *
    * This method is emitted when the client requests a method call.
    *
@@ -169,8 +169,8 @@ jsonrpc_server_class_init (JsonrpcServerClass *klass)
    * JsonrpcServer::notification:
    * @self: A #JsonrpcServer
    * @client: A #JsonrpcClient
-   * @method: the notification name
-   * @id: the params for the notification
+   * @method: The notification name
+   * @id: The params for the notification
    *
    * This signal is emitted when the client has sent a notification to us.
    *
@@ -323,7 +323,7 @@ jsonrpc_server_client_notification (JsonrpcServer *self,
 
 /**
  * jsonrpc_server_accept_io_stream:
- * @self: a #JsonrpcServer
+ * @self: A #JsonrpcServer
  * @io_stream: A #GIOStream
  *
  * This function accepts @io_stream as a new client to the #JsonrpcServer
@@ -385,8 +385,8 @@ sort_by_method (gconstpointer a,
  * @method: A method to handle
  * @handler: (closure handler_data) (destroy handler_data_destroy): A handler to
  *   execute when an incoming method matches @methods
- * @handler_data: user data for @handler
- * @handler_data_destroy: a destroy callback for @handler_data
+ * @handler_data: User data for @handler
+ * @handler_data_destroy: A destroy callback for @handler_data
  *
  * Adds a new handler that will be dispatched when a matching @method arrives.
  *
@@ -422,8 +422,8 @@ jsonrpc_server_add_handler (JsonrpcServer        *self,
 
 /**
  * jsonrpc_server_remove_handler:
- * @self: a #JsonrpcServer
- * @handler_id: a handler returned from [method@Server.add_handler]
+ * @self: A #JsonrpcServer
+ * @handler_id: A handler returned from [method@Server.add_handler]
  *
  * Removes a handler that was previously registered with [method@Server.add_handler].
  *
@@ -452,9 +452,9 @@ jsonrpc_server_remove_handler (JsonrpcServer *self,
 
 /**
  * jsonrpc_server_foreach:
- * @self: a #JsonrpcServer
- * @foreach_func: (scope call): a callback for each client
- * @user_data: closure data for @foreach_func
+ * @self: A #JsonrpcServer
+ * @foreach_func: (scope call): A callback for each client
+ * @user_data: Closure data for @foreach_func
  *
  * Calls @foreach_func for every client connected.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]