From: dahyeong.kim Date: Fri, 19 Apr 2013 10:49:02 +0000 (+0900) Subject: Merge reviewed_inc X-Git-Tag: accepted/tizen_2.1/20130425.034849~1^2~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=07744f597c745d14286c4073d14ae6cd29791feb;p=platform%2Fframework%2Fnative%2Fappfw.git Merge reviewed_inc Change-Id: I7b158c09d21f3c59deec245e29b522cd3a6e9ecf Signed-off-by: dahyeong.kim --- diff --git a/inc/FBaseColAllElementsDeleter.h b/inc/FBaseColAllElementsDeleter.h index 8479699..70a9414 100644 --- a/inc/FBaseColAllElementsDeleter.h +++ b/inc/FBaseColAllElementsDeleter.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Base { namespace Collection * @struct AllElementsDeleter * @brief This function object provides a resource clean-up function for collection. * - * This can be used with unique_ptr as a custom deleter. + * The %AllElementsDeleter struct provides a resource clean-up function for collection. This can be used with unique_ptr as a custom deleter. * * @since 2.0 */ diff --git a/inc/FBaseColArrayList.h b/inc/FBaseColArrayList.h index eef2c9c..d9dd5f5 100644 --- a/inc/FBaseColArrayList.h +++ b/inc/FBaseColArrayList.h @@ -595,10 +595,10 @@ public: virtual int GetHashCode(void) const; /** - * Distinguish between ArrayList and LinkedList. + * Distinguish between %ArrayList and LinkedList. * * @since 2.0 - * @return @c true if it is an ArrayList, @n + * @return @c true if it is an %ArrayList, @n * else @c false if it is a LinkedList */ virtual bool IsRandomAccessible(void) const diff --git a/inc/FBaseColHashMap.h b/inc/FBaseColHashMap.h index 8b011a6..f61193c 100644 --- a/inc/FBaseColHashMap.h +++ b/inc/FBaseColHashMap.h @@ -431,7 +431,7 @@ private: HashMap& operator =(const HashMap& map); /** - * Copies all the pairs from the specified @c map to this map + * Copies all the pairs from the specified @c map to this map. * * @return An error code * @param[in] map The map to copy diff --git a/inc/FBaseColICollection.h b/inc/FBaseColICollection.h index 1570f45..11bf51b 100644 --- a/inc/FBaseColICollection.h +++ b/inc/FBaseColICollection.h @@ -43,7 +43,7 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface ICollection - * @brief This interface represents a collection of objects. + * @brief This interface represents a collection of objects. @n * It defines the size, enumerators, and the synchronization mechanism of a collection. * * @since 2.0 diff --git a/inc/FBaseColIMap.h b/inc/FBaseColIMap.h index a6939a8..c5b161d 100644 --- a/inc/FBaseColIMap.h +++ b/inc/FBaseColIMap.h @@ -103,7 +103,7 @@ public: virtual result Add(Object* pKey, Object* pValue) = 0; /** - * Checks if the key exists. If the key doesn't exist, Add() is called. Unless, SetValue() is called. + * Checks if the key exists. If the key does not exist, Add() is called. Unless, SetValue() is called. * * @since 2.0 * diff --git a/inc/FBaseColIMapEnumeratorT.h b/inc/FBaseColIMapEnumeratorT.h index 72a313c..ccc2bf3 100644 --- a/inc/FBaseColIMapEnumeratorT.h +++ b/inc/FBaseColIMapEnumeratorT.h @@ -33,7 +33,7 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IMapEnumeratorT - * @brief This interface supports simple iteration over a template-based map. + * @brief This interface supports simple iteration over a template-based map. @n * Using this method, you can only access the elements in the map. You cannot modify the elements. * * @since 2.0 diff --git a/inc/FBaseColIteratorT.h b/inc/FBaseColIteratorT.h index 9a0e3aa..9aeeed4 100644 --- a/inc/FBaseColIteratorT.h +++ b/inc/FBaseColIteratorT.h @@ -36,13 +36,16 @@ namespace Tizen { namespace Base { namespace Collection { /** * @class IteratorT - * @brief This class provides an iterator that is used to convert IList to STL containers. - * StlConverter provides static methods to get this iterator from IList. + * @brief This class provides an iterator that is used to convert IList to STL containers. @n + * StlConverter provides static methods to get this iterator from %IList. * * @since 2.1 * - * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen Collection. + * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * + * The %IteratorT class provides an iterator that is used to convert IList to STL containers. + * StlConverter provides static methods to get this iterator from IList. */ template < typename T > diff --git a/inc/FBaseColPairIteratorT.h b/inc/FBaseColPairIteratorT.h index 72a298d..3839db8 100644 --- a/inc/FBaseColPairIteratorT.h +++ b/inc/FBaseColPairIteratorT.h @@ -38,13 +38,16 @@ namespace Tizen { namespace Base { namespace Collection { /** * @class PairIteratorT - * @brief This class provides an iterator that is used to convert IMap or IMultiMap to STL containers. - * StlConverter provides static methods to get this iterator from IMap or IMultiMap. + * @brief This class provides an iterator that is used to convert IMap or IMultiMap to STL containers. @n + * StlConverter provides static methods to get this iterator from %IMap or %IMultiMap. * * @since 2.1 * * @remarks The %PairIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen Collection. * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * + * The %PairIteratorT class provides an iterator that is used to convert IMap or IMultiMap to STL containers. + * StlConverter provides static methods to get this iterator from IMap or IMultiMap. */ template < typename K, typename V > diff --git a/inc/FBaseColRandomIteratorT.h b/inc/FBaseColRandomIteratorT.h index 90baf13..d4a7951 100644 --- a/inc/FBaseColRandomIteratorT.h +++ b/inc/FBaseColRandomIteratorT.h @@ -35,13 +35,16 @@ namespace Tizen { namespace Base { namespace Collection { /** * @class RandomIteratorT - * @brief This class provides an random iterator that is used to convert IList to STL containers. - * StlConverter provides static methods to get this random iterator from IList. + * @brief This class provides a random iterator that is used to convert IList to STL containers. @n + * StlConverter provides static methods to get this random iterator from %IList. * * @since 2.1 * - * @remarks The %RandomIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen Collection. + * @remarks The %RandomIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * + * The %RandomIteratorT class provides a random iterator that is used to convert IList to STL containers. + * StlConverter provides static methods to get this random iterator from IList. */ template < typename T > diff --git a/inc/FBaseDateTime.h b/inc/FBaseDateTime.h index d8254ec..c69713b 100644 --- a/inc/FBaseDateTime.h +++ b/inc/FBaseDateTime.h @@ -344,7 +344,7 @@ public: result AddSeconds(int seconds); /** - * Adds the specified number of milliseconds to the instance of %DateTime. + * Adds a specified number of milliseconds to the instance of %DateTime. * * @since 2.1 * @@ -358,7 +358,7 @@ public: result AddMilliseconds(long long milliseconds); /** - * Adds the specified number of ticks to the instance of %DateTime. + * Adds a specified number of ticks to the instance of %DateTime. * * @since 2.1 * diff --git a/inc/FBaseDouble.h b/inc/FBaseDouble.h index d1b7e6f..fffd8a3 100644 --- a/inc/FBaseDouble.h +++ b/inc/FBaseDouble.h @@ -206,8 +206,9 @@ public: * @param[out] ret The converted numeric value * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. - * @remarks The behavior of this method is dependent on the system default locale setting. + * @remarks + * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - The behavior of this method is dependent on the system default locale setting. */ static result Parse(const String& s, double& ret); @@ -280,10 +281,11 @@ public: * @since 2.0 * * @return A string containing a Unicode representation of the value of the current instance - * @remarks If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity + * @remarks + * - If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision. - * @remarks The behavior of this method is dependent on the system default locale setting. + * - The behavior of this method is dependent on the system default locale setting. */ virtual String ToString(void) const; @@ -294,10 +296,11 @@ public: * * @return A string containing a Unicode representation of the specified @c double value * @param[in] value A @c double value to convert - * @remarks If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity + * @remarks + * - If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision. - * @remarks The behavior of this method is dependent on the system default locale setting. + * - The behavior of this method is dependent on the system default locale setting. */ static String ToString(double value); diff --git a/inc/FBaseDoubleComparer.h b/inc/FBaseDoubleComparer.h index 84dc483..21d8aa7 100644 --- a/inc/FBaseDoubleComparer.h +++ b/inc/FBaseDoubleComparer.h @@ -92,8 +92,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type %Double - * @param[in] obj2 The second instance of type %Double + * @param[in] obj1 The first instance of type Double + * @param[in] obj2 The second instance of type Double * @param[out] cmp The result of comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. diff --git a/inc/FBaseErrors.h b/inc/FBaseErrors.h index 762cb8f..048da37 100644 --- a/inc/FBaseErrors.h +++ b/inc/FBaseErrors.h @@ -119,7 +119,7 @@ /** Thrown when the data is not enough to generate the processing result. */ #define E_DATA_NOT_ENOUGH (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1411)) -/** Thrown when the diplay right is violated */ +/** Thrown when the display right is violated. */ #define E_DISPLAY_RIGHT_VIOLATED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1412)) //----------------------------------------------------------------------------E diff --git a/inc/FBaseFloat.h b/inc/FBaseFloat.h index 7e2b38c..77cf05f 100644 --- a/inc/FBaseFloat.h +++ b/inc/FBaseFloat.h @@ -194,8 +194,9 @@ public: * @param[out] ret The numeric representation of the string * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. - * @remarks The behavior of this method is dependent on the system default locale setting. + * @remarks + * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - The behavior of this method is dependent on the system default locale setting. * @see Tizen::Base::Double::Parse() */ static result Parse(const String& s, float& ret); @@ -269,10 +270,11 @@ public: * @since 2.0 * * @return A string containing a Unicode representation of the value of the current instance - * @remarks If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity + * @remarks + * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision. - * @remarks The behavior of this method is dependent on the system default locale setting. + * - The behavior of this method is dependent on the system default locale setting. */ virtual String ToString(void) const; @@ -283,10 +285,11 @@ public: * * @return A string containing a Unicode representation of the specified @c float value * @param[in] value A @c float value to convert - * @remarks If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity + * @remarks + * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision. - * @remarks The behavior of this method is dependent on the system default locale setting. + * - The behavior of this method is dependent on the system default locale setting. */ static String ToString(float value); diff --git a/inc/FBaseLongLong.h b/inc/FBaseLongLong.h index 4c60e0d..a7ba82f 100644 --- a/inc/FBaseLongLong.h +++ b/inc/FBaseLongLong.h @@ -284,7 +284,7 @@ public: * * @return An error code * @param[in] s A string representing a numeric value - * @param[in] radix The radix of the string representing a unmeric value @n + * @param[in] radix The radix of the string representing a numeric value @n * It must be either 2, 8, 10 or 16. * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. diff --git a/inc/FBaseUtilScanner.h b/inc/FBaseUtilScanner.h index fa45525..05bfba9 100644 --- a/inc/FBaseUtilScanner.h +++ b/inc/FBaseUtilScanner.h @@ -112,7 +112,7 @@ public: * @param[in] encodingScheme The encoding type of the file * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND The input file does not exist. - * @exception E_IO Invalid file operation + * @exception E_IO The file operation is invalid. * @exception E_INVALID_ARG The specified encoding scheme does not exist. * @remarks The supported encoding schemes are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, KSC5601, BIG5, GB2312, Shift_JIS, and ISO-2022-jp. */ @@ -370,7 +370,8 @@ public: * @since 2.1 * @return An error code * @param[in] pattern The string to construct the pattern - * @param[out] nextTok The next token as an instance of String, or empty string if not matched + * @param[out] nextTok The next token as an instance of String, @n + * else an empty string if not matched * @exception E_SUCCESS The method is successful. * @exception E_DATA_NOT_FOUND The next token does not match to the pattern. * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. @@ -383,7 +384,8 @@ public: * @since 2.1 * @return An error code * @param[in] pattern The pattern to find. - * @param[out] nextTok The next token as an instance of String, or empty string if not matched. + * @param[out] nextTok The next token as an instance of String, @n + * else an empty string if not matched * @exception E_SUCCESS The method is successful. * @exception E_DATA_NOT_FOUND The next token does not match to the pattern. * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. @@ -548,7 +550,7 @@ public: bool HasNextLine(void) const; /** - * Sets the radix of the current instance of %Scanner to the specified @c radix + * Sets the radix of the current instance of %Scanner to the specified @c radix. * * @since 2.1 * @param[in] radix The radix to use for conversion