Changeset 7367 for code/branches/doc/src/libraries/util/TriBool.h

Timestamp:

Sep 6, 2010, 3:51:29 PM (14 years ago)

Author:

rgrieder

Message:

Added Doxygen documentation for ExprParser, MathConvert, OrxEnum, OrxAssert and TriBool.
Adjusted Doxygen documentation for Clock and Exception.

File:

• code/branches/doc/src/libraries/util/TriBool.h (modified) (1 diff)

code/branches/doc/src/libraries/util/TriBool.h

@@ -35 +35 @@
 namespace orxonox
 {
+    /** Sort of a boolean value that also has state \c Dontcare
+    @remarks
+        Even though \c False has the value 0, both \c True and \c Dontcare have
+        a value other than 0. Keep that in mind when using TriBools in if statements.
+    */
     namespace TriBool
     {