projects / platform / framework / native / appfw.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Applied reviewed header(DateTime to Uuid)
[platform/framework/native/appfw.git] / inc / FBaseFloatMatrix4.h
diff --git a/inc/FBaseFloatMatrix4.h b/inc/FBaseFloatMatrix4.h
index faac984..d2ed6ef 100644 (file)
--- a/inc/FBaseFloatMatrix4.h
+++ b/inc/FBaseFloatMatrix4.h
@@ -21,7 +21,6 @@
  * This header file contains the declarations of the %FloatMatrix4 class.
  *
  */
-
 #ifndef _FBASE_FLOAT_MATRIX4_H_
 #define _FBASE_FLOAT_MATRIX4_H_
 
@@ -37,7 +36,7 @@ namespace Tizen { namespace Base
  *
  * @since 2.0
  *
- * The %FloatMatrix4 class provides a @c float precision, two-dimensional matrix class.
+ * The %FloatMatrix4 class provides a @c float precision, two-dimensional matrix.
  *
  */
 class _OSP_EXPORT_ FloatMatrix4
@@ -46,7 +45,7 @@ class _OSP_EXPORT_ FloatMatrix4
 public:
        /**
         * This is the default constructor for this class. @n
-        * Constructs a 4 X 4 null matrix in which all elements are zero.
+        * Constructs a 4 X 4 null matrix in which all the elements are zero.
         *
         * @since 2.0
         */
@@ -57,7 +56,7 @@ public:
         *
         * @since 2.0
         *
-        * @param[in]   rhs     An instance of %FloatMatrix4
+        * @param[in]   rhs     An instance of %FloatMatrix4 to copy
         */
        FloatMatrix4(const FloatMatrix4& rhs);
 
@@ -71,7 +70,7 @@ public:
        FloatMatrix4(const float matrix[4][4]);
 
        /**
-        * TThis destructor overrides Tizen::Base::Object::~Object().
+        * This destructor overrides Tizen::Base::Object::~Object().
         *
         * @since 2.0
         */
@@ -82,7 +81,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n
+        * @return      @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n
         *                      else @c false
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
@@ -93,7 +92,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n
+        * @return      @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n
         *                      else @c false
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
@@ -104,8 +103,8 @@ public:
         *
         * @since 2.0
         *
-        * @return      The reference to this instance
-        * @param[in]   rhs     An instance of %FloatMatrix4
+        * @return      A reference to this instance
+        * @param[in]   rhs     An instance of %FloatMatrix4 to copy
         */
        FloatMatrix4& operator =(const FloatMatrix4& rhs);
 
@@ -114,8 +113,8 @@ public:
         *
         * @since 2.0
         *
-        * @return      The reference to this instance
-        * @param[in]   value   A @c float value to assign
+        * @return      A reference to this instance
+        * @param[in]   value   The @c float value to assign
         */
        FloatMatrix4& operator =(float value);
 
@@ -124,78 +123,78 @@ public:
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
        FloatMatrix4 operator *(const FloatMatrix4& rhs) const;
 
        /**
-        * Multiplies the value to each matrix members of current instance of %FloatMatrix4.
+        * Multiplies the value to each matrix member of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to multiply
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to multiply
         */
        FloatMatrix4 operator *(float value) const;
 
        /**
-        * Adds the value of the specified instance and the current instance of %FloatMatrix4.
+        * Adds the value of the specified instance to the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
        FloatMatrix4 operator +(const FloatMatrix4& rhs) const;
 
        /**
-        * Adds the value to each matrix members of current instance of %FloatMatrix4.
+        * Adds the value to each matrix member of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to add
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to add
         */
        FloatMatrix4 operator +(float value) const;
 
        /**
-        * Subtracts the value of the specified instance and the current instance of %FloatMatrix4.
+        * Subtracts the value of the specified instance from the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
        FloatMatrix4 operator -(const FloatMatrix4& rhs) const;
 
        /**
-        * Subtracts the value from each matrix members of current instance of %FloatMatrix4.
+        * Subtracts the value from each matrix member of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to subtract
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to subtract
         */
        FloatMatrix4 operator -(float value) const;
 
        /**
-        * Multiplies the value of the specified instance and the current instance of %FloatMatrix4.
+        * Multiplies the value of the specified instance with the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      The reference to %FloatMatrix4 containing the resulting value of the operation
+        * @return      A reference to %FloatMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
        FloatMatrix4& operator *=(const FloatMatrix4& rhs);
 
        /**
-        * Multiplies the value to each matrix members of current instance of %FloatMatrix4.
+        * Multiplies the value to each matrix member of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      The reference to %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to multiply
+        * @return      A reference to %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to multiply
         */
        FloatMatrix4& operator *=(float value);
 
@@ -204,18 +203,18 @@ public:
         *
         * @since 2.0
         *
-        * @return      The reference to %FloatMatrix4 containing the resulting value of the operation
+        * @return      A reference to %FloatMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
        FloatMatrix4& operator +=(const FloatMatrix4& rhs);
 
        /**
-        * Adds the value to each matrix members of current instance of %FloatMatrix4.
+        * Adds the value to each matrix member of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      The reference to %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to add
+        * @return      A reference to %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to add
         */
        FloatMatrix4& operator +=(float value);
 
@@ -224,51 +223,51 @@ public:
         *
         * @since 2.0
         *
-        * @return      The reference to %FloatMatrix4 containing the resulting value of the operation
+        * @return      A reference to %FloatMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %FloatMatrix4
         */
        FloatMatrix4& operator -=(const FloatMatrix4& rhs);
 
        /**
-        * Subtracts the value from each matrix members of current instance of %FloatMatrix4.
+        * Subtracts the value from each matrix member of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      The reference to %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to subtract
+        * @return      A reference to %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to subtract
         */
        FloatMatrix4& operator -=(float value);
 
        /**
-        * Gets the instance of %FloatMatrix4 resulting from the sum of the value and the specified instance of %FloatMatrix4.
+        * Gets an instance of %FloatMatrix4 resulting from the sum of the value and the specified instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to add
-        * @param[in]   rhs     An instance of %FloatMatrix4
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to add
+        * @param[in]   rhs             An instance of %FloatMatrix4
         */
        _OSP_EXPORT_ friend FloatMatrix4 operator +(const float& value, const FloatMatrix4& rhs);
 
        /**
-        * Gets the instance of %FloatMatrix4 resulting from the product of the value and the specified instance of %FloatMatrix4.
+        * Gets an instance of %FloatMatrix4 resulting from the product of the value and the specified instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to multiply
-        * @param[in]   rhs     An instance of %FloatMatrix4
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c float value to multiply
+        * @param[in]   rhs             An instance of %FloatMatrix4
         */
        _OSP_EXPORT_ friend FloatMatrix4 operator *(const float& value, const FloatMatrix4& rhs);
 
        /**
-        * Gets the instance of %FloatMatrix4 resulting from the difference between the value and the specified instance of %FloatMatrix4.
+        * Gets an instance of %FloatMatrix4 resulting from the difference between the value and the specified instance of %FloatMatrix4.
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c float value to subtract
-        * @param[in]   rhs     An instance of %FloatMatrix4
+        * @return      A new instance of %FloatMatrix4 that containsg the resulting value of the operation
+        * @param[in]   value   The @c float value to subtract
+        * @param[in]   rhs             An instance of %FloatMatrix4
         */
        _OSP_EXPORT_ friend FloatMatrix4 operator -(const float& value, const FloatMatrix4& rhs);
 
@@ -280,7 +279,9 @@ public:
         * @return      @c true if the values of the current instance is equal to the value of the specified instance, @n
         *                      else @c false
         * @param[in]   obj     An instance of %FloatMatrix4
-        * @remarks     This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances.
+        * @remarks
+        *                              - This method overrides Tizen::Base::Object::Equals(). 
+        *                              - This method uses the values of the Matrix components to compare the two instances.
         */
        virtual bool Equals(const Tizen::Base::Object& obj) const;
 
@@ -290,8 +291,8 @@ public:
         * @since 2.0
         *
         * @return      The hash value of the current instance
-        * @remarks     Two equal instances must return the same hash value. For better performance,
-        *                              the used hash function must generate a random distribution for all inputs.
+        * @remarks     Two equal instances must return the same hash value. @n
+        *                      For better performance, the used hash function must generate a random distribution for all the inputs.
         */
        virtual int GetHashCode(void) const;
 
@@ -309,7 +310,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
         * @remarks     This function must be called after checking whether the matrix is invertible or not.
         */
        FloatMatrix4 GetInverse(void) const;
@@ -328,7 +329,7 @@ public:
         *
         * @since 2.0
         *
-        * @return      A new instance of %FloatMatrix4 containing the resulting value of the operation
+        * @return      A new instance of %FloatMatrix4 that contains the resulting value of the operation
         */
        FloatMatrix4 GetTranspose(void) const;
 
@@ -353,7 +354,7 @@ public:
        bool IsInvertible(void) const;
 
        /**
-        * Negates the matrix members of current instance of %FloatMatrix4.
+        * Negates the matrix members of the current instance of %FloatMatrix4.
         *
         * @since 2.0
         */
@@ -372,7 +373,7 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS                       The method is successful.
         * @exception   E_INVALID_OPERATION     The current instance is not invertible.
         */
        result Invert(void);
@@ -385,7 +386,7 @@ public:
        void Transpose(void);
 
        /**
-        * Sets the matrix members of current instance of %FloatMatrix4 to zero.
+        * Sets the matrix members of the current instance of %FloatMatrix4 to zero.
         *
         * @since 2.0
         */
Domain: App Framework / Uncategorized;