Changeset 7316 for code/branches/doc/src/libraries/util/Debug.h
- Timestamp:
- Sep 1, 2010, 4:56:19 PM (14 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
code/branches/doc/src/libraries/util/Debug.h
r7291 r7316 31 31 @file 32 32 @brief 33 Handles different output-levels of errors, warnings, infos and debug information.33 Handles different output-levels of errors, warnings, infos, and debug information. 34 34 35 The COUT(level) macro acts like std::cout, but the output is only performed if the given35 The COUT(level) macro acts like @c std::cout, but the output is only performed if the given 36 36 level is <= the soft debug level. 37 37 … … 39 39 - The hard debug level is used during compile time. It describes the highest allowed output level. 40 40 - The soft debug level is used during runtime and is the maximum of the three configurable 41 output-levels for console, log file and in game shell.41 output-levels for console, log file, and in game shell. 42 42 43 43 The separation between the three devices is done by the OutputHandler. 44 44 45 @anchor COUTlevels 45 46 Possible levels are: 46 0: Very important output47 1: Errors48 2: Warnings49 3: Information50 4: Debug information51 5: More debug information52 6: Crazy debug information47 - 0: Very important output 48 - 1: Errors 49 - 2: Warnings 50 - 3: Information 51 - 4: Debug information 52 - 5: More debug information 53 - 6: Crazy debug information 53 54 54 55 Example: … … 92 93 /** 93 94 @brief 94 Logs text output: use exactly like std::cout, but specify an output 95 level as argument. 96 @details 97 (a > b ? 0 : c << "text") is equivalent to (a > b ? 0 : (c << "text")) 98 where (a > b ? 0 : ) stands for COUT(x). This should explain how 99 this macro magic can possibly even work ;) 95 Logs text output: You can use COUT(level) exactly like @c std::cout, but you have to specify an output level as argument. 96 @param level 97 The level of the following output (passed with <tt><< "text"</tt>). Lower levels are more important. See @ref COUTlevels "the description above" for a list of possible output levels. 100 98 101 99 Example: 102 100 @code 103 COUT(3) << "Some info" << std::endl; 101 COUT(3) << "Some info" << std::endl; // Output with level 3 104 102 @endcode 105 103 @note 106 The ? : operator requires both possible results to have the type of 104 <tt>(a > b ? 0 : c << "text")</tt> is equivalent to <tt>(a > b ? 0 : (c << "text")</tt> 105 where <tt>(a > b ? 0 : )</tt> stands for COUT(x). This should explain how 106 this macro magic can possibly even work ;) 107 @remarks 108 The <tt>? :</tt> operator requires both possible results to have the type of 107 109 the first. This is achieved by the int conversion operator dummy 108 in the OutputHandler.110 in the @ref orxonox::OutputHandler. 109 111 */ 110 112 #define COUT(level) \
Note: See TracChangeset
for help on using the changeset viewer.