mirror of
https://git.code.sf.net/p/quake/quakeforge
synced 2024-11-10 15:22:04 +00:00
Rua: flesh out docs for BOOL.
This commit is contained in:
parent
d1f1375df5
commit
396338a543
1 changed files with 16 additions and 0 deletions
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue