diff options
| author | darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-08-15 19:05:36 +0000 |
|---|---|---|
| committer | darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-08-15 19:05:36 +0000 |
| commit | a430bdb13215eac169cd1c7e3e2fe88124c84b8e (patch) | |
| tree | c3cbc5768c704fab8d21b07c29a62c2e0f08bf06 /StdLib/Include/stdbool.h | |
| parent | abb4e5f3460fd4bf6ab1bf7ef67a8bddaf238f67 (diff) | |
Update or add comments to files and functions for use by Doxygen.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12139 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'StdLib/Include/stdbool.h')
| -rw-r--r-- | StdLib/Include/stdbool.h | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/StdLib/Include/stdbool.h b/StdLib/Include/stdbool.h index 42dcd86b53..32088665c4 100644 --- a/StdLib/Include/stdbool.h +++ b/StdLib/Include/stdbool.h @@ -1,8 +1,12 @@ /** @file
- The header <stdbool.h> defines four macros: bool, true, false,
- and __bool_true_false_are_defined.
+ Macros to simplify boolean expressions and operations.
- The macro bool expands to _Bool.
+ This header is not specified by the C95 standard but is included here for
+ operational convenience.
+
+ The macro bool expands to _Bool, as required by the C99 specification.
+ This subsequently expands to BOOLEAN, is a UEFI data type which is automatically
+ defined correctly for the target CPU architecture.
The remaining three macros are suitable for use in #if preprocessing
directives. They are true, which expands to the integer constant 1,
@@ -12,23 +16,22 @@ A program may undefine and perhaps then redefine the
macros bool, true, and false.
- Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php.
+ http://opensource.org/licenses/bsd-license.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
**/
#ifndef _STDBOOL_H
#define _STDBOOL_H
#include <sys/EfiCdefs.h>
-#define bool _Bool
-#define true 1
-#define false 0
+#define bool _Bool
+#define true 1
+#define false 0
#define __bool_true_false_are_defined 1
#endif /* _STDBOOL_H */
|