* @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
*/
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
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
/**
* @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
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
*
/**
* @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
{
/**
* @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 >
{
/**
* @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 >
{
/**
* @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 >
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
*
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
*
* @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);
* @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;
*
* @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);
* @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.
/** 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
* @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);
* @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;
*
* @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);
*
* @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.
* @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.
*/
* @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.
* @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.
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
projects / platform / framework / native / appfw.git / commitdiff