Rua: flesh out docs for BOOL.

This commit is contained in:
Jeff Teunissen 2012-08-17 20:22:03 -04:00
parent d1f1375df5
commit 396338a543

View file

@ -16,6 +16,22 @@ enum {
/**
Standard boolean type
This is not like a boolean in some other languages, where you can compare
any number against the 'true' value; that is, the following does not catch
all true values.
\code
if (foo == YES) {
...
}
\endcode
If you want to catch all true values, simply test for truth using something
like:
\code
if (foo) {
...
}
\endcode
*/
typedef enum {
NO = 0, ///< the false value