Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / math / matrix3.h

diff --git a/dali/public-api/math/matrix3.h b/dali/public-api/math/matrix3.h
index 683eb0f..faf82e6 100644 (file)
--- a/dali/public-api/math/matrix3.h
+++ b/dali/public-api/math/matrix3.h
@@ -59,7 +59,7 @@ public:
    * @brief Copy Constructor.
    *
    * @since_tizen 2.4
-   * @param[in] m Another 3x3 matrix
+   * @param[in] m A reference to the copied 3x3 matrix
    */
   Matrix3(const Matrix3& m);
 
@@ -90,7 +90,7 @@ public:
   /**
    * @brief Assignment Operator
    * @since_tizen 2.4
-   * @param matrix from which to copy values
+   * @param[i] matrix from which to copy values
    * @return reference to this object
    */
   Matrix3& operator=( const Matrix3& matrix );
@@ -98,8 +98,8 @@ public:
   /**
    * @brief Assignment Operator
    * @since_tizen 2.4
-   * @param matrix from which to copy values
-   * @return reference to this object
+   * @param[in] matrix A reference to the copied matrix
+   * @return A reference to this
    */
   Matrix3& operator=( const Matrix& matrix );
 
@@ -109,8 +109,8 @@ public:
    * Utilises appropriate machine epsilon values.
    *
    * @since_tizen 2.4
-   * @param [in] rhs    the Matrix to compare this to
-   * @return true if the matrices are equal
+   * @param [in] rhs The Matrix to compare this to
+   * @return True if the matrices are equal
    */
   bool operator==(const Matrix3 & rhs) const;
 
@@ -120,8 +120,8 @@ public:
    * Utilises appropriate machine epsilon values.
    *
    * @since_tizen 2.4
-   * @param [in] rhs    the Matrix to compare this to
-   * @return true if the matrices are equal
+   * @param[in] rhs The Matrix to compare this to
+   * @return True if the matrices are equal
    */
   bool operator!=(const Matrix3 & rhs) const;
 
@@ -143,23 +143,34 @@ public:
    * @brief Returns the contents of the matrix as an array of 9 floats.
    *
    * The order of the values for a matrix is:
+   *
+   * @code
+   *
    *   xAxis.x yAxis.x zAxis.x
    *   xAxis.y yAxis.y zAxis.y
    *   xAxis.z yAxis.z zAxis.z
+   *
+   * @endcode
+   *
    * @since_tizen 2.4
-   * @return the matrix contents as an array of 9 floats.
+   * @return The matrix contents as an array of 9 floats.
    */
   const float* AsFloat() const {return &mElements[0];}
 
   /**
    * @brief Returns the contents of the matrix as an array of 9 floats.
    *
+   * @code
+   *
    * The order of the values for a matrix is:
    *   xAxis.x yAxis.x zAxis.x
    *   xAxis.y yAxis.y zAxis.y
    *   xAxis.z yAxis.z zAxis.z
+   *
+   * @endcode
+   *
    * @since_tizen 2.4
-   * @return the matrix contents as an array of 9 floats.
+   * @return The matrix contents as an array of 9 floats.
    */
   float* AsFloat() {return &mElements[0];}
 
@@ -167,14 +178,14 @@ public:
    * @brief Inverts the matrix.
    *
    * @since_tizen 2.4
-   * @return true if successful
+   * @return True if successful
    */
   bool Invert();
 
   /**
    * @brief Swaps the rows to columns
    * @since_tizen 2.4
-   * @return true
+   * @return True if successful
    */
   bool Transpose();
 
@@ -182,18 +193,18 @@ public:
    * @brief Multiplies all elements of the matrix by the scale value.
    *
    * @since_tizen 2.4
-   * @param scale - the value by which to scale the whole matrix.
+   * @param[i] scale The value by which to scale the whole matrix.
    *
    */
   void Scale(float scale);
 
   /**
-   * @brief Magnitude returns the average of the absolute values of the
+   * @brief Returns the average of the absolute values of the
    * elements * 3.
    *
    * (The Magnitude of the unit matrix is therefore 1)
    * @since_tizen 2.4
-   * @return the magnitude - always positive.
+   * @return The magnitude - always positive.
    */
   float Magnitude() const;
 
@@ -205,7 +216,7 @@ public:
    * If the matrix is not invertible, then the matrix is left unchanged.
    *
    * @since_tizen 2.4
-   * @return true if the matrix is invertible, otherwise false
+   * @return True if the matrix is invertible, otherwise false
    */
   bool ScaledInverseTranspose();
 
@@ -214,9 +225,9 @@ public:
    *
    * Use this method in time critical path as it does not require temporaries
    * @since_tizen 2.4
-   * @param result of the multiplication
-   * @param lhs matrix, this can be same matrix as result
-   * @param rhs matrix, this cannot be same matrix as result
+   * @param[out] result Result of the multiplication
+   * @param[in] lhs Matrix, this can be same matrix as result
+   * @param[in] rhs Matrix, this cannot be same matrix as result
    */
   static void Multiply( Matrix3& result, const Matrix3& lhs, const Matrix3& rhs );
 
@@ -229,8 +240,8 @@ private:
  * @brief Print a 3x3 matrix.
  *
  * @since_tizen 2.4
- * @param [in] o The output stream operator.
- * @param [in] matrix The matrix to print.
+ * @param[in] o The output stream operator.
+ * @param[in] matrix The matrix to print.
  * @return The output stream operator.
  */
 DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Matrix3& matrix);