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

docs: Add note on how to check a gboolean condition

Browse Source
This commit is contained in:
Alistair Thomas 2019-01-05 20:59:09 +00:00
parent 245279e834
commit 94d855fc6d
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
glib/docs.c
View File

@ -64,6 +64,15 @@
* A standard boolean type. * A standard boolean type.
* Variables of this type should only contain the value * Variables of this type should only contain the value
* %TRUE or %FALSE. * %TRUE or %FALSE.
*
* Never directly compare the contents of a #gboolean variable with the values
* %TRUE or %FALSE. Use `if (condition)` to check a #gboolean is "true", instead
* of `if (condition == TRUE)`. Likewise use `if (!condition)` to check a
* #gboolean is "false".
*
* There is no validation when assigning to a #gboolean variable and so it could
* contain any value represented by a #gint. This is why the use of `if
* (condition)` is recommended. All non-zero values in C evaluate to "true".
*/ */
/** /**