[X2Go-Commits] [libx2goclient] 46/132: src/x2goclient-utils.c: document all functions.

[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 5b0580d1e9375e863532213ed73ce2d42c6f7209
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Thu Apr 29 14:16:45 2021 +0200

    src/x2goclient-utils.c: document all functions.
---
 src/x2goclient-utils.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/x2goclient-utils.c b/src/x2goclient-utils.c
index 456dc41..5113c66 100644
--- a/src/x2goclient-utils.c
+++ b/src/x2goclient-utils.c
@@ -31,6 +31,14 @@
 
 #include "x2goclient-utils.h"
 
+/**
+ * x2goclient_clear_strings:
+ * @data: (in) (nullable): input string
+ *
+ * Frees the string passed as @data. It's safe to pass %NULL.
+ *
+ * Since: 0.0.5
+ */
 void x2goclient_clear_strings (gpointer data) {
   g_free (data);
 }
@@ -100,6 +108,8 @@ void x2goclient_clear_strings (gpointer data) {
  * use or rely on it.
  *
  * Returns: the converted value as a #long long, unless an error occurred
+ *
+ * Since: 0.0.5
  */
 long long x2goclient_str_to_int (const gchar * const restrict str, const _Bool min, const long long limit_min, const _Bool max, const long long limit_max, const gchar ** const restrict end, _Bool * const restrict conv_err, _Bool * const restrict min_err, _Bool * const restrict max_err) {
   long long ret = 42;
@@ -192,6 +202,8 @@ long long x2goclient_str_to_int (const gchar * const restrict str, const _Bool m
  *          of @needle or the value pointed to by @haystack (i.e., the
  *          original string) if @needle was not found, unless an error
  *          occurred
+ *
+ * Since: 0.0.5
  */
 gchar* x2goclient_strbrk_dup (gchar * restrict * const haystack, const char needle, const _Bool free_orig, gsize * const new_size) {
   gchar *ret = NULL;
@@ -237,6 +249,8 @@ gchar* x2goclient_strbrk_dup (gchar * restrict * const haystack, const char need
  * Takes a boolean and converts it to a (static) string.
  *
  * Returns: (transfer none): the converted value as a string
+ *
+ * Since: 0.0.5
  */
 gchar* x2goclient_bool_to_str (const gboolean in) {
   gchar *ret = "false";

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