Merge "Added new method to the NotificationManager Interface" into tizen_2.2

[platform/framework/native/appfw.git] / inc / FBaseDoubleMatrix4.h

diff --git a/inc/FBaseDoubleMatrix4.h b/inc/FBaseDoubleMatrix4.h
index 8dccc11..98298bd 100644 (file)
--- a/inc/FBaseDoubleMatrix4.h
+++ b/inc/FBaseDoubleMatrix4.h
@@ -45,7 +45,7 @@ class _OSP_EXPORT_ DoubleMatrix4
 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
         */
@@ -56,7 +56,7 @@ public:
         *
         * @since 2.0
         *
-        * @param[in]   rhs     An instance of %DoubleMatrix4
+        * @param[in]   rhs     An instance of %DoubleMatrix4 to copy
         */
        DoubleMatrix4(const DoubleMatrix4& rhs);
 
@@ -81,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 %DoubleMatrix4
         */
@@ -92,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 %DoubleMatrix4
         */
@@ -103,7 +103,7 @@ public:
         *
         * @since 2.0
         *
-        * @return              The reference to this instance
+        * @return              A reference to this instance
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4& operator =(const DoubleMatrix4& rhs);
@@ -113,8 +113,8 @@ public:
         *
         * @since 2.0
         *
-        * @return              The reference to this instance
-        * @param[in]   value   A @c double value to assign
+        * @return              A reference to this instance
+        * @param[in]   value   The @c double value to assign
         */
        DoubleMatrix4& operator =(double value);
 
@@ -123,58 +123,58 @@ public:
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4 operator *(const DoubleMatrix4& rhs) const;
 
        /**
-        * Multiplies the value to each matrix members of current instance of %DoubleMatrix4.
+        * Multiplies the value to each matrix member of current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to multiply
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to multiply
         */
        DoubleMatrix4 operator *(double value) const;
 
        /**
-        * Adds the value of the specified instance and the current instance of %DoubleMatrix4.
+        * Adds the value of the specified instance to the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4 operator +(const DoubleMatrix4& rhs) const;
 
        /**
-        * Adds the value to each matrix members of current instance of %DoubleMatrix4.
+        * Adds the value to each matrix member of the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to add
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to add
         */
        DoubleMatrix4 operator +(double value) const;
 
        /**
-        * Subtracts the value of the specified instance and the current instance of %DoubleMatrix4.
+        * Subtracts the value of the specified instance from the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4 operator -(const DoubleMatrix4& rhs) const;
 
        /**
-        * Subtracts the value from each matrix members of current instance of %DoubleMatrix4.
+        * Subtracts the value from each matrix member of the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to subtract
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to subtract
         */
        DoubleMatrix4 operator -(double value) const;
 
@@ -183,18 +183,18 @@ public:
         *
         * @since 2.0
         *
-        * @return              The reference to %DoubleMatrix4 containing the resulting value of the operation
+        * @return              The reference to %DoubleMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4& operator *=(const DoubleMatrix4& rhs);
 
        /**
-        * Multiplies the value to each matrix members of current instance of %DoubleMatrix4.
+        * Multiplies the value to each matrix member of the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              The reference to %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to multiply
+        * @return              A reference to %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to multiply
         */
        DoubleMatrix4& operator *=(double value);
 
@@ -203,18 +203,18 @@ public:
         *
         * @since 2.0
         *
-        * @return              The reference to %DoubleMatrix4 containing the resulting value of the operation
+        * @return              A reference to %DoubleMatrix4 that contains the resulting value of the operation
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4& operator +=(const DoubleMatrix4& rhs);
 
        /**
-        * Adds the value to each matrix members of current instance of %DoubleMatrix4.
+        * Adds the value to each matrix member of the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              The reference to %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to add
+        * @return              A reference to %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to add
         */
        DoubleMatrix4& operator +=(double value);
 
@@ -223,51 +223,51 @@ public:
         *
         * @since 2.0
         *
-        * @return              The reference to %DoubleMatrix4 containing the resulting value of the operation
+        * @return              A reference to %DoubleMatrix4 cthat contains the resulting value of the operation
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        DoubleMatrix4& operator -=(const DoubleMatrix4& rhs);
 
        /**
-        * Subtracts the value from each matrix members of current instance of %DoubleMatrix4.
+        * Subtracts the value from each matrix member of the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              The reference to %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to subtract
+        * @return              A reference to %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to subtract
         */
        DoubleMatrix4& operator -=(double value);
 
        /**
-        * Gets the instance of %DoubleMatrix4 resulting from the sum of the value and the specified instance of %DoubleMatrix4.
+        * Gets an instance of %DoubleMatrix4 resulting from the sum of the value and the specified instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to add
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to add
         * @param[in]   rhs     An instance of %DoubleMatrix4
         */
        _OSP_EXPORT_ friend DoubleMatrix4 operator +(const double& value, const DoubleMatrix4& rhs);
 
        /**
-        * Gets the instance of %DoubleMatrix4 resulting from the product of the value and the specified instance of %DoubleMatrix4.
+        * Gets an instance of %DoubleMatrix4 resulting from the product of the value and the specified instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to multiply
-        * @param[in]   rhs     An instance of %DoubleMatrix4
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to multiply
+        * @param[in]   rhs             An instance of %DoubleMatrix4
         */
        _OSP_EXPORT_ friend DoubleMatrix4 operator *(const double& value, const DoubleMatrix4& rhs);
 
        /**
-        * Gets the instance of %DoubleMatrix4 resulting from the difference between the value and the specified instance of %DoubleMatrix4.
+        * Gets an instance of %DoubleMatrix4 resulting from the difference between the value and the specified instance of %DoubleMatrix4.
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @param[in]   value   A @c double value to subtract
-        * @param[in]   rhs     An instance of %DoubleMatrix4
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @param[in]   value   The @c double value to subtract
+        * @param[in]   rhs             An instance of %DoubleMatrix4
         */
        _OSP_EXPORT_ friend DoubleMatrix4 operator -(const double& value, const DoubleMatrix4& rhs);
 
@@ -279,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 %DoubleMatrix4
-        * @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;
 
@@ -289,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;
 
@@ -308,8 +310,8 @@ public:
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
-        * @remarks             This function must be called after checking whether the matrix is invertible or not.
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
+        * @remarks             This method must be called after checking whether the matrix is invertible or not.
         */
        DoubleMatrix4 GetInverse(void) const;
 
@@ -327,7 +329,7 @@ public:
         *
         * @since 2.0
         *
-        * @return              A new instance of %DoubleMatrix4 containing the resulting value of the operation
+        * @return              A new instance of %DoubleMatrix4 that contains the resulting value of the operation
         */
        DoubleMatrix4 GetTranspose(void) const;
 
@@ -352,7 +354,7 @@ public:
        bool IsInvertible(void) const;
 
        /**
-        * Negates the matrix members of current instance of %DoubleMatrix4.
+        * Negates the matrix members of the current instance of %DoubleMatrix4.
         *
         * @since 2.0
         */
@@ -371,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);
@@ -384,7 +386,7 @@ public:
        void Transpose(void);
 
        /**
-        * Sets the matrix members of current instance of %DoubleMatrix4 to zero.
+        * Sets the matrix members of the current instance of %DoubleMatrix4 to zero.
         *
         * @since 2.0
         */
@@ -405,4 +407,4 @@ private:
 
 }; // DoubleMatrix4
 }} // Tizen::Base
-#endif //_FBASE_DOUBLE_MATRIX4_H_
\ No newline at end of file
+#endif //_FBASE_DOUBLE_MATRIX4_H_