luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

girepository: change giarginfo docs

Browse Source 
Clarify the meaning of 'may be null' in the docs: it refers to the value
of the argument itself, not the reference to the argument.

https://bugzilla.gnome.org/show_bug.cgi?id=660879
This commit is contained in:
Ryan Lortie 2014-05-14 14:56:58 -04:00
parent 45e28fa698
commit c0dab09f95
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
giarginfo.c
View File

@ -125,7 +125,8 @@ g_arg_info_is_caller_allocates (GIArgInfo *info)
* g_arg_info_is_optional:
* @info: a #GIArgInfo
*
* Obtain if the argument is optional.
* Obtain if the argument is optional. For 'out' arguments this means
* that you can pass %NULL in order to ignore the result.
*
* Returns: %TRUE if it is an optional argument
*/
@ -147,9 +148,13 @@ g_arg_info_is_optional (GIArgInfo *info)
* g_arg_info_may_be_null:
* @info: a #GIArgInfo
*
* Obtain if the argument accepts %NULL.
* Obtain if the type of the argument includes the possibility of %NULL.
* For 'in' values this means that %NULL is a valid value. For 'out'
* values, this means that %NULL may be returned.
*
* Returns: %TRUE if it accepts %NULL
* See also g_arg_info_is_optional().
*
* Returns: %TRUE if the value may be %NULL
*/
gboolean
g_arg_info_may_be_null (GIArgInfo *info)