[X2Go-Commits] [libx2goclient] 94/132: src/x2goclient-utils.c: add emphasis to capital-type words.

[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 932cdb5a19d727c4278921193672603f4fea2bc5
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Mon Aug 2 16:56:32 2021 +0200

    src/x2goclient-utils.c: add emphasis to capital-type words.
---
 src/x2goclient-utils.c | 28 ++++++++++++++++------------
 1 file changed, 16 insertions(+), 12 deletions(-)

diff --git a/src/x2goclient-utils.c b/src/x2goclient-utils.c
index f274e24..9c7eeb5 100644
--- a/src/x2goclient-utils.c
+++ b/src/x2goclient-utils.c
@@ -81,8 +81,8 @@ void x2goclient_clear_strings (gpointer data) {
  *
  * Takes a string and converts it into a #long long int.
  *
- * The error output parameters @conv_err, @min_err and @max_err MUST NOT be
- * %NULL at any time.
+ * The error output parameters @conv_err, @min_err and @max_err
+ * <emphasis role='strong'>MUST NOT</emphasis> be %NULL at any time.
  *
  * Multiple error conditions exist:
  *    - If the value pointed to by @conv_err is %TRUE and the values pointed to
@@ -108,8 +108,9 @@ void x2goclient_clear_strings (gpointer data) {
  *      check. The returned value will still contain the originally converted
  *      number.
  *
- * The values pointed to by @conv_err, @min_err and @max_err SHOULD never be
- * all set to %TRUE by this function at the same time. Otherwise, that's a bug.
+ * The values pointed to by @conv_err, @min_err and @max_err <emphasis
+ * role='strong'>SHOULD</emphasis> never be all set to %TRUE by this function
+ * at the same time. Otherwise, that's a bug.
  *
  * If the value pointed to by @min is %FALSE, @limit_min will not be touched
  * and has no meaning to the function. The same logic applies to @max and
@@ -193,18 +194,21 @@ long long x2goclient_str_to_int (const gchar * const restrict str, const _Bool m
  * string's (iff truncated) size is returned via @new_size, unless an error
  * occurred.
  *
- * The input parameter @haystack MUST NOT be %NULL at any time.
- * The input parameter @needle CAN be %NULL, but that's hardly useful, since it
- * effectively degrades the function to (a probably slower implementation of)
- * strdup().
- * The output parameter @new_size CAN be %NULL.
+ * The input parameter @haystack <emphasis role='strong'>MUST NOT</emphasis>
+ * be %NULL at any time.
+ * The input parameter @needle <emphasis role='strong'>CAN</emphasis> be
+ * %NULL, but that's hardly useful, since it effectively degrades the function
+ * to (a probably slower implementation of) strdup().
+ * The output parameter @new_size <emphasis role='strong'>CAN</emphasis> be
+ * %NULL.
  *
  * Errors are indicated by returning %NULL:
  *    - If the value of @haystack is %NULL, no work will be done.
  *    - If the value pointed to by @haystack is %NULL, no work will be done.
- *    - If memory allocation failed, the value pointed to by @haystack WILL
- *      NOT be changed and NOT be g_free()'d. The caller will have to clean
- *      up. @new_size will not be touched.
+ *    - If memory allocation failed, the value pointed to by @haystack
+ *      <emphasis role='strong'>WILL NOT</emphasis> be changed and <emphasis
+ *      role='strong'>NOT</emphasis> be g_free()'d. The caller will have to
+ *      clean up. @new_size will not be touched.
  *
  * Otherwise, the return value will be non-%NULL:
  *    - If the value pointed to by @haystack does not contain @needle, a copy

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