[X2Go-Commits] [libx2goclient] 128/132: src/x2goclient-utils.c: the style guide says to determinate parameter descriptions with a period, so do that.

[git-admin at x2go.org]

This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository libx2goclient.

commit 69a80c8b20fa2ac1f0ea9fc491c8ac32c0cd29e3
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Fri Dec 3 13:40:31 2021 +0100

    src/x2goclient-utils.c: the style guide says to determinate parameter descriptions with a period, so do that.
---
 src/x2goclient-utils.c | 31 ++++++++++++++++---------------
 1 file changed, 16 insertions(+), 15 deletions(-)

diff --git a/src/x2goclient-utils.c b/src/x2goclient-utils.c
index ac1a16c..dce7288 100644
--- a/src/x2goclient-utils.c
+++ b/src/x2goclient-utils.c
@@ -50,7 +50,7 @@
 
 /**
  * x2goclient_clear_strings:
- * @data: (in) (nullable): input string
+ * @data: (in) (nullable): input string.
  *
  * Frees the string passed as @data. It's safe to pass %NULL.
  *
@@ -62,22 +62,22 @@ void x2goclient_clear_strings (gpointer data) {
 
 /**
  * x2goclient_str_to_int:
- * @str: (in) (not nullable): input string
- * @min: (in): true if a minimum limit should be checked for
- * @limit_min: (in): the minimum limit to check for
- * @max: (in): true if a maximum limit should be checked for
- * @limit_max: (in): the maximum limit to check for
+ * @str: (in) (not nullable): input string.
+ * @min: (in): true if a minimum limit should be checked for.
+ * @limit_min: (in): the minimum limit to check for.
+ * @max: (in): true if a maximum limit should be checked for.
+ * @limit_max: (in): the maximum limit to check for.
  * @end: (out) (optional) (nullable): pointer to final string after the scanned
- *                                    value
+ *                                    value.
  * @conv_err: (out) (not nullable) (type gboolean*): will be set to true on
- *                                                   conversion errors
+ *                                                   conversion errors.
  * @min_err: (out) (not nullable) (type gboolean*): will be set to true if
  *                                                  value falls short of
  *                                                  minimum limit and on
- *                                                  underflows
+ *                                                  underflows.
  * @max_err: (out) (not nullable) (type gboolean*): will be set to true if
  *                                                  value exceeds maximum limit
- *                                                  and on overflows
+ *                                                  and on overflows.
  *
  * Takes a string and converts it into a #long long int.
  *
@@ -182,11 +182,12 @@ long long int x2goclient_str_to_int (const gchar * const restrict str, const _Bo
 
 /**
  * x2goclient_strbrk_dup:
- * @haystack: (inout) (not nullable) (transfer none): pointer to input string
- * @needle: (in): character to split/break at
- * @free_orig: (in): request that the original string be g_free()'d at the end
+ * @haystack: (inout) (not nullable) (transfer none): pointer to input string.
+ * @needle: (in): character to split/break at.
+ * @free_orig: (in): request that the original string be g_free()'d at the
+ *                   end.
  * @new_size: (out) (nullable): will be set to the copied string's size if a
- *                              copy was created
+ *                              copy was created.
  *
  * Searches for the first occurrence of a specific character in a string and
  * returns a copy of the string up to that location, potentially freeing the
@@ -266,7 +267,7 @@ gchar* x2goclient_strbrk_dup (gchar * restrict * const haystack, const char need
 
 /**
  * x2goclient_bool_to_str:
- * @in: (in): input boolean
+ * @in: (in): input boolean.
  *
  * Takes a boolean and converts it to a (static) string.
  *

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/libx2goclient.git