Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Aug 31, 2010, 5:19:36 PM (14 years ago)
Author:
landauf
Message:

the @example tag shouldn't be used in a documentation unless the whole file is an example implementation

Location:
code/branches/doc/src/libraries/util
Files:
4 edited

Legend:

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

    r6443 r7291  
    5252     6: Crazy debug information
    5353
    54 @example
     54    Example:
     55    @code
    5556    COUT(0) << "Very important output" << std::endl;
    5657    COUT(1) << "Error: Something went wrong!" << std::endl;
     
    5859    COUT(3) << "Info: It's Monday" << std::endl;
    5960    COUT(4) << "Debug: x is 1.23456" << std::endl;
     61    @endcode
    6062*/
    6163
     
    9698    where (a > b ? 0 : ) stands for COUT(x). This should explain how
    9799    this macro magic can possibly even work ;)
    98 @example
     100
     101    Example:
     102    @code
    99103    COUT(3) << "Some info" << std::endl;
     104    @endcode
    100105@note
    101106    The ? : operator requires both possible results to have the type of
  • code/branches/doc/src/libraries/util/Math.cc

    r7284 r7291  
    9393        @return The angle
    9494
    95         @example
     95        Examples:
    9696        If the other object is exactly in front of me, the function returns 0.
    9797        If the other object is exactly behind me, the function returns pi.
     
    116116        @return The viewing direction
    117117
    118         @example
     118        Examples:
    119119        If the other object is exactly in front of me, the function returns Vector2(0, 0).
    120120        If the other object is exactly at my left, the function returns Vector2(-1, 0).
     
    156156        @return The viewing direction
    157157
    158         @example
     158        Examples:
    159159        If the other object is exactly in front of me, the function returns Vector2(0, 0).
    160160        If the other object is exactly at my left, the function returns Vector2(-0.5, 0).
  • code/branches/doc/src/libraries/util/MultiType.h

    r7284 r7291  
    5252     - setValue<T>(value) assigns a new value and changes the type to T.
    5353
    54     @example
     54    Examples:
     55    @code
    5556    MultiType a = 10;;         // a has now the type int and the value 10
    5657    a.setValue("3.14");        // a has still the type int and "3.14" gets converted, therefore the value is now 3
     
    5859    a.convert<bool>();         // converts 3.14 to bool, which is true
    5960    a = false;                 // assigns false, this is equivalent to a.setValue(false)
     61    @endcode
    6062
    6163    @note
  • code/branches/doc/src/libraries/util/SubString.h

    r7284 r7291  
    4747 * but also removing leading and trailing spaces around the comma.
    4848 *
    49  * @example
     49 * Example:
    5050 * Split the String std::string st = "1345, The new empire   , is , orxonox"
    5151 * is splitted with:
    52  * SubString(st, ',', " \n\t")
     52 * @code SubString(st, ',', " \n\t") @endcode
    5353 * into
    5454 * "1345", "The new empire", "is", "orxonox"
Note: See TracChangeset for help on using the changeset viewer.