mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-04-20 22:29:17 +02:00
docs: Avoid a bare "returns:"
Lines inside a docblock cannot begin with "returns:", as that is the tag for the documentation of the return value.
This commit is contained in:
parent
c86f469c1e
commit
cfb11a8d63
@ -51,15 +51,18 @@ G_DEFINE_QUARK (g-io-error-quark, g_io_error)
|
|||||||
* g_io_error_from_errno:
|
* g_io_error_from_errno:
|
||||||
* @err_no: Error number as defined in errno.h.
|
* @err_no: Error number as defined in errno.h.
|
||||||
*
|
*
|
||||||
* Converts errno.h error codes into GIO error codes. The fallback
|
* Converts `errno.h` error codes into GIO error codes.
|
||||||
* value %G_IO_ERROR_FAILED is returned for error codes not currently
|
*
|
||||||
* handled (but note that future GLib releases may return a more
|
* The fallback value %G_IO_ERROR_FAILED is returned for error codes not
|
||||||
|
* currently handled (but note that future GLib releases may return a more
|
||||||
* specific value instead).
|
* specific value instead).
|
||||||
*
|
*
|
||||||
* As %errno is global and may be modified by intermediate function
|
* As `errno` is global and may be modified by intermediate function
|
||||||
* calls, you should save its value as soon as the call which sets it
|
* calls, you should save its value immediately after the call returns,
|
||||||
* returns:
|
* and use the saved value instead of `errno`:
|
||||||
* |[
|
*
|
||||||
|
*
|
||||||
|
* |[<!-- language="C" -->
|
||||||
* int saved_errno;
|
* int saved_errno;
|
||||||
*
|
*
|
||||||
* ret = read (blah);
|
* ret = read (blah);
|
||||||
@ -68,8 +71,8 @@ G_DEFINE_QUARK (g-io-error-quark, g_io_error)
|
|||||||
* g_io_error_from_errno (saved_errno);
|
* g_io_error_from_errno (saved_errno);
|
||||||
* ]|
|
* ]|
|
||||||
*
|
*
|
||||||
* Returns: #GIOErrorEnum value for the given errno.h error number.
|
* Returns: #GIOErrorEnum value for the given `errno.h` error number
|
||||||
**/
|
*/
|
||||||
GIOErrorEnum
|
GIOErrorEnum
|
||||||
g_io_error_from_errno (gint err_no)
|
g_io_error_from_errno (gint err_no)
|
||||||
{
|
{
|
||||||
|
Loading…
x
Reference in New Issue
Block a user