mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-10 03:16:17 +01:00
docs: add missing '*' chars at start of doc-comments
This commit is contained in:
parent
e7adf0a1a3
commit
2812219adb
@ -6126,7 +6126,7 @@ g_dbus_connection_call_finish (GDBusConnection *connection,
|
|||||||
* operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
|
* operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
|
||||||
* contains a value not compatible with the D-Bus protocol, the operation
|
* contains a value not compatible with the D-Bus protocol, the operation
|
||||||
* fails with %G_IO_ERROR_INVALID_ARGUMENT.
|
* fails with %G_IO_ERROR_INVALID_ARGUMENT.
|
||||||
|
*
|
||||||
* If @reply_type is non-%NULL then the reply will be checked for having
|
* 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
|
* 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
|
* another way, if you give a @reply_type then any non-%NULL return
|
||||||
|
@ -318,7 +318,7 @@ next_async_callback_wrapper (GObject *source_object,
|
|||||||
* Request information for a number of files from the enumerator asynchronously.
|
* 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
|
* When all i/o for the operation is finished the @callback will be called with
|
||||||
* the requested information.
|
* the requested information.
|
||||||
|
*
|
||||||
* See the documentation of #GFileEnumerator for information about the
|
* See the documentation of #GFileEnumerator for information about the
|
||||||
* order of returned files.
|
* order of returned files.
|
||||||
*
|
*
|
||||||
|
@ -633,7 +633,7 @@ g_volume_enumerate_identifiers (GVolume *volume)
|
|||||||
* then the expression
|
* then the expression
|
||||||
* |[<!-- language="C" -->
|
* |[<!-- language="C" -->
|
||||||
* (g_file_has_prefix (volume_activation_root, mount_root) ||
|
* (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.
|
* will always be %TRUE.
|
||||||
*
|
*
|
||||||
|
@ -99,7 +99,7 @@ g_bytes_new (gconstpointer data,
|
|||||||
/**
|
/**
|
||||||
* g_bytes_new_take:
|
* g_bytes_new_take:
|
||||||
* @data: (transfer full) (array length=size) (element-type guint8) (nullable):
|
* @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
|
* @size: the size of @data
|
||||||
*
|
*
|
||||||
* Creates a new #GBytes from @data.
|
* Creates a new #GBytes from @data.
|
||||||
@ -130,7 +130,7 @@ g_bytes_new_take (gpointer data,
|
|||||||
/**
|
/**
|
||||||
* g_bytes_new_static: (skip)
|
* g_bytes_new_static: (skip)
|
||||||
* @data: (transfer full) (array length=size) (element-type guint8) (nullable):
|
* @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
|
* @size: the size of @data
|
||||||
*
|
*
|
||||||
* Creates a new #GBytes from static 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)
|
* g_bytes_new_with_free_func: (skip)
|
||||||
* @data: (array length=size) (element-type guint8) (nullable):
|
* @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
|
* @size: the size of @data
|
||||||
* @free_func: the function to call to release the data
|
* @free_func: the function to call to release the data
|
||||||
* @user_data: data to pass to @free_func
|
* @user_data: data to pass to @free_func
|
||||||
|
@ -128,7 +128,6 @@
|
|||||||
* ## Checklist for Application Writers
|
* ## Checklist for Application Writers
|
||||||
*
|
*
|
||||||
* This section is a practical summary of the detailed
|
* This section is a practical summary of the detailed
|
||||||
|
|
||||||
* things to do to make sure your applications process file
|
* things to do to make sure your applications process file
|
||||||
* name encodings correctly.
|
* name encodings correctly.
|
||||||
*
|
*
|
||||||
@ -583,8 +582,8 @@ g_convert (const gchar *str,
|
|||||||
* @fallback: UTF-8 string to use in place of character not
|
* @fallback: UTF-8 string to use in place of character not
|
||||||
* present in the target encoding. (The string must be
|
* present in the target encoding. (The string must be
|
||||||
* representable in the target encoding).
|
* representable in the target encoding).
|
||||||
If %NULL, characters not in the target encoding will
|
* If %NULL, characters not in the target encoding will
|
||||||
be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
|
* be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
|
||||||
* @bytes_read: location to store the number of bytes in the
|
* @bytes_read: location to store the number of bytes in the
|
||||||
* input string that were successfully converted, or %NULL.
|
* input string that were successfully converted, or %NULL.
|
||||||
* Even if the conversion was successful, this may be
|
* Even if the conversion was successful, this may be
|
||||||
|
@ -136,7 +136,7 @@
|
|||||||
* @hook: a #GHook
|
* @hook: a #GHook
|
||||||
*
|
*
|
||||||
* Returns %TRUE if the #GHook is not in a #GHookList.
|
* Returns %TRUE if the #GHook is not in a #GHookList.
|
||||||
|
*
|
||||||
* Returns: %TRUE if the #GHook is not in a #GHookList
|
* Returns: %TRUE if the #GHook is not in a #GHookList
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -2270,7 +2270,7 @@ g_key_file_get_locale_string (GKeyFile *key_file,
|
|||||||
* Returns the values associated with @key under @group_name
|
* Returns the values associated with @key under @group_name
|
||||||
* translated in the given @locale if available. If @locale is
|
* translated in the given @locale if available. If @locale is
|
||||||
* %NULL then the current locale is assumed.
|
* %NULL then the current locale is assumed.
|
||||||
|
*
|
||||||
* If @key cannot be found then %NULL is returned and @error is set
|
* 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
|
* to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
|
||||||
* with @key cannot be interpreted or no suitable translations
|
* with @key cannot be interpreted or no suitable translations
|
||||||
|
@ -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()
|
* g_main_context_push_thread_default() / g_main_context_pop_thread_default()
|
||||||
* pair, otherwise threads that are re-used will end up never explicitly
|
* pair, otherwise threads that are re-used will end up never explicitly
|
||||||
* releasing the #GMainContext reference they hold.
|
* releasing the #GMainContext reference they hold.
|
||||||
|
*
|
||||||
* In some cases you may want to schedule a single operation in a
|
* In some cases you may want to schedule a single operation in a
|
||||||
* non-default context, or temporarily use a non-default context in
|
* non-default context, or temporarily use a non-default context in
|
||||||
* the main thread. In that case, you can wrap the call to the
|
* the main thread. In that case, you can wrap the call to the
|
||||||
|
@ -70,7 +70,7 @@ typedef struct _GSourcePrivate GSourcePrivate;
|
|||||||
* @unref: Called when a reference to the callback object is dropped
|
* @unref: Called when a reference to the callback object is dropped
|
||||||
* @get: Called to extract the callback function and data from the
|
* @get: Called to extract the callback function and data from the
|
||||||
* callback object.
|
* callback object.
|
||||||
|
*
|
||||||
* The `GSourceCallbackFuncs` struct contains
|
* The `GSourceCallbackFuncs` struct contains
|
||||||
* functions for managing callback objects.
|
* functions for managing callback objects.
|
||||||
*/
|
*/
|
||||||
|
@ -118,7 +118,7 @@
|
|||||||
*
|
*
|
||||||
* // Allocate one block, using the g_slice_new() macro.
|
* // Allocate one block, using the g_slice_new() macro.
|
||||||
* array = g_slice_new (GRealArray);
|
* array = g_slice_new (GRealArray);
|
||||||
|
*
|
||||||
* // We can now use array just like a normal pointer to a structure.
|
* // We can now use array just like a normal pointer to a structure.
|
||||||
* array->data = NULL;
|
* array->data = NULL;
|
||||||
* array->len = 0;
|
* array->len = 0;
|
||||||
|
@ -761,7 +761,7 @@ g_open (const gchar *filename,
|
|||||||
* A wrapper for the POSIX creat() function. The creat() function is
|
* A wrapper for the POSIX creat() function. The creat() function is
|
||||||
* used to convert a pathname into a file descriptor, creating a file
|
* used to convert a pathname into a file descriptor, creating a file
|
||||||
* if necessary.
|
* if necessary.
|
||||||
|
*
|
||||||
* On POSIX systems file descriptors are implemented by the operating
|
* On POSIX systems file descriptors are implemented by the operating
|
||||||
* system. On Windows, it's the C library that implements creat() and
|
* system. On Windows, it's the C library that implements creat() and
|
||||||
* file descriptors. The actual Windows API for opening files is
|
* file descriptors. The actual Windows API for opening files is
|
||||||
|
@ -2377,7 +2377,6 @@ g_test_suite_count (GTestSuite *suite)
|
|||||||
* test path arguments (`-p testpath` and `-s testpath`) as parsed by
|
* test path arguments (`-p testpath` and `-s testpath`) as parsed by
|
||||||
* g_test_init(). See the g_test_run() documentation for more
|
* g_test_init(). See the g_test_run() documentation for more
|
||||||
* information on the order that tests are run in.
|
* information on the order that tests are run in.
|
||||||
|
|
||||||
*
|
*
|
||||||
* g_test_run_suite() or g_test_run() may only be called once
|
* g_test_run_suite() or g_test_run() may only be called once
|
||||||
* in a program.
|
* in a program.
|
||||||
|
@ -246,7 +246,7 @@ g_mutex_unlock (GMutex *mutex)
|
|||||||
* non-recursive. As such, calling g_mutex_lock() on a #GMutex that has
|
* non-recursive. As such, calling g_mutex_lock() on a #GMutex that has
|
||||||
* already been locked by the same thread results in undefined behaviour
|
* already been locked by the same thread results in undefined behaviour
|
||||||
* (including but not limited to deadlocks or arbitrary return values).
|
* (including but not limited to deadlocks or arbitrary return values).
|
||||||
|
*
|
||||||
* Returns: %TRUE if @mutex could be locked
|
* Returns: %TRUE if @mutex could be locked
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
|
@ -76,7 +76,7 @@
|
|||||||
* 4. Invocation of user provided signal handlers (where the @after flag is set)
|
* 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
|
* 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
|
* The user-provided signal handlers are called in the order they were
|
||||||
* connected in.
|
* connected in.
|
||||||
*
|
*
|
||||||
|
Loading…
Reference in New Issue
Block a user