mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-02-02 17:26:17 +01:00
Docs: don't use the warning tag
More markup removal
This commit is contained in:
parent
c575d24dfb
commit
64eface479
@ -65,14 +65,13 @@ g_dbus_interface_get_info (GDBusInterface *interface_)
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* g_dbus_interface_get_object: (skip)
|
* g_dbus_interface_get_object: (skip)
|
||||||
* @interface_: An exported D-Bus interface.
|
* @interface_: An exported D-Bus interface
|
||||||
*
|
*
|
||||||
* Gets the #GDBusObject that @interface_ belongs to, if any.
|
* Gets the #GDBusObject that @interface_ belongs to, if any.
|
||||||
*
|
*
|
||||||
* <warning>It is not safe to use the returned object if @interface_
|
* It is not safe to use the returned object if @interface_ or
|
||||||
* or the returned object is being used from other threads. See
|
* the returned object is being used from other threads. See
|
||||||
* g_dbus_interface_dup_object() for a thread-safe
|
* g_dbus_interface_dup_object() for a thread-safe alternative.
|
||||||
* alternative.</warning>
|
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): A #GDBusObject or %NULL. The returned
|
* Returns: (transfer none): A #GDBusObject or %NULL. The returned
|
||||||
* reference belongs to @interface_ and should not be freed.
|
* reference belongs to @interface_ and should not be freed.
|
||||||
|
@ -7319,10 +7319,10 @@ replace_contents_open_callback (GObject *obj,
|
|||||||
* If @make_backup is %TRUE, this function will attempt to
|
* If @make_backup is %TRUE, this function will attempt to
|
||||||
* make a backup of @file.
|
* make a backup of @file.
|
||||||
*
|
*
|
||||||
* <warning><para>No copy of @content will be made, so it must stay valid until
|
* Note that no copy of @content will be made, so it must stay valid
|
||||||
* @callback is called. See g_file_replace_contents_bytes_async() for a #GBytes
|
* until @callback is called. See g_file_replace_contents_bytes_async()
|
||||||
* version that will automatically hold a reference to the contents (without
|
* for a #GBytes version that will automatically hold a reference to the
|
||||||
* copying) for the duration of the call.</para></warning>
|
* contents (without copying) for the duration of the call.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
g_file_replace_contents_async (GFile *file,
|
g_file_replace_contents_async (GFile *file,
|
||||||
|
@ -786,11 +786,11 @@ async_ready_write_callback_wrapper (GObject *source_object,
|
|||||||
* For the synchronous, blocking version of this function, see
|
* For the synchronous, blocking version of this function, see
|
||||||
* g_output_stream_write().
|
* g_output_stream_write().
|
||||||
*
|
*
|
||||||
* <warning><para>No copy of @buffer will be made, so it must stay valid until
|
* Note that no copy of @buffer will be made, so it must stay valid
|
||||||
* @callback is called. See g_output_stream_write_bytes_async() for a #GBytes
|
* until @callback is called. See g_output_stream_write_bytes_async()
|
||||||
* version that will automatically hold a reference to the contents (without
|
* for a #GBytes version that will automatically hold a reference to
|
||||||
* copying) for the duration of the call.</para></warning>
|
* the contents (without copying) for the duration of the call.
|
||||||
**/
|
*/
|
||||||
void
|
void
|
||||||
g_output_stream_write_async (GOutputStream *stream,
|
g_output_stream_write_async (GOutputStream *stream,
|
||||||
const void *buffer,
|
const void *buffer,
|
||||||
|
@ -748,11 +748,10 @@
|
|||||||
* The GLib macros GPOINTER_TO_INT(), GINT_TO_POINTER(), etc. take care
|
* The GLib macros GPOINTER_TO_INT(), GINT_TO_POINTER(), etc. take care
|
||||||
* to do the right thing on the every platform.
|
* to do the right thing on the every platform.
|
||||||
*
|
*
|
||||||
* <warning><para>You may not store pointers in integers. This is not
|
* Warning: You may not store pointers in integers. This is not
|
||||||
* portable in any way, shape or form. These macros <emphasis>only</emphasis>
|
* portable in any way, shape or form. These macros only allow storing
|
||||||
* allow storing integers in pointers, and only preserve 32 bits of the
|
* integers in pointers, and only preserve 32 bits of the integer; values
|
||||||
* integer; values outside the range of a 32-bit integer will be mangled.
|
* outside the range of a 32-bit integer will be mangled.
|
||||||
* </para></warning>
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -256,20 +256,18 @@ g_getenv (const gchar *variable)
|
|||||||
* Note that on some systems, when variables are overwritten, the memory
|
* Note that on some systems, when variables are overwritten, the memory
|
||||||
* used for the previous variables and its value isn't reclaimed.
|
* used for the previous variables and its value isn't reclaimed.
|
||||||
*
|
*
|
||||||
* <warning><para>
|
* You should be mindful fo the fact that environment variable handling
|
||||||
* Environment variable handling in UNIX is not thread-safe, and your
|
* in UNIX is not thread-safe, and your program may crash if one thread
|
||||||
* program may crash if one thread calls g_setenv() while another
|
* calls g_setenv() while another thread is calling getenv(). (And note
|
||||||
* thread is calling getenv(). (And note that many functions, such as
|
* that many functions, such as gettext(), call getenv() internally.)
|
||||||
* gettext(), call getenv() internally.) This function is only safe to
|
* This function is only safe to use at the very start of your program,
|
||||||
* use at the very start of your program, before creating any other
|
* before creating any other threads (or creating objects that create
|
||||||
* threads (or creating objects that create worker threads of their
|
* worker threads of their own).
|
||||||
* own).
|
*
|
||||||
* </para><para>
|
|
||||||
* If you need to set up the environment for a child process, you can
|
* If you need to set up the environment for a child process, you can
|
||||||
* use g_get_environ() to get an environment array, modify that with
|
* use g_get_environ() to get an environment array, modify that with
|
||||||
* g_environ_setenv() and g_environ_unsetenv(), and then pass that
|
* g_environ_setenv() and g_environ_unsetenv(), and then pass that
|
||||||
* array directly to execvpe(), g_spawn_async(), or the like.
|
* array directly to execvpe(), g_spawn_async(), or the like.
|
||||||
* </para></warning>
|
|
||||||
*
|
*
|
||||||
* Returns: %FALSE if the environment variable couldn't be set.
|
* Returns: %FALSE if the environment variable couldn't be set.
|
||||||
*
|
*
|
||||||
@ -323,20 +321,18 @@ extern char **environ;
|
|||||||
* Note that on some systems, when variables are overwritten, the
|
* Note that on some systems, when variables are overwritten, the
|
||||||
* memory used for the previous variables and its value isn't reclaimed.
|
* memory used for the previous variables and its value isn't reclaimed.
|
||||||
*
|
*
|
||||||
* <warning><para>
|
* You should be mindful of the fact that environment variable handling
|
||||||
* Environment variable handling in UNIX is not thread-safe, and your
|
* in UNIX is not thread-safe, and your program may crash if one thread
|
||||||
* program may crash if one thread calls g_unsetenv() while another
|
* calls g_unsetenv() while another thread is calling getenv(). (And note
|
||||||
* thread is calling getenv(). (And note that many functions, such as
|
* that many functions, such as gettext(), call getenv() internally.) This
|
||||||
* gettext(), call getenv() internally.) This function is only safe
|
* function is only safe to use at the very start of your program, before
|
||||||
* to use at the very start of your program, before creating any other
|
* creating any other threads (or creating objects that create worker
|
||||||
* threads (or creating objects that create worker threads of their
|
* threads of their own).
|
||||||
* own).
|
*
|
||||||
* </para><para>
|
|
||||||
* If you need to set up the environment for a child process, you can
|
* If you need to set up the environment for a child process, you can
|
||||||
* use g_get_environ() to get an environment array, modify that with
|
* use g_get_environ() to get an environment array, modify that with
|
||||||
* g_environ_setenv() and g_environ_unsetenv(), and then pass that
|
* g_environ_setenv() and g_environ_unsetenv(), and then pass that
|
||||||
* array directly to execvpe(), g_spawn_async(), or the like.
|
* array directly to execvpe(), g_spawn_async(), or the like.
|
||||||
* </para></warning>
|
|
||||||
*
|
*
|
||||||
* Since: 2.4
|
* Since: 2.4
|
||||||
*/
|
*/
|
||||||
|
10
glib/grand.c
10
glib/grand.c
@ -66,8 +66,8 @@
|
|||||||
* The following functions allow you to use a portable, fast and good
|
* The following functions allow you to use a portable, fast and good
|
||||||
* pseudo-random number generator (PRNG).
|
* pseudo-random number generator (PRNG).
|
||||||
*
|
*
|
||||||
* <warning><para>Do not use this API for cryptographic purposes such as key
|
* Do not use this API for cryptographic purposes such as key
|
||||||
* generation, nonces, salts or one-time pads.</para></warning>
|
* generation, nonces, salts or one-time pads.
|
||||||
*
|
*
|
||||||
* This PRNG is suitable for non-cryptographic use such as in games
|
* This PRNG is suitable for non-cryptographic use such as in games
|
||||||
* (shuffling a card deck, generating levels), generating data for a
|
* (shuffling a card deck, generating levels), generating data for a
|
||||||
@ -358,11 +358,11 @@ g_rand_set_seed (GRand* rand, guint32 seed)
|
|||||||
* @seed: array to initialize with
|
* @seed: array to initialize with
|
||||||
* @seed_length: length of array
|
* @seed_length: length of array
|
||||||
*
|
*
|
||||||
* Initializes the random number generator by an array of
|
* Initializes the random number generator by an array of longs.
|
||||||
* longs. Array can be of arbitrary size, though only the
|
* Array can be of arbitrary size, though only the
|
||||||
* first 624 values are taken. This function is useful
|
* first 624 values are taken. This function is useful
|
||||||
* if you have many low entropy seeds, or if you require more then
|
* if you have many low entropy seeds, or if you require more then
|
||||||
* 32bits of actual entropy for your application.
|
* 32 bits of actual entropy for your application.
|
||||||
*
|
*
|
||||||
* Since: 2.4
|
* Since: 2.4
|
||||||
**/
|
**/
|
||||||
|
@ -543,17 +543,16 @@ g_strdup_printf (const gchar *format,
|
|||||||
* @string1: the first string to add, which must not be %NULL
|
* @string1: the first string to add, which must not be %NULL
|
||||||
* @...: a %NULL-terminated list of strings to append to the string
|
* @...: a %NULL-terminated list of strings to append to the string
|
||||||
*
|
*
|
||||||
* Concatenates all of the given strings into one long string.
|
* Concatenates all of the given strings into one long string. The
|
||||||
* The returned string should be freed with g_free() when no longer needed.
|
* returned string should be freed with g_free() when no longer needed.
|
||||||
|
*
|
||||||
|
* The variable argument list must end with %NULL. If you forget the %NULL,
|
||||||
|
* g_strconcat() will start appending random memory junk to your string.
|
||||||
*
|
*
|
||||||
* Note that this function is usually not the right function to use to
|
* Note that this function is usually not the right function to use to
|
||||||
* assemble a translated message from pieces, since proper translation
|
* assemble a translated message from pieces, since proper translation
|
||||||
* often requires the pieces to be reordered.
|
* often requires the pieces to be reordered.
|
||||||
*
|
*
|
||||||
* <warning><para>The variable argument list <emphasis>must</emphasis> end
|
|
||||||
* with %NULL. If you forget the %NULL, g_strconcat() will start appending
|
|
||||||
* random memory junk to your string.</para></warning>
|
|
||||||
*
|
|
||||||
* Returns: a newly-allocated string containing all the string arguments
|
* Returns: a newly-allocated string containing all the string arguments
|
||||||
*/
|
*/
|
||||||
gchar*
|
gchar*
|
||||||
|
@ -199,7 +199,7 @@
|
|||||||
* <para>
|
* <para>
|
||||||
* Array type info structures are 6 * sizeof (void *), plus the
|
* Array type info structures are 6 * sizeof (void *), plus the
|
||||||
* memory required to store the type string itself. This means that
|
* memory required to store the type string itself. This means that
|
||||||
* on 32bit systems, the cache entry for "a{sv}" would require 30
|
* on 32-bit systems, the cache entry for "a{sv}" would require 30
|
||||||
* bytes of memory (plus malloc overhead).
|
* bytes of memory (plus malloc overhead).
|
||||||
* </para>
|
* </para>
|
||||||
* <para>
|
* <para>
|
||||||
@ -208,7 +208,7 @@
|
|||||||
* required to store the type string itself. A 2-item tuple, for
|
* required to store the type string itself. A 2-item tuple, for
|
||||||
* example, would have a type information structure that consumed
|
* example, would have a type information structure that consumed
|
||||||
* writable memory in the size of 14 * sizeof (void *) (plus type
|
* writable memory in the size of 14 * sizeof (void *) (plus type
|
||||||
* string) This means that on 32bit systems, the cache entry for
|
* string) This means that on 32-bit systems, the cache entry for
|
||||||
* "{sv}" would require 61 bytes of memory (plus malloc overhead).
|
* "{sv}" would require 61 bytes of memory (plus malloc overhead).
|
||||||
* </para>
|
* </para>
|
||||||
* <para>
|
* <para>
|
||||||
|
Loading…
Reference in New Issue
Block a user