GNOME.org
 

[glib] docs: add missing '*' chars at start of doc-comments

commit 2812219adb2d3e1208943f4bddf54b3a1c1e1ed3
Author: Stefan Sauer <ensonic users sf net>
Date:   Fri Nov 10 22:18:20 2017 +0100

    docs: add missing '*' chars at start of doc-comments

 gio/gdbusconnection.c |    2 +-
 gio/gfileenumerator.c |    2 +-
 gio/gvolume.c         |    2 +-
 glib/gbytes.c         |    6 +++---
 glib/gconvert.c       |    5 ++---
 glib/ghook.c          |    2 +-
 glib/gkeyfile.c       |    2 +-
 glib/gmain.c          |    2 +-
 glib/gmain.h          |    2 +-
 glib/gslice.c         |    2 +-
 glib/gstdio.c         |    2 +-
 glib/gtestutils.c     |    1 -
 glib/gthread-posix.c  |    2 +-
 gobject/gsignal.c     |    2 +-
 14 files changed, 16 insertions(+), 18 deletions(-)
---
diff --git a/gio/gdbusconnection.c b/gio/gdbusconnection.c
index 74af984..421e9ea 100644
--- a/gio/gdbusconnection.c
+++ b/gio/gdbusconnection.c
@@ -6126,7 +6126,7 @@ g_dbus_connection_call_finish (GDBusConnection  *connection,
  * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
  * contains a value not compatible with the D-Bus protocol, the operation
  * fails with %G_IO_ERROR_INVALID_ARGUMENT.
-
+ *
  * If @reply_type is non-%NULL then the reply will be checked for having
  * this type and an error will be raised if it does not match.  Said
  * another way, if you give a @reply_type then any non-%NULL return
diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c
index 3e4db13..d96a798 100644
--- a/gio/gfileenumerator.c
+++ b/gio/gfileenumerator.c
@@ -318,7 +318,7 @@ next_async_callback_wrapper (GObject      *source_object,
  * Request information for a number of files from the enumerator asynchronously.
  * When all i/o for the operation is finished the @callback will be called with
  * the requested information. 
-
+ *
  * See the documentation of #GFileEnumerator for information about the
  * order of returned files.
  *
diff --git a/gio/gvolume.c b/gio/gvolume.c
index 67a70a9..f97ce4c 100644
--- a/gio/gvolume.c
+++ b/gio/gvolume.c
@@ -633,7 +633,7 @@ g_volume_enumerate_identifiers (GVolume *volume)
  * then the expression
  * |[<!-- language="C" -->
  *   (g_file_has_prefix (volume_activation_root, mount_root) ||
-      g_file_equal (volume_activation_root, mount_root))
+ *    g_file_equal (volume_activation_root, mount_root))
  * ]|
  * will always be %TRUE.
  *
diff --git a/glib/gbytes.c b/glib/gbytes.c
index ed582c0..747c41b 100644
--- a/glib/gbytes.c
+++ b/glib/gbytes.c
@@ -99,7 +99,7 @@ g_bytes_new (gconstpointer data,
 /**
  * g_bytes_new_take:
  * @data: (transfer full) (array length=size) (element-type guint8) (nullable):
-          the data to be used for the bytes
+ *        the data to be used for the bytes
  * @size: the size of @data
  *
  * Creates a new #GBytes from @data.
@@ -130,7 +130,7 @@ g_bytes_new_take (gpointer data,
 /**
  * g_bytes_new_static: (skip)
  * @data: (transfer full) (array length=size) (element-type guint8) (nullable):
-          the data to be used for the bytes
+ *        the data to be used for the bytes
  * @size: the size of @data
  *
  * Creates a new #GBytes from static data.
@@ -152,7 +152,7 @@ g_bytes_new_static (gconstpointer data,
 /**
  * g_bytes_new_with_free_func: (skip)
  * @data: (array length=size) (element-type guint8) (nullable):
-          the data to be used for the bytes
+ *        the data to be used for the bytes
  * @size: the size of @data
  * @free_func: the function to call to release the data
  * @user_data: data to pass to @free_func
diff --git a/glib/gconvert.c b/glib/gconvert.c
index ef96313..194b2fc 100644
--- a/glib/gconvert.c
+++ b/glib/gconvert.c
@@ -128,7 +128,6 @@
  * ## Checklist for Application Writers
  *
  * This section is a practical summary of the detailed
- 
  * things to do to make sure your applications process file
  * name encodings correctly.
  * 
@@ -583,8 +582,8 @@ g_convert (const gchar *str,
  * @fallback:     UTF-8 string to use in place of character not
  *                present in the target encoding. (The string must be
  *                representable in the target encoding). 
-                  If %NULL, characters not in the target encoding will 
-                  be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
+ *                If %NULL, characters not in the target encoding will 
+ *                be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
  * @bytes_read:   location to store the number of bytes in the
  *                input string that were successfully converted, or %NULL.
  *                Even if the conversion was successful, this may be 
diff --git a/glib/ghook.c b/glib/ghook.c
index 39550e2..00187bf 100644
--- a/glib/ghook.c
+++ b/glib/ghook.c
@@ -136,7 +136,7 @@
  * @hook: a #GHook
  *
  * Returns %TRUE if the #GHook is not in a #GHookList.
- 
+ *
  * Returns: %TRUE if the #GHook is not in a #GHookList
  */
 
diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c
index 6526576..e45661a 100644
--- a/glib/gkeyfile.c
+++ b/glib/gkeyfile.c
@@ -2270,7 +2270,7 @@ g_key_file_get_locale_string (GKeyFile     *key_file,
  * Returns the values associated with @key under @group_name
  * translated in the given @locale if available.  If @locale is
  * %NULL then the current locale is assumed.
-
+ *
  * If @key cannot be found then %NULL is returned and @error is set 
  * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
  * with @key cannot be interpreted or no suitable translations
diff --git a/glib/gmain.c b/glib/gmain.c
index bd77508..7e7e44b 100644
--- a/glib/gmain.c
+++ b/glib/gmain.c
@@ -755,7 +755,7 @@ static GPrivate thread_context_stack = G_PRIVATE_INIT (free_context_stack);
  * g_main_context_push_thread_default() / g_main_context_pop_thread_default()
  * pair, otherwise threads that are re-used will end up never explicitly
  * releasing the #GMainContext reference they hold.
-
+ *
  * In some cases you may want to schedule a single operation in a
  * non-default context, or temporarily use a non-default context in
  * the main thread. In that case, you can wrap the call to the
diff --git a/glib/gmain.h b/glib/gmain.h
index efd7052..a7da20d 100644
--- a/glib/gmain.h
+++ b/glib/gmain.h
@@ -70,7 +70,7 @@ typedef struct _GSourcePrivate          GSourcePrivate;
  * @unref: Called when a reference to the callback object is dropped
  * @get: Called to extract the callback function and data from the
  *     callback object.
-
+ *
  * The `GSourceCallbackFuncs` struct contains
  * functions for managing callback objects.
  */
diff --git a/glib/gslice.c b/glib/gslice.c
index c6caee7..454c8a6 100644
--- a/glib/gslice.c
+++ b/glib/gslice.c
@@ -118,7 +118,7 @@
  *
  * // Allocate one block, using the g_slice_new() macro.
  * array = g_slice_new (GRealArray);
-
+ *
  * // We can now use array just like a normal pointer to a structure.
  * array->data            = NULL;
  * array->len             = 0;
diff --git a/glib/gstdio.c b/glib/gstdio.c
index 9ce36f6..858d569 100644
--- a/glib/gstdio.c
+++ b/glib/gstdio.c
@@ -761,7 +761,7 @@ g_open (const gchar *filename,
  * A wrapper for the POSIX creat() function. The creat() function is
  * used to convert a pathname into a file descriptor, creating a file
  * if necessary.
-
+ *
  * On POSIX systems file descriptors are implemented by the operating
  * system. On Windows, it's the C library that implements creat() and
  * file descriptors. The actual Windows API for opening files is
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index 96b5343..dd8513a 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -2377,7 +2377,6 @@ g_test_suite_count (GTestSuite *suite)
  * test path arguments (`-p testpath` and `-s testpath`) as parsed by
  * g_test_init(). See the g_test_run() documentation for more
  * information on the order that tests are run in.
-
  *
  * g_test_run_suite() or g_test_run() may only be called once
  * in a program.
diff --git a/glib/gthread-posix.c b/glib/gthread-posix.c
index 4d69660..364c9eb 100644
--- a/glib/gthread-posix.c
+++ b/glib/gthread-posix.c
@@ -246,7 +246,7 @@ g_mutex_unlock (GMutex *mutex)
  * non-recursive.  As such, calling g_mutex_lock() on a #GMutex that has
  * already been locked by the same thread results in undefined behaviour
  * (including but not limited to deadlocks or arbitrary return values).
-
+ *
  * Returns: %TRUE if @mutex could be locked
  */
 gboolean
diff --git a/gobject/gsignal.c b/gobject/gsignal.c
index 82ca201..38f528e 100644
--- a/gobject/gsignal.c
+++ b/gobject/gsignal.c
@@ -76,7 +76,7 @@
  * 4. Invocation of user provided signal handlers (where the @after flag is set)
  *
  * 5. Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals
- 
+ *
  * The user-provided signal handlers are called in the order they were
  * connected in.
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]