luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-27 04:32:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve formatting of g_autoptr() documentation

Browse Source 
Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall 2019-05-08 12:52:48 +01:00
parent 62be3d5d3e
commit 5a30f852d6
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
glib/docs.c
View File

@ -2224,7 +2224,7 @@
* This macro can be used to avoid having to do explicit cleanups of * This macro can be used to avoid having to do explicit cleanups of
* local variables when exiting functions. It often vastly simplifies * local variables when exiting functions. It often vastly simplifies
* handling of error conditions, removing the need for various tricks * handling of error conditions, removing the need for various tricks
* such as 'goto out' or repeating of cleanup code. It is also helpful * such as `goto out` or repeating of cleanup code. It is also helpful
* for non-error cases. * for non-error cases.
* *
* Consider the following example: * Consider the following example:
@ -2251,8 +2251,8 @@
* } * }
* ]| * ]|
* *
* You must initialize the variable in some way -- either by use of an * You must initialize the variable in some way — either by use of an
* initialiser or by ensuring that an _init function will be called on * initialiser or by ensuring that an `_init` function will be called on
* it unconditionally before it goes out of scope. * it unconditionally before it goes out of scope.
* *
* Since: 2.44 * Since: 2.44
@ -2273,12 +2273,12 @@
* *
* This is meant to be used to declare pointers to types with cleanup * This is meant to be used to declare pointers to types with cleanup
* functions. The type of the variable is a pointer to @TypeName. You * functions. The type of the variable is a pointer to @TypeName. You
* must not add your own '*'. * must not add your own `*`.
* *
* This macro can be used to avoid having to do explicit cleanups of * This macro can be used to avoid having to do explicit cleanups of
* local variables when exiting functions. It often vastly simplifies * local variables when exiting functions. It often vastly simplifies
* handling of error conditions, removing the need for various tricks * handling of error conditions, removing the need for various tricks
* such as 'goto out' or repeating of cleanup code. It is also helpful * such as `goto out` or repeating of cleanup code. It is also helpful
* for non-error cases. * for non-error cases.
* *
* Consider the following example: * Consider the following example:
@ -2308,7 +2308,7 @@
* } * }
* ]| * ]|
* *
* You must initialise the variable in some way -- either by use of an * You must initialise the variable in some way — either by use of an
* initialiser or by ensuring that it is assigned to unconditionally * initialiser or by ensuring that it is assigned to unconditionally
* before it goes out of scope. * before it goes out of scope.
* *
@ -2330,7 +2330,7 @@
* This means it's useful for any type that is returned from * This means it's useful for any type that is returned from
* g_malloc(). * g_malloc().
* *
* Otherwise, this macro has similar constraints as g_autoptr() - only * Otherwise, this macro has similar constraints as g_autoptr(): only
* supported on GCC and clang, the variable must be initialized, etc. * supported on GCC and clang, the variable must be initialized, etc.
* *
* |[ * |[
@ -2365,13 +2365,13 @@
* are intended to be portable to those compilers. * are intended to be portable to those compilers.
* *
* This is meant to be used to declare lists of a type with a cleanup * This is meant to be used to declare lists of a type with a cleanup
* function. The type of the variable is a GList *. You * function. The type of the variable is a `GList *`. You
* must not add your own '*'. * must not add your own `*`.
* *
* This macro can be used to avoid having to do explicit cleanups of * This macro can be used to avoid having to do explicit cleanups of
* local variables when exiting functions. It often vastly simplifies * local variables when exiting functions. It often vastly simplifies
* handling of error conditions, removing the need for various tricks * handling of error conditions, removing the need for various tricks
* such as 'goto out' or repeating of cleanup code. It is also helpful * such as `goto out` or repeating of cleanup code. It is also helpful
* for non-error cases. * for non-error cases.
* *
* See also g_autoslist(), g_autoptr() and g_steal_pointer(). * See also g_autoslist(), g_autoptr() and g_steal_pointer().
@ -2393,13 +2393,13 @@
* are intended to be portable to those compilers. * are intended to be portable to those compilers.
* *
* This is meant to be used to declare lists of a type with a cleanup * This is meant to be used to declare lists of a type with a cleanup
* function. The type of the variable is a GSList *. You * function. The type of the variable is a `GSList *`. You
* must not add your own '*'. * must not add your own `*`.
* *
* This macro can be used to avoid having to do explicit cleanups of * This macro can be used to avoid having to do explicit cleanups of
* local variables when exiting functions. It often vastly simplifies * local variables when exiting functions. It often vastly simplifies
* handling of error conditions, removing the need for various tricks * handling of error conditions, removing the need for various tricks
* such as 'goto out' or repeating of cleanup code. It is also helpful * such as `goto out` or repeating of cleanup code. It is also helpful
* for non-error cases. * for non-error cases.
* *
* See also g_autolist(), g_autoptr() and g_steal_pointer(). * See also g_autolist(), g_autoptr() and g_steal_pointer().
@ -2446,7 +2446,7 @@
* The function will not be called if the variable to be cleaned up * The function will not be called if the variable to be cleaned up
* contains %NULL. * contains %NULL.
* *
* This will typically be the _free() or _unref() function for the given * This will typically be the `_free()` or `_unref()` function for the given
* type. * type.
* *
* With this definition, it will be possible to use g_autoptr() with * With this definition, it will be possible to use g_autoptr() with
@ -2469,7 +2469,7 @@
* *
* Defines the appropriate cleanup function for a type. * Defines the appropriate cleanup function for a type.
* *
* This will typically be the _clear() function for the given type. * This will typically be the `_clear()` function for the given type.
* *
* With this definition, it will be possible to use g_auto() with * With this definition, it will be possible to use g_auto() with
* @TypeName. * @TypeName.
@ -2501,7 +2501,7 @@
* and file descriptors. * and file descriptors.
* *
* @none specifies the "none" value for the type in question. It is * @none specifies the "none" value for the type in question. It is
* probably something like %NULL or -1. If the variable is found to * probably something like %NULL or `-1`. If the variable is found to
* contain this value then the free function will not be called. * contain this value then the free function will not be called.
* *
* |[ * |[