luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-23 10:42:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Avoid a bare "returns:"

Browse Source 
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:
Emmanuele Bassi 2023-10-14 18:09:43 +01:00 committed by Philip Withnall
parent c86f469c1e
commit cfb11a8d63
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gio/gioerror.c
View File

@ -51,15 +51,18 @@ G_DEFINE_QUARK (g-io-error-quark, g_io_error)
* g_io_error_from_errno:
* @err_no: Error number as defined in errno.h.
*
* Converts errno.h error codes into GIO error codes. 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
* Converts `errno.h` error codes into GIO error codes.
*
* 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).
*
* 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
* returns:
* |[
* As `errno` is global and may be modified by intermediate function
* calls, you should save its value immediately after the call returns,
* and use the saved value instead of `errno`:
*
*
* |[<!-- language="C" -->
* int saved_errno;
*
* ret = read (blah);
@ -68,8 +71,8 @@ G_DEFINE_QUARK (g-io-error-quark, g_io_error)
* 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
g_io_error_from_errno (gint err_no)
{