Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
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:
1 edited

Legend:

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

    r6417 r7367  
    2828
    2929/**
    30     @file
    31     @brief
    32         Math conversion functions. Definitions are in Math.cc
     30@file
     31@brief
     32    Conversion functions for Math types like Ogre::Vector3 (definitions are in Math.cc)
    3333*/
    3434
     
    4646    ////////////////////
    4747
    48     // Vector2 to std::string
     48    /// Ogre::Vector2 to std::string conversion
    4949    template <>
    5050    struct ConverterExplicit<orxonox::Vector2, std::string>
     
    6262    };
    6363
    64     // Vector3 to std::string
     64    /// Ogre::Vector3 to std::string conversion
    6565    template <>
    6666    struct ConverterExplicit<orxonox::Vector3, std::string>
     
    7878    };
    7979
    80     // Vector4 to std::string
     80    /// Ogre::Vector4 to std::string conversion
    8181    template <>
    8282    struct ConverterExplicit<orxonox::Vector4, std::string>
     
    9494    };
    9595
    96     // Quaternion to std::string
     96    /// Ogre::Quaternion to std::string conversion
    9797    template <>
    9898    struct ConverterExplicit<orxonox::Quaternion, std::string>
     
    110110    };
    111111
    112     // ColourValue to std::string
     112    /// Ogre::ColourValue to std::string conversion
    113113    template <>
    114114    struct ConverterExplicit<orxonox::ColourValue, std::string>
     
    131131    ////////////////////
    132132
    133     // std::string to Vector2
     133    /// std::string to Ogre::Vector2 conversion
    134134    template <> struct _UtilExport ConverterFallback<std::string, orxonox::Vector2>
    135135    { static bool convert(orxonox::Vector2*     output, const std::string& input); };
    136     // std::string to Vector3
     136    /// std::string to Ogre::Vector3 conversion
    137137    template <> struct _UtilExport ConverterFallback<std::string, orxonox::Vector3>
    138138    { static bool convert(orxonox::Vector3*     output, const std::string& input); };
    139     // std::string to Vector4
     139    /// std::string to Ogre::Vector4 conversion
    140140    template <> struct _UtilExport ConverterFallback<std::string, orxonox::Vector4>
    141141    { static bool convert(orxonox::Vector4*     output, const std::string& input); };
    142     // std::string to Quaternion
     142    /// std::string to Ogre::Quaternion conversion
    143143    template <> struct _UtilExport ConverterFallback<std::string, orxonox::Quaternion>
    144144    { static bool convert(orxonox::Quaternion*  output, const std::string& input); };
    145     // std::string to ColourValue
     145    /// std::string to Ogre::ColourValue conversion
    146146    template <> struct _UtilExport ConverterFallback<std::string, orxonox::ColourValue>
    147147    { static bool convert(orxonox::ColourValue* output, const std::string& input); };
     
    152152    ///////////////////////////////
    153153
    154     // From Radian
     154    /// Delegates conversions from Radian to conversions from float
    155155    template <class ToType>
    156156    struct ConverterFallback<orxonox::Radian, ToType>
     
    162162    };
    163163
    164     // From Degree
     164    /// Delegates conversions from Degree to conversions from float
    165165    template <class ToType>
    166166    struct ConverterFallback<orxonox::Degree, ToType>
     
    172172    };
    173173
    174     // To Radian
     174    /// Delegates conversions to Radian to conversions to float
    175175    template <class FromType>
    176176    struct ConverterFallback<FromType, orxonox::Radian>
     
    189189    };
    190190
    191     // To Degree
     191    /// Delegates conversions to Degree to conversions to float
    192192    template <class FromType>
    193193    struct ConverterFallback<FromType, orxonox::Degree>
Note: See TracChangeset for help on using the changeset viewer.