Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Sep 1, 2010, 4:56:19 PM (14 years ago)
Author:
landauf
Message:

hide the referenced/references lists
improved documentation of Debug.h

File:
1 edited

Legend:

Unmodified
Added
Removed
  • code/branches/doc/src/libraries/util/Debug.h

    r7291 r7316  
    3131@file
    3232@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.
    3434
    35     The COUT(level) macro acts like std::cout, but the output is only performed if the given
     35    The COUT(level) macro acts like @c std::cout, but the output is only performed if the given
    3636    level is <= the soft debug level.
    3737
     
    3939     - The hard debug level is used during compile time. It describes the highest allowed output level.
    4040     - 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.
    4242
    4343    The separation between the three devices is done by the OutputHandler.
    4444
     45    @anchor COUTlevels
    4546    Possible levels are:
    46      0: Very important output
    47      1: Errors
    48      2: Warnings
    49      3: Information
    50      4: Debug information
    51      5: More debug information
    52      6: Crazy debug information
     47     - 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
    5354
    5455    Example:
     
    9293/**
    9394@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.
    10098
    10199    Example:
    102100    @code
    103     COUT(3) << "Some info" << std::endl;
     101    COUT(3) << "Some info" << std::endl; // Output with level 3
    104102    @endcode
    105103@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
    107109    the first. This is achieved by the int conversion operator dummy
    108     in the OutputHandler.
     110    in the @ref orxonox::OutputHandler.
    109111*/
    110112#define COUT(level)                                                    \
Note: See TracChangeset for help on using the changeset viewer.