*
* @since 2.0
*
- * @param[in] value An instance of TimeSpan
+ * @param[in] value An instance of TimeSpan
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c value is outside the valid range defined by the method.
+ * - The resulting value of %DateTime is greater than the value returned by GetMaxValue().
+ * - The resulting value of %DateTime is less than the value returned by GetMinValue().
*/
result SetValue(const TimeSpan& value);
void SetValue(const DateTime& value);
/**
- * Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, and @c second.
+ * Sets the current instance of %DateTime to the specified year, month, day, hour, minute, and second.
*
* @since 2.0
*
* @param[in] minute The minute set
* @param[in] second The second to set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * Either the arguments are greater than the value returned by GetMaxValue() or
- * are less than the value returned by GetMinValue(), or
- * the arguments contain invalid values.
- * For example, day is 31 when month is 2.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the arguments is outside the valid range defined by the method.
+ * - Either the arguments are greater than the value returned by GetMaxValue() or
+ * less than the value returned by GetMinValue().
+ * - The arguments contain invalid values,
+ * for example, @c day is @c 31 when @c month is @c 2.
*/
result SetValue(int year, int month, int day, int hour = 0, int minute = 0, int second = 0);
/**
- * Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, @c second, and @c millisecond.
+ * Sets the current instance of %DateTime to the specified year, month, day, hour, minute, second, and millisecond.
*
* @since 2.1
*
* @param[in] second The second to set
* @param[in] millisecond The millisecond to set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * Either the arguments are greater than the value returned by GetMaxValue() or
- * are less than the value returned by GetMinValue(), or
- * the arguments contain invalid values.
- * For example, day is 31 when month is 2.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the arguments is outside the valid range defined by the method.
+ * - Either the arguments are greater than the value returned by GetMaxValue() or
+ * less than the value returned by GetMinValue().
+ * - The arguments contain invalid values,
+ * for example, @c day is @c 31 when @c month is @c 2.
*/
result SetValue(int year, int month, int day, int hour, int minute, int second, int millisecond);
/**
- * Sets the current instance of %DateTime with the specified number of %ticks.
+ * Sets the current instance of %DateTime with the specified number of ticks.
* The tick value of type @c long @c long represents dates and times ranging from January 1, 1 A.D. 00:00:00.000 am.
*
* @since 2.1
*
* @return An error code
- * @param[in] ticks The number of ticks
+ * @param[in] ticks The number of ticks
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
- * Either the arguments are greater than the value returned by GetMaxValue() or
- * are less than the value returned by GetMinValue(), or
- * the arguments contain invalid values.
- * For example, day is 31 when month is 2.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the arguments is outside the valid range defined by the method.
+ * - Either the arguments are greater than the value returned by GetMaxValue() or
+ * less than the value returned by GetMinValue().
+ * - The arguments contain invalid values,
+ * for example, @c day is @c 31 when @c month is @c 2.
*/
result SetValue(long long ticks);
* @since 2.0
*
* @return A reference to the current object
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to copy
*/
DateTime& operator =(const DateTime& rhs);
*
* @return @c true if the current instance is equivalent to the specified instance, @n
* else @c false
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to compare
*/
bool operator ==(const DateTime& rhs) const;
*
* @return @c true if the current instance is not equivalent to the specified instance, @n
* else @c false
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to compare
*/
bool operator !=(const DateTime& rhs) const;
*
* @return @c true if the value of the current instance is less than the value of the specified instance, @n
* else @c false
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to compare
*/
bool operator <(const DateTime& rhs) const;
*
* @return @c true if the value of the current instance is greater than the value of the specified instance, @n
* else @c false
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to compare
*/
bool operator >(const DateTime& rhs) const;
*
* @return @c true if the value of the current instance is less than or equal to the value of the specified instance, @n
* else @c false
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to compare
*/
bool operator <=(const DateTime& rhs) const;
*
* @return @c true if the value of the current instance is greater than or equal to the value of the specified instance, @n
* else @c false
- * @param[in] rhs An instance of %DateTime
+ * @param[in] rhs An instance of %DateTime to compare
*/
bool operator >=(const DateTime& rhs) const;
* @return An error code
* @param[in] t The time span to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result Add(const TimeSpan& t);
* @return An error code
* @param[in] days The number of days to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddDays(int days);
* @return An error code
* @param[in] hours The number of hours to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddHours(int hours);
* @return An error code
* @param[in] minutes The number of minutes to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddMinutes(int minutes);
* @return An error code
* @param[in] months The number of months to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * or less than the value returned by GetMinValue().
*/
result AddMonths(int months);
* @return An error code
* @param[in] seconds The number of seconds to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddSeconds(int seconds);
/**
- * Adds a specified number of milliseconds to the instance of %DateTime.
+ * Adds the specified number of milliseconds to the instance of %DateTime.
*
* @since 2.1
*
* @return An error code
* @param[in] milliseconds The number of milliseconds to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddMilliseconds(long long milliseconds);
/**
- * Adds a specified number of ticks to the instance of %DateTime.
+ * Adds the specified number of ticks to the instance of %DateTime.
*
* @since 2.1
*
* @return An error code
* @param[in] ticks The number of ticks to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddTicks(long long ticks);
* @return An error code
* @param[in] years The number of years to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result AddYears(int years);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of @c dt1 is less than the value of @c dt2
- * == 0 if the value of @c dt1 is equal to the value of @c dt2
- * > 0 if the value of @c dt1 is greater than the value of @c dt2
+ * < 0 if the value of dt1 is less than the value of dt2
+ * == 0 if the value of dt1 is equal to the value of dt2
+ * > 0 if the value of dt1 is greater than the value of dt2
* @endcode
* @param[in] dt1 An instance of %DateTime
* @param[in] dt2 An instance of %DateTime
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of the current instance is less than value of the specified instance
* == 0 if the value of the current instance is equal to value of the specified instance
TimeSpan GetTimeOfDay(void) const;
/**
- * Gets the number of @c days in the specified @c month of the specified @c year.
+ * Gets the number of days in the specified month of the specified year.
*
* @since 2.0
*
* @param[in] month The month
* @param[out] days The number of days
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * @c year must be a value between @c 1 and @c 9999 and @c month must be a value between @c 1 and @c 12.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The specified @c year must be a value between @c 1 and @c 9999 and @c month must be a value between @c 1 and @c 12.
*/
static result GetDaysInMonth(int year, int month, int& days);
* @since 2.0
*
* @return An error code
- * @param[in] t The time span to deduct
+ * @param[in] t The time span to subtract
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n
- * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
- * is less than the value returned by GetMinValue().
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n
+ * less than the value returned by GetMinValue().
*/
result Subtract(const TimeSpan& t);
*
* @since 2.0
*
- * @return A string containing Unicode representation of the value of the current instance of %DateTime
- * @remarks The format of the String representation is "mm/dd/yyyy hh:mm:ss".
- * @remarks Use the Tizen::Locale namespace for a string of the locale-specific representation.
+ * @return The string that contains the Unicode representation of the value of the current instance of %DateTime
+ * @remarks
+ * - The format of the String representation is "mm/dd/yyyy hh:mm:ss".
+ * - Use the Tizen::Locale namespace for a string of the locale-specific representation.
*
*/
String ToString(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] str A String representation of a date and time value
- * @param[out] dt The result of the method
+ * @param[in] str The String representation of the date and time value
+ * @param[out] dt The result of the method
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is in an invalid format.
- * @exception E_OUT_OF_RANGE The specified string contains an invalid value. @n
- * 1) The resulting value of %DateTime is greater than the value returned by GetMaxValue()
- * or is less than the value returned by GetMinValue(). @n
- * 2) The specified string contains an invalid value.
- * For example, day is 31 when the month is 2.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified string contains an invalid value.
+ * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue()
+ * or less than the value returned by GetMinValue().
+ * - The specified string contains an invalid value,
+ * for example, @c day is @c 31 when the @c month is @c 2.
* @remarks
* - The format of the string is "mm/dd/yyyy hh:mm:ss".
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& str, DateTime& dt);
*
* @since 2.0
*
- * @return An integer value indicating the year of the current instance of %DateTime
+ * @return The integer value that indicates the year of the current instance of %DateTime
*/
int GetYear(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the month of the current instance of %DateTime
+ * @return The integer value that indicates the month of the current instance of %DateTime
*/
int GetMonth(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the day of the current instance of %DateTime
+ * @return The integer value that indicates the day of the current instance of %DateTime
*/
int GetDay(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the hour of the current instance of %DateTime
+ * @return The integer value that indicates the hour of the current instance of %DateTime
*/
int GetHour(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the minute of the current instance of %DateTime
+ * @return The integer value that indicates the minute of the current instance of %DateTime
*/
int GetMinute(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the second of the current instance of %DateTime
+ * @return The integer value that indicates the second of the current instance of %DateTime
*/
int GetSecond(void) const;
*
* @since 2.1
*
- * @return An integer value indicating the millisecond of the current instance of %DateTime
+ * @return The integer value that indicates the millisecond of the current instance of %DateTime
*/
int GetMillisecond(void) const;
/**
- * Gets the number of ticks in 1 second.
+ * Gets the number of ticks in one second.
*
* @since 2.1
*
- * @return The number of ticks in 1 second.
+ * @return The number of ticks in one second.
*/
static int GetTicksPerSecond(void);
*
* @since 2.1
*
- * @return A @c long @c long value indicating the tick of the current instance of %DateTime
+ * @return The @c long @c long value that indicates the tick of the current instance of %DateTime
*/
long long GetTicks(void) const;
bool IsLeapYear(void) const;
/**
- * Checks whether the specified @c year is a leap year.
+ * Checks whether the specified year is a leap year.
*
* @since 2.0
*
}; // DateTime
}} // Tizen::Base
-#endif // _FBASE_DATE_TIME_H_
\ No newline at end of file
+#endif // _FBASE_DATE_TIME_H_
* @file FBaseDouble.h
* @brief This is the header file for the %Double class.
*
- * @see Tizen::Base::Number
- *
* This header file contains the declarations of the %Double class.
+ *
+ * @see Tizen::Base::Number
*/
#ifndef _FBASE_DOUBLE_H_
#define _FBASE_DOUBLE_H_
* 1.79769313486232e308 to positive 1.79769313486232e308. This class is useful when passing a @c double
* value to a method expecting an instance of Object, such as Tizen::Base::Collection::Queue or
* Tizen::Base::Collection::Stack. Furthermore, this class provides methods for converting
- * %Double (and @c double) to String, and String to %Double (and @c double).
+ * %Double (and @c double) to String, and %String to %Double (and @c double).
*
* The following example demonstrates how to use the %Double class.
*
*
* @since 2.0
*
- * @param[in] value A @c double value
+ * @param[in] value The @c double value
*/
Double(double value = 0.0L);
*
* @since 2.0
*
- * @param[in] value An instance of %Double
+ * @param[in] value An instance of %Double to copy
*/
Double(const Double& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Double
+ * @param[in] rhs An instance of %Double to copy
*/
Double& operator =(const Double& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of @c d1 is less than the value of @c d2
- * == 0 if the value of @c d1 is equal to the value of @c d2
- * > 0 if the value of @c d1 is greater than the value of @c d2
+ * < 0 if the value of d1 is less than the value of d2
+ * == 0 if the value of d1 is equal to the value of d2
+ * > 0 if the value of d1 is greater than the value of d2
* @endcode
* @param[in] d1 The first @c double value to compare
* @param[in] d2 The second @c double value to compare
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of the current instance is less than the specified @c signed @c double
- * == 0 if the value of the current instance is equal to the specified @c signed @c double
- * > 0 if the value of the current instance is greater than the specified @c signed @c double
+ * < 0 if the value of the current instance is less than the specified signed double
+ * == 0 if the value of the current instance is equal to the specified signed double
+ * > 0 if the value of the current instance is greater than the specified signed double
* @endcode
* @param[in] value A @c signed @c double value
*/
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
*
* @since 2.0
*
- * @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Double, @n
+ * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Double, @n
* else @c false
* @param[in] obj An instance of Object to compare
- * @see Tizen::Base::Object::Equals
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Double
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Double
+ * @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.
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c double value.
- *
- * @since 2.0
- *
- * @return An integer value indicating the hash value of the specified @c double value
- * @param[in] val A @c double value to get the hash value
- */
+ * Gets the hash value of the specified @c double value.
+ *
+ * @since 2.0
+ *
+ * @return The integer value that indicates the hash value of the specified @c double value
+ * @param[in] val The @c double value to get the hash value
+ */
static int GetHashCode(double val);
/**
- * Parses the specified string representing a numeric value and returns the value as @c signed @c double (as out parameter).
+ * Parses the specified string that represents a numeric value and returns the value as @c signed @c double (as out parameter).
*
* @since 2.0
*
* @return An error code
- * @param[in] s A unicode representation of @c signed @c double value
+ * @param[in] s The unicode representation of @c signed @c double value
* @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.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an 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 @c signed @c char equivalent of the current instance
+ * @return The @c signed @c char equivalent of the current instance
*/
virtual char ToChar(void) const;
*
* @since 2.0
*
- * @return A @c signed @c short equivalent of the current instance
+ * @return The @c signed @c short equivalent of the current instance
*/
virtual short ToShort(void) const;
*
* @since 2.0
*
- * @return A @c signed @c int equivalent of the current instance
+ * @return The @c signed @c int equivalent of the current instance
*/
virtual int ToInt(void) const;
*
* @since 2.0
*
- * @return A @c signed @c long equivalent of the current instance
+ * @return The @c signed @c long equivalent of the current instance
*/
virtual long ToLong(void) const;
*
* @since 2.0
*
- * @return A @c signed @c long @c long equivalent of the current instance
+ * @return The @c signed @c long @c long equivalent of the current instance
*/
virtual long long ToLongLong(void) const;
*
* @since 2.0
*
- * @return A @c signed @c float equivalent of the current instance
+ * @return The @c signed @c float equivalent of the current instance
*/
virtual float ToFloat(void) const;
*
* @since 2.0
*
- * @return A @c signed @c double equivalent of the current instance
+ * @return The @c signed @c double equivalent of the current instance
*/
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of %Double.
+ * Gets the string that represents the value of the current instance of %Double.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the value of the current instance
+ * @return The string that contains the 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
* produces the result "Infinity". @n
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c double value.
+ * Gets the string that represents the specified @c double value.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c double value
- * @param[in] value A @c double value to convert
+ * @return The string that contains the Unicode representation of the specified @c double value
+ * @param[in] value The @c double value to convert
* @remarks
* - If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity
* produces the result "Infinity". @n
* @since 2.0
*
* @return The bits that represent the floating-point number in the IEEE 754 floating-point "double format" bit layout
- * @param[in] value A @c double value to convert
+ * @param[in] value The @c double value to convert
*/
static long long ToBits(double value);
static double ToDoubleFromBits(long long value);
/**
- * Checks whether the current value of %Double is equal to negative or positive infinity.
+ * Checks whether the current value of %Double is equal to the negative or positive infinity.
*
* @since 2.0
*
- * @return @c true if the current value equals negative or positive infinity, @n
+ * @return @c true if the current value equals the negative or positive infinity, @n
* else @c false
*/
bool IsInfinity(void) const;
/**
- * Checks whether the specified @c double value is equal to negative or positive infinity.
+ * Checks whether the specified @c double value is equal to the negative or positive infinity.
*
* @since 2.0
*
- * @return @c true if the specified value equals negative or positive infinity, @n
+ * @return @c true if the specified value equals the negative or positive infinity, @n
* else @c false
- * @param[in] value A @c double value to check
+ * @param[in] value The @c double value to check
*/
static bool IsInfinity(double value);
*
* @return @c true if the specified value is Not-a-Number, @n
* else @c false
- * @param[in] value A @c double value to check
+ * @param[in] value The @c double value to check
*/
static bool IsNaN(double value);
/**
- * Gets a constant holding the largest positive finite value of type @c double. @n
+ * Gets the constant holding the largest positive finite value of type @c double. @n
* This is equal to the value defined in Limit.h of the C library.
*
* @since 2.0
*
- * @return A constant holding the largest positive finite value of type @c double
+ * @return The constant holding the largest positive finite value of type @c double
*/
static double GetMaxValue(void);
/**
- * Gets a constant holding the smallest positive non-zero value of type @c double. @n
+ * Gets the constant holding the smallest positive non-zero value of type @c double. @n
* This is equal to the value defined in Limit.h of the C library.
*
* @since 2.0
*
- * @return A constant holding the smallest possible non-zero value of type @c double
+ * @return The constant holding the smallest possible non-zero value of type @c double
*/
static double GetMinValue(void);
/**
- * A @c double value of this instance.
+ * The @c double value of this instance.
*
* @since 2.0
*/
}; // Double
}} // Tizen::Base
-#endif //_FBASE_DOUBLE_H_
\ No newline at end of file
+#endif //_FBASE_DOUBLE_H_
* @file FBaseDoubleComparer.h
* @brief This is the header file for the %DoubleComparer class.
*
- * @see Double and Tizen::Base::Collection::IComparer
- *
* This header file contains the declarations of the %DoubleComparer class.
+ *
+ * @see Double
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_DOUBLE_COMPARER_H_
#define _FBASE_DOUBLE_COMPARER_H_
{
/**
* @class DoubleComparer
- * @brief This class checks for equivalence between 2 instances of the %Double type.
+ * @brief This class checks for equivalence between two instances of the %Double type.
*
* @since 2.0
*
- * The %DoubleComparer class checks for equivalence between 2 instances of the Double type.
+ * The %DoubleComparer class checks for equivalence between two instances of the Double type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @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[out] cmp The result of comparison
+ * @param[in] obj1 The first instance of type Double
+ * @param[in] obj2 The second instance of type Double
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
*
* @since 2.0
*
- * The %DoubleMatrix class provides a @c double precision, two-dimensional matrix class.
+ * The %DoubleMatrix class provides a @c double precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ DoubleMatrix
*
* @since 2.0
*
- * @param[in] rhs An instance of %DoubleMatrix
+ * @param[in] rhs An instance of %DoubleMatrix to copy
*/
DoubleMatrix(const DoubleMatrix& rhs);
/**
- * Constructs a row by column null matrix in which all elements are zero.
+ * Constructs a row by column null matrix in which all the elements are zero.
*
* @since 2.0
*
*
* @param[in] rowCount The number of rows in the current instance
* @param[in] columnCount The number of columns in the current instance
- * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length.
+ * @param[in] pArray The one-dimensional array @n
+ * The array must be at least row * column in length.
* @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
* else @c copy in column-major order
*/
*
* @param[in] rowCount The number of rows in the current instance
* @param[in] columnCount The number of columns in the current instance
- * @param[in] pArray[] A two-dimensional array @n The array must be at least row * column in length.
+ * @param[in] pArray[] The two-dimensional array @n
+ * The array must be at least row * column in length.
*/
DoubleMatrix(int rowCount, int columnCount, const double* pArray[]);
*
* @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 %DoubleMatrix
*/
*
* @since 2.0
*
- * @return The reference to this instance
- * @param[in] rhs An instance of %DoubleMatrix
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If either row or column count of the current instance is not same with that of the specified instance,
- * return the reference to this instance without assigning.
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %DoubleMatrix
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If either the row or the column count of the current instance is not same as that of the specified instance,
+ * this method returns the reference to this instance without assigning.
*/
DoubleMatrix& operator =(const DoubleMatrix& rhs);
*
* @since 2.0
*
- * @return @c true if the values of the current instance are equal to the value of the specified instance, @n
+ * @return @c true if the values of the current instance are equal to the values of the specified instance, @n
* else @c false
* @param[in] obj An instance of %DoubleMatrix
- * @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;
* @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;
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %DoubleMatrix
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
+ * @param[in] matrix An instance of %DoubleMatrix
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
*/
result Add(const DoubleMatrix& matrix);
/**
- * Adds the value to each matrix members of the current instance of %DoubleMatrix.
+ * Adds the value to each matrix member of the current instance of %DoubleMatrix.
*
* @since 2.0
*
- * @param[in] value A @c double value to add
+ * @param[in] value The @c double value to add
*/
void AddToEachElement(double value);
/**
- * Gets the number of column in the current instance of %DoubleMatrix.
+ * Gets the number of columns in the current instance of %DoubleMatrix.
*
* @since 2.0
*
- * @return The number of column in the current instance
+ * @return The number of columns in the current instance
*/
int GetColumnCount(void) const;
*
* @since 2.0
*
- * @return A pointer to @c double array
- * @param[in] columnIndex The target column number in the current instance
+ * @return A pointer to the @c double array
+ * @param[in] columnIndex The target column number in the current instance
* @exception E_INVALID_ARG The @c columnIndex is larger than the column count of the current instance.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return The determinant value of the current instance
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the current instance is not a square matrix, return zero.
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the current instance is not a square matrix, this method returns zero.
*/
double GetDeterminant(void) const;
* @since 2.0
*
* @return The value at the specified row and column of the current instance
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] columnIndex The target column number in the current instance
- * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance.
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] columnIndex The target column number in the current instance
+ * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
double GetElement(int rowIndex, int columnIndex) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @return A pointer to the instance of %DoubleMatrix that contains the resulting value of the operation
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
DoubleMatrix* GetInverseN(void) const;
/**
- * Gets the number of row in the current instance of %DoubleMatrix.
+ * Gets the number of rows in the current instance of %DoubleMatrix.
*
* @since 2.0
*
- * @return The number of row in the current instance
+ * @return The number of rows in the current instance
*/
int GetRowCount(void) const;
*
* @since 2.0
*
- * @return A pointer to @c double array
- * @param[in] rowIndex The target row number in the current instance
+ * @return A pointer to the @c double array
+ * @param[in] rowIndex The target row number in the current instance
* @exception E_INVALID_ARG The @c rowIndex is larger than the row count of the current instance.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An error code
- * @param[out] value A @c double value
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The @c double value
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
result GetTrace(double& value) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @return A pointer to the %DoubleMatrix instance that contains the resulting value of the operation
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
DoubleMatrix* GetTransposeN(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %DoubleMatrix
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The column count of the current instance is not same with the row count of the specified instance.
+ * @param[in] matrix An instance of %DoubleMatrix
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance.
*/
result Multiply(const DoubleMatrix& matrix);
/**
- * Multiplies the value with each matrix members of the current instance of %DoubleMatrix.
+ * Multiplies the value with each matrix member of the current instance of %DoubleMatrix.
*
* @since 2.0
*
- * @param[in] value A @c double value to multiply
+ * @param[in] value The @c double value to multiply
*/
void Multiply(double value);
* @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 a square matrix.
*/
result SetAsIdentity(void);
* @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 a square matrix.
*/
result Invert(void);
* @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 a square matrix.
*/
result Transpose(void);
* @since 2.0
*
* @return An error code
- * @param[in] columnIndex The target column number in the current instance
- * @param[in] pArray An array which includes the values @n The array must be at least row in length.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance.
+ * @param[in] columnIndex The target column number in the current instance
+ * @param[in] pArray The array which includes the values @n
+ * The array must be at least row in length.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c columnIndex is larger than the column count of the current instance.
*/
result SetColumn(int columnIndex, const double* pArray);
* @since 2.0
*
* @return An error code
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] pArray An array which includes the values @n The array must be at least column in length.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance.
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] pArray The array which includes the values @n
+ * The array must be at least column in length.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c rowIndex is larger than the row count of the current instance.
*/
result SetRow(int rowIndex, const double* pArray);
* @since 2.0
*
* @return An error code
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] columnIndex The target column number in the current instance
- * @param[in] value A @c double value
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance,
- * or the @c columnIndex is larger than the column count of the current instance.
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] columnIndex The target column number in the current instance
+ * @param[in] value The @c double value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c rowIndex is larger than the row count of the current instance.
+ * - The specified @c columnIndex is larger than the column count of the current instance.
*/
result SetElement(int rowIndex, int columnIndex, double value);
/**
- * Sets the values to the current instance of %DoubleMatrix in either the row-major or column-major order.
+ * Sets the values to the current instance of %DoubleMatrix in either the row-major or the column-major order.
*
* @since 2.0
*
* @return An error code
- * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length.
- * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
- * else @c copy in column-major order
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null.
+ * @param[in] pArray The one-dimensional array @n
+ * The array must be at least row * column in length.
+ * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
+ * else @c copy in column-major order
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c pArray is @c null.
*/
result SetValue(const double* pArray, bool rowMajor = true);
/**
- * Sets the matrix members of current instance of %DoubleMatrix to zero.
+ * Sets the matrix members of the current instance of %DoubleMatrix to zero.
*
* @since 2.0
*/
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %DoubleMatrix
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
+ * @param[in] matrix An instance of %DoubleMatrix
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
*/
result Subtract(const DoubleMatrix& matrix);
/**
- * Subtracts the value from each matrix members of the current instance of %DoubleMatrix.
+ * Subtracts the value from each matrix member of the current instance of %DoubleMatrix.
*
* @since 2.0
*
- * @param[in] value A @c double value to subtract
+ * @param[in] value The @c double value to subtract
*/
void SubtractToEachElement(double value);
}; // DoubleMatrix
}} // Tizen::Base
-#endif //_FBASE_DOUBLE_MATRIX_H_
\ No newline at end of file
+#endif //_FBASE_DOUBLE_MATRIX_H_
*
* @since 2.0
*
- * The %DoubleMatrix3 class provides a @c double precision, two-dimensional matrix class.
+ * The %DoubleMatrix3 class provides a @c double precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ DoubleMatrix3
public:
/**
* This is the default constructor for this class. @n
- * Constructs a 3 X 3 null matrix in which all elements are zero.
+ * Constructs a 3 X 3 null matrix in which all the elements are zero.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @param[in] rhs An instance of %DoubleMatrix3 to copy
*/
DoubleMatrix3(const DoubleMatrix3& rhs);
*
* @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 %DoubleMatrix3
*/
*
* @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 %DoubleMatrix3
*/
*
* @since 2.0
*
- * @return The reference to this instance
+ * @return A reference to this instance
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator =(const DoubleMatrix3& rhs);
*
* @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
*/
DoubleMatrix3& operator =(double value);
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3 operator *(const DoubleMatrix3& rhs) const;
/**
- * Multiplies the value to each matrix members of current instance of %DoubleMatrix3.
+ * Multiplies the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to multiply
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to multiply
*/
DoubleMatrix3 operator *(double value) const;
/**
- * Adds the value of the specified instance and the current instance of %DoubleMatrix3.
+ * Adds the value of the specified instance to the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3 operator +(const DoubleMatrix3& rhs) const;
/**
- * Adds the value to each matrix members of current instance of %DoubleMatrix3.
+ * Adds the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to add
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to add
*/
DoubleMatrix3 operator +(double value) const;
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3 operator -(const DoubleMatrix3& rhs) const;
/**
- * Subtracts the value from each matrix members of current instance of %DoubleMatrix3.
+ * Subtracts the value from each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to subtract
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to subtract
*/
DoubleMatrix3 operator -(double value) const;
/**
- * Multiplies the value of the specified instance and the current instance of %DoubleMatrix3.
+ * Multiplies the value of the specified instance with the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator *=(const DoubleMatrix3& rhs);
/**
- * Multiplies the value to each matrix members of current instance of %DoubleMatrix3.
+ * Multiplies the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to multiply
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to multiply
*/
DoubleMatrix3& operator *=(double value);
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator +=(const DoubleMatrix3& rhs);
/**
- * Adds the value to each matrix members of current instance of %DoubleMatrix3.
+ * Adds the value to each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to add
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to add
*/
DoubleMatrix3& operator +=(double value);
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %DoubleMatrix3
*/
DoubleMatrix3& operator -=(const DoubleMatrix3& rhs);
/**
- * Subtracts the value from each matrix members of current instance of %DoubleMatrix3.
+ * Subtracts the value from each matrix member of the current instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return The reference to %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to subtract
+ * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to subtract
*/
DoubleMatrix3& operator -=(double value);
/**
- * Gets the instance of %DoubleMatrix3 resulting from the sum of the value and the specified instance of %DoubleMatrix3.
+ * Gets an instance of %DoubleMatrix3 resulting from the sum of the value and the specified instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to add
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to add
+ * @param[in] rhs An instance of %DoubleMatrix3
*/
_OSP_EXPORT_ friend DoubleMatrix3 operator +(const double& value, const DoubleMatrix3& rhs);
/**
- * Gets the instance of %DoubleMatrix3 resulting from the product of the value and the specified instance of %DoubleMatrix3.
+ * Gets an instance of %DoubleMatrix3 resulting from the product of the value and the specified instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to multiply
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to multiply
+ * @param[in] rhs An instance of %DoubleMatrix3
*/
_OSP_EXPORT_ friend DoubleMatrix3 operator *(const double& value, const DoubleMatrix3& rhs);
/**
- * Gets the instance of %DoubleMatrix3 resulting from the difference between the value and the specified instance of %DoubleMatrix3.
+ * Gets an instance of %DoubleMatrix3 resulting from the difference between the value and the specified instance of %DoubleMatrix3.
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
- * @param[in] value A @c double value to subtract
- * @param[in] rhs An instance of %DoubleMatrix3
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c double value to subtract
+ * @param[in] rhs An instance of %DoubleMatrix3
*/
_OSP_EXPORT_ friend DoubleMatrix3 operator -(const double& value, const DoubleMatrix3& rhs);
* @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 %DoubleMatrix3
- * @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;
* @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;
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 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 %DoubleMatrix3 that contains the resulting value of the operation
+ * @remarks This method must be called after checking whether the matrix is invertible or not.
*/
DoubleMatrix3 GetInverse(void) const;
*
* @since 2.0
*
- * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation
+ * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation
*/
DoubleMatrix3 GetTranspose(void) const;
bool IsInvertible(void) const;
/**
- * Negates the matrix members of current instance of %DoubleMatrix3.
+ * Negates the matrix members of the current instance of %DoubleMatrix3.
*
* @since 2.0
*/
* @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);
/**
- * Sets the transposed matrix to the current instance of %DoubleMatrix3.
+ * Sets the transposed matrix of the current instance of %DoubleMatrix3.
*
* @since 2.0
*/
void Transpose(void);
/**
- * Sets the matrix members of current instance of %DoubleMatrix3 to zero.
+ * Sets the matrix members of the current instance of %DoubleMatrix3 to zero.
*
* @since 2.0
*/
}; // DoubleMatrix3
}} // Tizen::Base
-#endif //_FBASE_DOUBLE_MATRIX3_H_
\ No newline at end of file
+#endif //_FBASE_DOUBLE_MATRIX3_H_
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
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %DoubleMatrix4
+ * @param[in] rhs An instance of %DoubleMatrix4 to copy
*/
DoubleMatrix4(const DoubleMatrix4& rhs);
*
* @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
*/
*
* @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
*/
*
* @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);
*
* @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);
*
* @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;
*
* @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);
*
* @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);
*
* @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);
* @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;
* @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;
*
* @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;
*
* @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;
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
*/
* @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);
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
*/
}; // DoubleMatrix4
}} // Tizen::Base
-#endif //_FBASE_DOUBLE_MATRIX4_H_
\ No newline at end of file
+#endif //_FBASE_DOUBLE_MATRIX4_H_
/**
* @file FBaseErrorDefine.h
- * @brief This header file defines common error codes.
+ * @brief This header file defines the common error codes.
*
- * This header file contains the definitions of error codes.
+ * This header file contains the definitions of the common error codes.
*/
#ifndef _FBASE_ERROR_DEFINE_H_
#define _FBASE_ERROR_DEFINE_H_
/**
* @file FBaseErrors.h
- * @brief This header file defines error codes.
+ * @brief This is the header file that defines the error codes.
*
- * This header file contains the definitions of error codes.
+ * This header file contains the definitions of the error codes.
*/
#ifndef _FBASE_ERRORS_H_
#define _FBASE_ERRORS_H_
#include <FBaseErrorDefine.h>
//----------------------------------------------------------------------------A
-/** (specialized) Thrown when network address is changed externally. */
+/** (specialized) Thrown when the network address is changed externally. */
#define E_ADDRESS_CHANGED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1100))
/** Thrown when the target is bounded to another source. */
/** Thrown when the required application is not installed. */
#define E_APP_NOT_INSTALLED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1105))
-/** Thrown when the specified instance is already set to other values, instances or resources. */
+/** Thrown when the specified instance is already set to other values, instances, or resources. */
#define E_ALREADY_SET (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1106))
-/** Thrown when a specified account already exists. */
+/** Thrown when the specified account already exists. */
#define E_ACCOUNT_ALREADY_EXIST (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1107))
-/** Thrown when a required account does not exist. */
+/** Thrown when the required account does not exist. */
#define E_ACCOUNT_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1108))
//----------------------------------------------------------------------------B
/** (specialized) ... */
#define E_CHUNKED_TRANSACTION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1300))
-/** Thrown when the connection is busy, so cannot process the new request. */
+/** Thrown when the connection is busy, so it cannot process the new request. */
#define E_CONNECTION_BUSY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1301))
-/** Thrown when the connection to the specific destination fails. */
+/** Thrown when the connection to a specific destination fails. */
#define E_CONNECTION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1302))
/** Thrown when the connection is reset while the other thread is still
- * working on it. */
+ * working on it. */
#define E_CONNECTION_RESET (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1303))
-/** Thrown when the token is expired. */
+/** Thrown when the token has expired. */
#define E_CREDENTIAL_EXPIRED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1304))
-/** The server certificate verification has failed. */
+/** Thrown when the server certificate verification has failed. */
#define E_CERTIFICATE_VERIFICATION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1305))
/** Thrown when the context data is not available. */
/** Thrown when the requested data does not exist. */
#define E_DATA_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1400))
-/** Thrown when underlying database system raises exception. */
+/** Thrown when the underlying database system raises an exception. */
#define E_DATABASE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1401))
-/** Thrown when decoding operation fails. */
+/** Thrown when the decoding operation fails. */
#define E_DECODING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1402))
-/** Thrown when the device is processing the previous task, so cannot process
- * the new one. */
+/** Thrown when the device is processing the previous task, so it cannot process
+ * the new one. */
#define E_DEVICE_BUSY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1403))
-/** Thrown when the device fails with unknown reason. */
+/** Thrown when the device fails due to an unknown reason. */
#define E_DEVICE_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1404))
/** Thrown when the device does not support the specific request. */
#define E_DEVICE_INCOMPATIBLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1405))
-/** Thrown when the device is not installed, or not answering at all. */
+/** Thrown when the device is not installed, or is not answering at all. */
#define E_DEVICE_UNAVAILABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1406))
/** General DHCP exception. */
/** General DNS exception. */
#define E_DNS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1409))
-/** Thrown when DNS cannot resolve the requested address. */
+/** Thrown when the DNS cannot resolve the requested address. */
#define E_DNS_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1410))
/** Thrown when the data is not enough to generate the processing result. */
#define E_DISPLAY_RIGHT_VIOLATED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1412))
//----------------------------------------------------------------------------E
-/** Thrown when effects being played on the current haptic device are disabled. */
+/** Thrown when the effects being played on the current haptic device are disabled. */
#define E_EFFECTS_DISABLED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1500))
/** Thrown when a body is empty. */
#define E_EMPTY_BODY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1501))
-/** Thrown when encoding operation fails. */
+/** Thrown when the encoding operation fails. */
#define E_ENCODING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1502))
-/** Thrown when an end of the file or an end of the stream is reached unexpectedly
- * during an input operation. */
+/** Thrown when the end of the file or the end of the stream is reached unexpectedly
+ * during an input operation. */
#define E_END_OF_FILE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1503))
//----------------------------------------------------------------------------F
-/** (specialized) Thrown when application tries to call with a number which is
- * not allowed in FDN mode, while the FDN mode is enabled. */
+/** (specialized) Thrown when the application tries to call a number which is
+ * not allowed in the FDN mode, while the FDN mode is enabled. */
#define E_FDN_MODE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1600))
-/** Thrown when an attempt to create the file denoted by a specified pathname
- * fails. */
+/** Thrown when an attempt to create the file denoted by the specified pathname
+ * fails. */
#define E_FILE_ALREADY_EXIST (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1601))
-/** Thrown when an attempt to open the file denoted by a specified pathname
+/** Thrown when an attempt to open the file denoted by the specified pathname
* fails. */
#define E_FILE_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1602))
//----------------------------------------------------------------------------G
-/** Thrown when a required group does not exist. */
+/** Thrown when the required group does not exist. */
#define E_GROUP_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1700))
//----------------------------------------------------------------------------H
-/** Thrown the destination host is not found. */
+/** Thrown when the destination host is not found. */
#define E_HOST_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1800))
/** Thrown when the destination host is unreachable. */
#define E_HOST_UNREACHABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1801))
-/** Thrown the Http transaction is canceled by user. */
+/** Thrown when the HTTP transaction is cancelled by the user. */
#define E_HTTP_USER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1802))
//----------------------------------------------------------------------------I
/** Thrown when the user does not have proper permissions. */
#define E_ILLEGAL_ACCESS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1900))
-/** Thrown when the application requests an operation which is in progress. */
+/** Thrown when the application requests for an operation which is in progress. */
#define E_IN_PROGRESS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1901))
/** Thrown when the return type is supposed to be a file path, but the path is not accessible by the application. */
/** Thrown when initialization fails. */
#define E_INIT_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1903))
-/** Thrown when an instantiation fails by certain reason. */
+/** Thrown when an instantiation fails due to a certain reason. */
#define E_INSTANTIATION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1904))
/** Thrown when the haptic device priority is lower than that of the current
* effects being played, belonging to another device instance. */
#define E_INSUFFICIENT_PRIORITY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1905))
-/** Thrown when a requested operation cannot perform any further due to an
- * interruption from other thread. */
+/** Thrown when the requested operation cannot perform any further due to an
+ * interruption from another thread. */
#define E_INTERRUPTED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1906))
-/** Thrown when an account configuration is invalid. */
+/** Thrown when the account configuration is invalid. */
#define E_INVALID_ACCOUNT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1907))
-/** Thrown when a given address is invalid or not suitable for a requested
- * operation. */
+/** Thrown when a given address is invalid or not suitable for the requested
+ * operation. */
#define E_INVALID_ADDRESS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1908))
/** Thrown when a combination of passed information is not proper for performing
- * the requested operation. */
+ * the requested operation. */
#define E_INVALID_ARG (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1909))
/** Thrown when a combination of passed information is not proper for performing
- * the requested operation. */
+ * the requested operation. */
#define E_INVALID_CONDITION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1910))
-/** Thrown when an operation requests for invalid connection. */
+/** Thrown when an operation requests for an invalid connection. */
#define E_INVALID_CONNECTION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1911))
-/** Thrown when content is invalid. */
+/** Thrown when the content is invalid. */
#define E_INVALID_CONTENT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1912))
-/** Thrown when context is invalid. */
+/** Thrown when the context is invalid. */
#define E_INVALID_CONTEXT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1913))
/** Thrown when the requested (given or referenced) data is invalid. */
#define E_INVALID_DATA (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1914))
/** (specialized) Thrown when the requested (given or referenced) domain is
- * invalid. */
+ * invalid. */
#define E_INVALID_DOMAIN (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1915))
-/** Thrown when an indicated string contains code pointing outside of bounds by the
- * specified character encoding scheme. */
+/** Thrown when an indicated string contains a code pointing outside the bounds of the
+ * specified character encoding scheme. */
#define E_INVALID_ENCODING_RANGE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1916))
-/** Thrown when the specified input has invalid format. */
+/** Thrown when the specified input has an invalid format. */
#define E_INVALID_FORMAT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1917))
-/** (specialized) Thrown when */
+/** (specialized) Thrown when the specified input has an invalid format. */
#define E_INVALID_HEADER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1918))
-/** Thrown when the specified input has invalid format. */
+/** Thrown when the specified input has an invalid format. */
#define E_INVALID_KEY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1919))
-/** Thrown when current state of the instance prohibits the execution of the
- * specified operation. */
+/** Thrown when the current state of the instance prohibits the execution of the
+ * specified operation. */
#define E_INVALID_OPERATION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1920))
/** (specialized) Thrown when the proxy address is invalid. */
#define E_INVALID_PROXY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1921))
-/** (specialized) Thrown when the SIM is not in proper state for processing the
- * requested operation. */
+/** (specialized) Thrown when the SIM is not in a proper state for processing the
+ * requested operation. */
#define E_INVALID_SIM_STATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1922))
/** (specialized) Thrown when the DNS request goes to an invalid DNS server. */
#define E_INVALID_SESSION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1924))
/** Thrown when the socket which is responsible for the application's request
- * is invalid. */
+ * is invalid. */
#define E_INVALID_SOCKET (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1925))
-/** Thrown when an instance is not in valid state. */
+/** Thrown when an instance is not in a valid state. */
#define E_INVALID_STATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1926))
/** Thrown when the relevant transaction is invalid. */
/** Thrown when the client has not joined the domain controller. */
#define E_NOT_JOINED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1929))
-/** The server certificate verification has failed on client. */
+/** Thrown when the server certificate verification has failed on the client's side. */
#define E_INVALID_CERTIFICATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1930))
-/** Thrown when a given url is invalid or not suitable for a requested
-* operation. */
+/** Thrown when a given url is invalid or not suitable for the requested
+ * operation. */
#define E_INVALID_URL (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1931))
-/** Thrown when the specified user id has invalid format. */
+/** Thrown when the specified user ID has an invalid format. */
#define E_INVALID_USER_ID (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1932))
-/** Thrown when the specified password has invalid format. */
+/** Thrown when the specified password has an invalid format. */
#define E_INVALID_PASSWORD (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1933))
//----------------------------------------------------------------------------J
//----------------------------------------------------------------------------K
-/** Thrown when a specified key already exists. */
+/** Thrown when the specified key already exists. */
#define E_KEY_ALREADY_EXIST (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2100))
-/** Thrown when a required key does not exist. */
+/** Thrown when the required key does not exist. */
#define E_KEY_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2101))
//----------------------------------------------------------------------------L
-/** Thrown when an error related to handling landmark occurs. */
+/** Thrown when an error related to handling landmarks occurs. */
#define E_LANDMARK (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2200))
-/** Thrown when a specified library does not exists. */
+/** Thrown when a specified library does not exist. */
#define E_LIBRARY_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2201))
/** Thrown when a specified library is not loaded. */
* occurred. */
#define E_LOCATION_SERVICE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2205))
-/** Thrown when locking (or unlocking) fails inside the logic. So cannot
- * guarantee synchronous operation. */
+/** Thrown when locking (or unlocking) fails inside the logic. So it cannot
+ * guarantee a synchronous operation. */
#define E_LOCK_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2206))
/** Thrown when the language is not set yet. */
/** Thrown when the defined limit exceeds. */
#define E_MAX_EXCEEDED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2300))
-/** Thrown when one or more of the required input is not provided. */
+/** Thrown when one or more of the required inputs are not provided. */
#define E_MISSING_INPUT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2301))
/** (specialized) ... */
/** Thrown when the network is not enabled. */
#define E_NETWORK_UNAVAILABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2401))
-/** Thrown the client certificate is required to connect to the server. */
+/** Thrown when the client certificate is required to connect to the server. */
#define E_NO_CERTIFICATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2402))
-/** Thrown when the operation is permitted only for members, but the current
- * user is not. */
+/** Thrown when the operation is permitted only for members and not for the current
+ * user. */
#define E_NOT_A_MEMBER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2403))
/** (specialized) Thrown when Bluetooth pairing is not established. */
/** Thrown when the target is not responding. */
#define E_NOT_RESPONDING (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2405))
-/** Thrown when the specified string does not represent valid number. */
+/** Thrown when the specified string does not represent a valid number. */
#define E_NUM_FORMAT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2406))
//----------------------------------------------------------------------------O
* initializing. */
#define E_ON_INITIALIZING (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2503))
-/** Thrown when the operation is canceled explicitly. */
+/** Thrown when the operation is cancelled explicitly. */
#define E_OPERATION_CANCELED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2504))
-/** Thrown when the operation fails due to certain reason. */
+/** Thrown when the operation fails due to a certain reason. */
#define E_OPERATION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2505))
/** Thrown when the memory is not sufficient to perform the requested
- * operation. */
+ * operation. */
#define E_OUT_OF_MEMORY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2506))
/** Thrown when the internal state of the current instance reaches the
- * valid range. */
+ * valid range. */
#define E_OUT_OF_RANGE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2507))
/** Thrown when the operation has caused an overflow. */
#define E_OVERFLOW (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2508))
-/** Thrown when OpenGL operation failed. */
+/** Thrown when the OpenGL operation failed. */
#define E_OPENGL_ERROR (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2509))
/** Thrown when the application does not register the log scope or
- * registered log scope is not matched with query condition (log type or log provider) specified in Query() API. */
+ * the registered log scope does not match the query condition (log type or log provider) specified in the Query() API. */
#define E_OBJ_NOT_REGISTERED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2510))
//----------------------------------------------------------------------------P
/** (specialized) Thrown when the requested Bluetooth pairing fails. */
#define E_PAIRING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2600))
-/** Thrown when the parsing fails due to any reason. */
+/** Thrown when the parsing fails due to some reason. */
#define E_PARSING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2601))
/** Thrown when an application invokes an API without a proper privilege. */
//----------------------------------------------------------------------------Q
//----------------------------------------------------------------------------R
-/** Thrown when a write operation is requested for an instance in read only
+/** Thrown when a write operation is requested for an instance in the read only
* mode. */
#define E_READ_ONLY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2800))
-/** Thrown when the operation is rejected by remote site. */
+/** Thrown when the operation is rejected by the remote site. */
#define E_REJECTED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2801))
/** (not used) */
/** Thrown when the required section does not exist. */
#define E_SECTION_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2901))
-/** Thrown when a server tells the device that operation failed due to some
- * reason. Detailed message will be followed by - error code and an error message. */
+/** Thrown when the server tells the device that the operation failed due to some
+ * reason. The detailed message is followed by an error code and an error message. */
#define E_SERVER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2902))
/** Thrown when the dedicated service module is too busy to handle another
- * request. */
+ * request. */
#define E_SERVICE_BUSY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2903))
-/** Thrown when the specific service is restricted by policy. */
+/** Thrown when the specific service is restricted by the policy. */
#define E_SERVICE_LIMITED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2904))
/** Thrown when a service is locked. */
/** Thrown when the dedicated service is not available. */
#define E_SERVICE_UNAVAILABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2906))
-/** Thrown when the base session is deactivated while it's still being used. */
+/** Thrown when the base session is deactivated while it is still being used. */
#define E_SESSION_DEACTIVATED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2907))
/** (not used) */
/** (not used) */
#define E_SIZE_MISMATCH (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2909))
-/** The socket connection closed by user. */
+/** Thrown when the socket connection is closed by the user. */
#define E_SOCKET_USER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2910))
/** Thrown when the storage is full. */
/** (specialized) Thrown then the specified table does not exist. */
#define E_TABLE_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3000))
-/** Thrown when the operation can not be completed within the specified time
+/** Thrown when the operation cannot be completed within the specified time
* period. */
#define E_TIMEOUT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3001))
/** Thrown when the URL is changed. */
#define E_URL_CHANGED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3111))
-/** (specialized) used by HTTP transaction. */
+/** (specialized) Used by the HTTP transaction. */
#define E_USER_AGENT_NOT_ALLOWED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3112))
/** Thrown when a user is already registered to the device. */
//----------------------------------------------------------------------------V
//----------------------------------------------------------------------------W
-/** (specialized) Thrown when non-blocking socket operation could not be
+/** (specialized) Thrown when the non-blocking socket operation is not
* completed immediately. */
#define E_WOULD_BLOCK (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3300))
-/** Thrown when the specified object would cause a deadlock. */
+/** Thrown when the specified object causes a deadlock. */
#define E_WOULD_DEADLOCK (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3301))
//----------------------------------------------------------------------------X
* @file FBaseFloat.h
* @brief This is the header file for the %Float class.
*
- * @see Tizen::Base::Number
- *
* This header file contains the declarations of the %Float class.
+ *
+ * @see Tizen::Base::Number
*/
#ifndef _FBASE_FLOAT_H_
#define _FBASE_FLOAT_H_
*
* @since 2.0
*
- * @param[in] value A @c float value
+ * @param[in] value The @c float value
*/
Float(float value = 0.0);
*
* @since 2.0
*
- * @param[in] value An instance of %Float
+ * @param[in] value An instance of %Float to copy
*/
Float(const Float& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Float
+ * @param[in] rhs An instance of %Float to copy
*/
Float& operator =(const Float& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of @c f1 is less than the value of @c f2
- * == 0 if the value of @c f1 is equal to the value of @c f2
- * > 0 if the value of @c f1 is greater than the value of @c f2
+ * < 0 if the value of f1 is less than the value of f2
+ * == 0 if the value of f1 is equal to the value of f2
+ * > 0 if the value of f1 is greater than the value of f2
* @endcode
* @param[in] f1 The first @c float value to compare
* @param[in] f2 The second @c float value to compare
static int Compare(float f1, float f2);
/**
- * Compares the value of the current instance with the value of the specified instance of the %Float class.
+ * Compares the value of the current instance with the value of the specified instance of %Float.
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* @li < 0 if the value of the current instance is less than the value of the specified instance
* @li == 0 if the value of the current instance is equal to the value of the specified instance
*
* @since 2.0
*
- * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Float, @n
+ * @return @c true if the value of the specified instance of :Object is equal to the value of the current instance of %Float, @n
* else @c false
* @param[in] obj An instance of Object to compare
* @see Tizen::Base::Object::Equals()
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Float
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Float
+ * @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. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c float value.
- *
- * @since 2.0
- *
- * @return An integer value indicating the hash value of the specified @c float value
- * @param[in] val A @c float value to get the hash value
- */
+ * Gets the hash value of the specified @c float value.
+ *
+ * @since 2.0
+ *
+ * @return The integer value that indicates the hash value of the specified @c float value
+ * @param[in] val The @c float value used to get the hash value
+ */
static int GetHashCode(float val);
/**
- * Parses the specified string representing a numeric value and returns the value as @c signed @c float (as out parameter).
+ * Parses the specified string that represents a numeric value and returns the value as @c signed @c float (as out parameter).
*
* @since 2.0
*
- * @return An error code
- * @param[in] s A unicode string representing a @c signed @c float value
- * @param[out] ret The numeric representation of the string
+ * @return An error code
+ * @param[in] s The unicode string that represents the @c signed @c float value
+ * @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.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an 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);
/**
- * Gets the @c signed @c char equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c char equivalent of the current instance of %Float.
*
* @since 2.0
*
- * @return A @c signed @c char equivalent of the current instance
+ * @return The @c signed @c char equivalent of the current instance
*/
virtual char ToChar(void) const;
/**
- * Gets the @c signed @c short equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c short equivalent of the current instance of %Float.
*
* @since 2.0
*
- * @return A @c signed @c short equivalent of the current instance
+ * @return The @c signed @c short equivalent of the current instance
*/
virtual short ToShort(void) const;
/**
- * Gets the @c signed @c int equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c int equivalent of the current instance of %Float.
*
* @since 2.0
*
- * @return A @c signed @c int equivalent of the current instance
+ * @return The @c signed @c int equivalent of the current instance
*/
virtual int ToInt(void) const;
/**
- * Gets the @c signed @c long equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c long equivalent of the current instance of %Float.
*
* @since 2.0
*
- * @return A @c signed @c long equivalent of the current instance
+ * @return The @c signed @c long equivalent of the current instance
*/
virtual long ToLong(void) const;
/**
- * Gets the @c signed @c long @c long equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c long @c long equivalent of the current instance of %Float
*
* @since 2.0
*
- * @return A @c signed @c long @c long equivalent of the current instance
+ * @return The @c signed @c long @c long equivalent of the current instance
*/
virtual long long ToLongLong(void) const;
/**
- * Gets the @c signed @c float equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c float equivalent of the current instance of %Float.
*
* @since 2.0
*
- * @return A @c signed @c float equivalent of the current instance
+ * @return The @c signed @c float equivalent of the current instance
*/
virtual float ToFloat(void) const;
/**
- * Gets the @c signed @c double equivalent of the current instance of the %Float class.
+ * Gets the @c signed @c double equivalent of the current instance of %Float.
*
* @since 2.0
*
- * @return A @c signed @c double equivalent of the current instance
+ * @return The @c signed @c double equivalent of the current instance
*/
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of %Float.
+ * Gets the string that represents the value of the current instance of %Float.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the value of the current instance
+ * @return The string that contains the 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
* produces the result "Infinity". @n
- * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision.
+ * 6 digits are given for the precision of this method. Use String::Format() to set a specific precision.
* - The behavior of this method is dependent on the system default locale setting.
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c float value.
+ * Gets the string that represents the specified @c float value.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c float value
- * @param[in] value A @c float value to convert
+ * @return The string that contains the Unicode representation of the specified @c float value
+ * @param[in] value The @c float value to convert
* @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.
+ * 6 digits are given for the precision of this method. Use String::Format() to set a specific precision.
* - The behavior of this method is dependent on the system default locale setting.
*/
static String ToString(float value);
* @since 2.0
*
* @return The bits that represent the floating-point number in the IEEE 754 floating-point "single format" bit layout
- * @param[in] value A @c float value to convert
+ * @param[in] value The @c float value to convert
* @see Tizen::Base::Double::Parse()
*/
static int ToBits(float value);
* @since 2.0
*
* @return The @c float floating-point value with the same bit pattern
- * @param[in] value A floating-point value in the IEEE 754 floating-point "single format" bit layout
+ * @param[in] value The floating-point value in the IEEE 754 floating-point "single format" bit layout
* @see Tizen::Base::Double::Parse()
*/
static float ToFloatFromBits(int value);
/**
- * Checks whether the current value of %Float is equal to negative or positive infinity.
+ * Checks whether the current value of %Float is equal to the negative or positive infinity.
*
* @since 2.0
*
- * @return @c true if the current value equals negative or positive infinity, @n
+ * @return @c true if the current value equals the negative or positive infinity, @n
* else @c false
*/
bool IsInfinity(void) const;
/**
- * Checks whether the specified @c float value is equal to negative or positive infinity.
+ * Checks whether the specified @c float value is equal to the negative or positive infinity.
*
* @since 2.0
*
- * @return @c true if the specified value equals negative or positive infinity, @n
+ * @return @c true if the specified value equals the negative or positive infinity, @n
* else @c false
- * @param[in] value A @c float value to check
+ * @param[in] value The @c float value to check
*/
static bool IsInfinity(float value);
*
* @return @c true if the specified value is Not-a-Number, @n
* else @c false
- * @param[in] value A @c float value to check
+ * @param[in] value The @c float value to check
*/
static bool IsNaN(float value);
/**
- * Gets a constant holding the largest positive finite value of type @c float. @n
+ * Gets the constant holding the largest positive finite value of type @c float. @n
* This is equal to the value defined in Limit.h of the C library.
*
* @since 2.0
*
- * @return A constant holding the largest positive finite value of type @c float
+ * @return The constant holding the largest positive finite value of type @c float
*/
static float GetMaxValue(void);
/**
- * Gets a constant holding the smallest positive non-zero value of type @c float. @n
+ * Gets the constant holding the smallest positive non-zero value of type @c float. @n
* This is equal to the value defined in Limit.h of the C library.
*
* @since 2.0
*
- * @return A constant holding the smallest possible non-zero value of type @c float
+ * @return The constant holding the smallest possible non-zero value of type @c float
*/
static float GetMinValue(void);
/**
- * A @c float value of this instance.
+ * The @c float value of this instance.
*
* @since 2.0
*/
* @file FBaseFloatComparer.h
* @brief This is the header file for the %FloatComparer class.
*
- * @see Float and Tizen::Base::Collection::IComparer
*
* This header file contains the declarations of the %FloatComparer class.
+ *
+ * @see Float
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_FLOAT_COMPARER_H_
#define _FBASE_FLOAT_COMPARER_H_
{
/**
* @class FloatComparer
- * @brief This class checks for equivalence between 2 instances of the %Float type.
+ * @brief This class checks for equivalence between two instances of the %Float type.
*
* @since 2.0
*
- * The %FloatComparer class checks for equivalence between 2 instances of the Float type.
+ * The %FloatComparer class checks for equivalence between two instances of the Float type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 The first instance of type Float
- * @param[in] obj2 The second instance of type Float
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The first instance of type Float
+ * @param[in] obj2 The second instance of type Float
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
*
* @since 2.0
*
- * The %FloatMatrix class provides a @c float precision, two-dimensional matrix class.
+ * The %FloatMatrix class provides a @c float precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ FloatMatrix
*
* @since 2.0
*
- * @param[in] rhs An instance of %FloatMatrix
+ * @param[in] rhs An instance of %FloatMatrix to copy
*/
FloatMatrix(const FloatMatrix& rhs);
/**
- * Constructs a row by column null matrix in which all elements are zero.
+ * Constructs a row by column null matrix in which all the elements are zero.
*
* @since 2.0
*
*
* @param[in] rowCount The number of rows in the current instance
* @param[in] columnCount The number of columns in the current instance
- * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length.
+ * @param[in] pArray The one-dimensional array @n
+ * The array must be at least row * column in length.
* @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
* else @c copy in column-major order
*/
*
* @param[in] rowCount The number of rows in the current instance
* @param[in] columnCount The number of columns in the current instance
- * @param[in] pArray[] A two-dimensional array @n The array must be at least row * column in length.
+ * @param[in] pArray[] The two-dimensional array @n
+ * The array must be at least row * column in length.
*/
FloatMatrix(int rowCount, int columnCount, const float* pArray[]);
*
* @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 %FloatMatrix
*/
*
* @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
- * else @c false
+ * @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 %FloatMatrix
*/
bool operator !=(const FloatMatrix& rhs) const;
*
* @since 2.0
*
- * @return The reference to this instance
+ * @return A reference to this instance
* @param[in] rhs An instance of %FloatMatrix
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If either row or column count of the current instance is not same with that of the specified instance,
- * return the reference to this instance without assigning.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If either the row or the column count of the current instance is not same as that of the specified instance,
+ * this method returns the reference to this instance without assigning.
*/
FloatMatrix& operator =(const FloatMatrix& rhs);
*
* @since 2.0
*
- * @return @c true if the values of the current instance are equal to the value of the specified instance, @n
- * else @c false
+ * @return @c true if the values of the current instance are equal to the value of the specified instance, @n
+ * else @c false
* @param[in] obj An instance of %FloatMatrix
- * @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;
* @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;
* @return An error code
* @param[in] matrix An instance of %FloatMatrix
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
*/
result Add(const FloatMatrix& matrix);
/**
- * Adds the value to each matrix members of current instance of %FloatMatrix.
+ * Adds the value to each matrix member of the current instance of %FloatMatrix.
*
* @since 2.0
*
- * @param[in] value A @c float value to add
+ * @param[in] value The @c float value to add
*/
void AddToEachElement(float value);
/**
- * Gets the number of column in the current instance of %FloatMatrix.
+ * Gets the number of columns in the current instance of %FloatMatrix.
*
* @since 2.0
*
- * @return The number of column in the current instance
+ * @return The number of columns in the current instance
*/
int GetColumnCount(void) const;
*
* @since 2.0
*
- * @return A pointer to float array
+ * @return A pointer to the float array
* @param[in] columnIndex The target column number in the current instance
- * @exception E_INVALID_ARG The @c columnIndex is larger than the column count of the current instance.
+ * @exception E_INVALID_ARG The specified @c columnIndex is larger than the column count of the current instance.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
float* GetColumnN(int columnIndex) const;
* @since 2.0
*
* @return The determinant value of the current instance
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the current instance is not a square matrix, return zero.
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the current instance is not a square matrix, it returns zero.
*/
float GetDeterminant(void) const;
*
* @since 2.0
*
- * @return The value at the specified row and column of the current instance
+ * @return The value at the specified row and column of the current instance
* @param[in] rowIndex The target row number in the current instance
* @param[in] columnIndex The target column number in the current instance
- * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance.
+ * @exception E_INVALID_ARG The specified @c columnIndex or the specified @c rowIndex is larger than that of the current instance.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
float GetElement(int rowIndex, int columnIndex) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %FloatMatrix containing the resulting value of the operation
+ * @return A pointer to the instance of %FloatMatrix that contains the resulting value of the operation
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
FloatMatrix* GetInverseN(void) const;
/**
- * Gets the number of row in the current instance of %FloatMatrix.
+ * Gets the number of rows in the current instance of %FloatMatrix.
*
* @since 2.0
*
- * @return The number of row in the current instance
+ * @return The number of rows in the current instance
*/
int GetRowCount(void) const;
*
* @since 2.0
*
- * @return A pointer to @c float array
+ * @return A pointer to the @c float array
* @param[in] rowIndex The target row number in the current instance
- * @exception E_INVALID_ARG The @c rowIndex is larger than the row count of the current instance.
+ * @exception E_INVALID_ARG The specified @c rowIndex is larger than the row count of the current instance.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
float* GetRowN(int rowIndex) const;
* @since 2.0
*
* @return An error code
- * @param[out] value A @c float value
- * @exception E_SUCCESS The method is successful.
+ * @param[out] value The @c float value
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
result GetTrace(float& value) const;
*
* @since 2.0
*
- * @return A pointer to the instance of %FloatMatrix containing the resulting value of the operation
- * @exception E_INVALID_OPERATION The current instance is not a square matrix.
+ * @return A pointer to the instance of %FloatMatrix that contains the resulting value of the operation
+ * @exception E_INVALID_OPERATION The current instance is not a square matrix.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
FloatMatrix* GetTransposeN(void) const;
* @return An error code
* @param[in] matrix An instance of %FloatMatrix
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The column count of the current instance is not same with the row count of the specified instance.
+ * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance.
*/
result Multiply(const FloatMatrix& matrix);
/**
- * Multiplies the value to each matrix members of current instance of %FloatMatrix.
+ * Multiplies the value to each matrix member of the current instance of %FloatMatrix.
*
* @since 2.0
*
- * @param[in] value A @c float value to multiply
+ * @param[in] value The @c float value to multiply
*/
void Multiply(float value);
/**
- * Negates the matrix members of current instance of %FloatMatrix.
+ * Negates the matrix members of the current instance of %FloatMatrix.
*
* @since 2.0
*/
*
* @return An error code
* @param[in] columnIndex The target column number in the current instance
- * @param[in] pArray An array which includes the values @n The array must be at least row in length.
+ * @param[in] pArray The array which includes the values @n
+ * The array must be at least row in length.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c columnIndex is larger than the column count of the current instance.
*/
result SetColumn(int columnIndex, const float* pArray);
* @since 2.0
*
* @return An error code
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] pArray An array which includes the values @n The array must be at least column in length.
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] pArray The array which includes the values @n
+ * The array must be at least column in length.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c rowIndex is larger than the row count of the current instance.
*/
result SetRow(int rowIndex, const float* pArray);
* @since 2.0
*
* @return An error code
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] columnIndex The target column number in the current instance
- * @param[in] value A @c float value
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance,
- * or the @c columnIndex is larger than the column count of the current instance.
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] columnIndex The target column number in the current instance
+ * @param[in] value The @c float value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c rowIndex is larger than the row count of the current instance.
+ * - The specified @c columnIndex is larger than the column count of the current instance.
*/
result SetElement(int rowIndex, int columnIndex, float value);
* @since 2.0
*
* @return An error code
- * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length.
- * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
- * else @c false to copy in column-major order
+ * @param[in] pArray The one-dimensional array @n
+ * The array must be at least row * column in length.
+ * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
+ * else @c false to copy in column-major order
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pArray is @c null.
+ * @exception E_INVALID_ARG The specified @c pArray is @c null.
*/
result SetValue(const float* pArray, bool rowMajor = true);
/**
- * Sets the matrix members of current instance of %FloatMatrix to zero.
+ * Sets the matrix members of the current instance of %FloatMatrix to zero.
*
* @since 2.0
*/
* @return An error code
* @param[in] matrix An instance of %FloatMatrix
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
*/
result Subtract(const FloatMatrix& matrix);
/**
- * Subtracts the value from each matrix members of current instance of %FloatMatrix.
+ * Subtracts the value from each matrix member of the current instance of %FloatMatrix.
*
* @since 2.0
*
- * @param[in] value A @c float value to subtract
+ * @param[in] value The @c float value to subtract
*/
void SubtractToEachElement(float value);
*
* @since 2.0
*
- * The %FloatMatrix3 class provides a @c float precision, two-dimensional matrix class.
+ * The %FloatMatrix3 class provides a @c float precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ FloatMatrix3
public:
/**
* This is the default constructor for this class. @n
- * Constructs a 3 X 3 null matrix in which all elements are zero.
+ * Constructs a 3 X 3 null matrix in which all the elements are zero.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %FloatMatrix3
+ * @param[in] rhs An instance of %FloatMatrix3 to copy
*/
FloatMatrix3(const FloatMatrix3& rhs);
*
* @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 %FloatMatrix3
*/
*
* @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 %FloatMatrix3
*/
*
* @since 2.0
*
- * @return The reference to this instance
- * @param[in] rhs An instance of %FloatMatrix3
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %FloatMatrix3 to copy
*/
FloatMatrix3& operator =(const FloatMatrix3& rhs);
*
* @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
*/
FloatMatrix3& operator =(float value);
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix3
*/
FloatMatrix3 operator *(const FloatMatrix3& rhs) const;
/**
- * Multiplies the value to each matrix members of current instance of %FloatMatrix3.
+ * Multiplies the value to each matrix member of the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to multiply
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to multiply
*/
FloatMatrix3 operator *(float value) const;
/**
- * Adds the value of the specified instance and the current instance of %FloatMatrix3.
+ * Adds the value of the specified instance to the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix3
*/
FloatMatrix3 operator +(const FloatMatrix3& rhs) const;
/**
- * Adds the value to each matrix members of current instance of %FloatMatrix3.
+ * Adds the value to each matrix member of the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to add
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to add
*/
FloatMatrix3 operator +(float value) const;
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix3
*/
FloatMatrix3 operator -(const FloatMatrix3& rhs) const;
/**
- * Subtracts the value from each matrix members of current instance of %FloatMatrix3.
+ * Subtracts the value from each matrix member of the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to subtract
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to subtract
*/
FloatMatrix3 operator -(float value) const;
*
* @since 2.0
*
- * @return The reference to %FloatMatrix3 containing the resulting value of the operation
+ * @return A reference to %FloatMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix3
*/
FloatMatrix3& operator *=(const FloatMatrix3& rhs);
/**
- * Multiplies the value to each matrix members of current instance of %FloatMatrix3.
+ * Multiplies the value to each matrix member of the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to multiply
+ * @return A reference to %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to multiply
*/
FloatMatrix3& operator *=(float value);
*
* @since 2.0
*
- * @return The reference to %FloatMatrix3 containing the resulting value of the operation
+ * @return A reference to %FloatMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix3
*/
FloatMatrix3& operator +=(const FloatMatrix3& rhs);
/**
- * Adds the value to each matrix members of current instance of %FloatMatrix3.
+ * Adds the value to each matrix member of the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to add
+ * @return A reference to %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to add
*/
FloatMatrix3& operator +=(float value);
*
* @since 2.0
*
- * @return The reference to %FloatMatrix3 containing the resulting value of the operation
+ * @return A reference to %FloatMatrix3 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix3
*/
FloatMatrix3& operator -=(const FloatMatrix3& rhs);
/**
- * Subtracts the value from each matrix members of current instance of %FloatMatrix3.
+ * Subtracts the value from each matrix member of the current instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to subtract
+ * @return A reference to %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to subtract
*/
FloatMatrix3& operator -=(float value);
/**
- * Gets the instance of %FloatMatrix3 resulting from the sum of the value and the specified instance of %FloatMatrix3.
+ * Gets an instance of %FloatMatrix3 resulting from the sum of the value and the specified instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to add
- * @param[in] rhs An instance of %FloatMatrix3
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to add
+ * @param[in] rhs An instance of %FloatMatrix3
*/
_OSP_EXPORT_ friend FloatMatrix3 operator +(const float& value, const FloatMatrix3& rhs);
/**
- * Gets the instance of %FloatMatrix3 resulting from the product of the value and the specified instance of %FloatMatrix3.
+ * Gets an instance of %FloatMatrix3 resulting from the product of the value and the specified instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to multiply
- * @param[in] rhs An instance of %FloatMatrix3
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to multiply
+ * @param[in] rhs An instance of %FloatMatrix3
*/
_OSP_EXPORT_ friend FloatMatrix3 operator *(const float& value, const FloatMatrix3& rhs);
/**
- * Gets the instance of %FloatMatrix3 resulting from the difference between the value and the specified instance of %FloatMatrix3.
+ * Gets an instance of %FloatMatrix3 resulting from the difference between the value and the specified instance of %FloatMatrix3.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
- * @param[in] value A @c float value to subtract
- * @param[in] rhs An instance of %FloatMatrix3
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
+ * @param[in] value The @c float value to subtract
+ * @param[in] rhs An instance of %FloatMatrix3
*/
_OSP_EXPORT_ friend FloatMatrix3 operator -(const float& value, const FloatMatrix3& rhs);
*
* @since 2.0
*
- * @return @c true if the values of the current instance is equal to the value of the specified instance, @n
- * else @c false
+ * @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 %FloatMatrix3
- * @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;
* @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;
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
* @remarks This function must be called after checking whether the matrix is invertible or not.
*/
FloatMatrix3 GetInverse(void) const;
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix3 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation
*/
FloatMatrix3 GetTranspose(void) const;
bool IsInvertible(void) const;
/**
- * Negates the matrix members of current instance of %FloatMatrix3.
+ * Negates the matrix members of the current instance of %FloatMatrix3.
*
* @since 2.0
*/
* @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);
void Transpose(void);
/**
- * Sets the matrix members of current instance of %FloatMatrix3 to zero.
+ * Sets the matrix members of the current instance of %FloatMatrix3 to zero.
*
* @since 2.0
*/
*
* @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
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
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %FloatMatrix4
+ * @param[in] rhs An instance of %FloatMatrix4 to copy
*/
FloatMatrix4(const FloatMatrix4& rhs);
FloatMatrix4(const float matrix[4][4]);
/**
- * TThis destructor overrides Tizen::Base::Object::~Object().
+ * This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
*/
*
* @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
*/
*
* @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
*/
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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
+ * @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
+ * @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
+ * @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);
* @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;
* @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;
*
* @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;
*
* @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;
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
*/
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
*/
* @file FBaseInt8.h
* @brief This is the header file for the %Int8 class.
*
- * @see Tizen::Base::Number
- *
* This header file contains the declarations of the %Int8 class.
+ *
+ * @see Tizen::Base::Number
*/
#ifndef _FBASE_INT8_H_
#define _FBASE_INT8_H_
*
* @since 2.0
*
- * @param[in] value A @c char value
+ * @param[in] value The @c char value
*/
Int8(char value = 0);
*
* @since 2.0
*
- * @param[in] value An instance of %Int8
+ * @param[in] value An instance of %Int8 to copy
*/
Int8(const Int8& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Int8
+ * @param[in] rhs An instance of %Int8 to copy
*/
Int8& operator =(const Int8& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of ch1 is less than the value of ch2
* == 0 if the value of ch1 is equal to the value of ch2
static int Compare(char ch1, char ch2);
/**
- * Compares the value of the current instance with the value of the specified instance of the %Int8 class.
+ * Compares the value of the current instance with the value of the specified instance of %Int8.
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
* > 0 if the value of the current instance is greater than the value of the specified instance
* @endcode
- * @param[in] value An instance of the %Int8 class to compare
+ * @param[in] value An instance of %Int8 to compare
*/
int CompareTo(const Int8& value) const;
*
* @return @c true if the value of the specified instance is equal to the value of the current instance, @n
* else @c false
- * @param[in] obj An instance of Object to compare
+ * @param[in] obj An instance of Tizen::Base::Object to compare
* @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Int8
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Int8
+ * @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. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the specified @c char value
- * @param[in] val A @c char value to get the hash value
+ * @return The integer value that indicates the hash value of the specified @c char value
+ * @param[in] val The @c char value to get the hash value
*/
static int GetHashCode(char val);
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[out] ret The result of the operation
+ * @param[in] s The string that represents the numeric value
+ * @param[out] ret The result of the operation
* @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 accepts decimal, hexadecimal, and octal numbers given by the
* - Sign:
* '-'
* @endcode
- * @remarks This method has portability issue. @n
- * When the specified string is nagative number in the ARM architecture, type casting is needed like following code.
+ * @remarks This method has portability issues. @n
+ * When the specified string is a negative number in the ARM architecture, type casting is needed like the following code.
* @code
* char ret;
* Int8::Decode(L"-0X20", ret);
static result Decode(const String& s, char& ret);
/**
- * Parses the @c signed @c char equivalent of the specified string representing a numeric value.
+ * Parses the @c signed @c char equivalent of the specified string that represents a numeric value.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[out] ret The result of the operation
+ * @param[in] s The string that represents a numeric value
+ * @param[out] ret The result of the operation
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a byte that can be parsed.
* @remarks
- * - This method assumes that the string representing the numeric value uses a radix 10.
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method assumes that the string representing the numeric value uses a radix @c 10.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, char& ret);
/**
- * Parses the specified string representing a numeric value and
+ * Parses the specified string that represents a numeric value and
* returns the value as @c signed @c char (as out parameter).
*
* @since 2.0
*
- * @return The @c signed @c char equivalent of the specified string representing the numeric value using the specified index
- * @param[in] s A string representing a numeric value
- * @param[in] radix The radix of the string representing a numeric value @n
- * It must either be 2, 8, 10, or 16.
- * @param[out] ret The result of the operation
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
- * @exception E_OUT_OF_RANGE The specified @c radix is invalid.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @return The @c signed @c char equivalent of the specified string that represents the numeric value using the specified index
+ * @param[in] s The string that represents the numeric value
+ * @param[in] radix The radix of the string that represents the numeric value @n
+ * It must either be 2, 8, 10, or 16.
+ * @param[out] ret The result of the operation
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
+ * @exception E_OUT_OF_RANGE The specified @c radix is invalid.
+ * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int radix, char& ret);
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of %Int8.
+ * Gets the string that represents the value of the current instance of %Int8.
*
* @since 2.0
*
- * @return A string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c signed @c char value using radix @c 10.
+ * Gets the string that represents the specified @c signed @c char value using radix @c 10.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c char value using radix 10
- * @param[in] value A @c char value
+ * @return The string that contains the Unicode representation of the specified @c char value using radix @c 10
+ * @param[in] value The @c char value
*/
static String ToString(char value);
/**
- * A constant holding the maximum value of type @c char. @n
+ * The constant holding the maximum value of type @c char. @n
* A @c short character can hold a value of upto 2^7-1.
*
* @since 2.0
static const char VALUE_MAX = (signed char) 0x7F;
/**
- * A constant holding the minimum value of type @c char. @n
+ * The constant holding the minimum value of type @c char. @n
* A @c short character can hold a value of upto -2^7.
*
* @since 2.0
static const char VALUE_MIN = (signed char) 0x80;
/**
- * A @c signed @c char value of this instance.
+ * The @c signed @c char value of this instance.
*
* @since 2.0
*/
* @file FBaseInt8Comparer.h
* @brief This is the header file for the %Int8Comparer class.
*
- * @see Int8 and Tizen::Base::Collection::IComparer
- *
* This header file contains the declarations of the %Int8Comparer class.
+ *
+ * @see Int8
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_INT8_COMPARER_H_
#define _FBASE_INT8_COMPARER_H_
{
/**
* @class Int8Comparer
- * @brief This class checks for equivalence between 2 instances of the %Int8 type.
+ * @brief This class checks for equivalence between two instances of the %Int8 type.
*
* @since 2.0
*
- * The %Int8Comparer class checks for equivalence between 2 instances of the Int8 type.
+ * The %Int8Comparer class checks for equivalence between two instances of the Int8 type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 The first instance of type Int8
- * @param[in] obj2 The second instance of type Int8
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The first instance of type Int8
+ * @param[in] obj2 The second instance of type Int8
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
*
* @since 2.0
*
- * The %IntMatrix class provides a int precision, two-dimensional matrix class.
+ * The %IntMatrix class provides a @c int precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ IntMatrix
*
* @since 2.0
*
- * @param[in] rhs An instance of %IntMatrix
+ * @param[in] rhs An instance of %IntMatrix to copy
*/
IntMatrix(const IntMatrix& rhs);
/*
- * Constructs a row by column null matrix in which all elements are zero.
+ * Constructs a row by column null matrix in which all the elements are zero.
*
* @since 2.0
*
*
* @param[in] rowCount The number of rows in the current instance
* @param[in] columnCount The number of columns in the current instance
- * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length.
+ * @param[in] pArray The one-dimensional array @n
+ * The array must be at least row * column in length.
* @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
* else @c copy in column-major order
*/
*
* @param[in] rowCount The number of rows in the current instance
* @param[in] columnCount The number of columns in the current instance
- * @param[in] pArray[] A two-dimensional array @n The array must be at least row * column in length.
+ * @param[in] pArray[] The two-dimensional array @n
+ * The array must be at least row * column in length.
*/
IntMatrix(int rowCount, int columnCount, const int* pArray[]);
*
* @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 %IntMatrix
*/
*
* @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 %IntMatrix
*/
*
* @since 2.0
*
- * @return The reference to this instance
+ * @return A reference to this instance
* @param[in] rhs An instance of %IntMatrix
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
- * @remarks If either row or column count of the current instance is not same with that of the specified instance,
- * return the reference to this instance without assigning.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
+ * @remarks If either the row or the column count of the current instance is not same as that of the specified instance,
+ * this method returns the reference to this instance without assigning.
*/
IntMatrix& operator =(const IntMatrix& rhs);
* @return @c true if the values of the current instance are equal to the value of the specified instance, @n
* else @c false
* @param[in] obj An instance of %IntMatrix
- * @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;
* @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;
* @return An error code
* @param[in] matrix An instance of %IntMatrix
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
*/
result Add(const IntMatrix& matrix);
/*
- * Adds the value to each matrix members of current instance of %IntMatrix.
+ * Adds the value to each matrix member of the current instance of %IntMatrix.
*
* @since 2.0
*
- * @param[in] value A @c int value to add
+ * @param[in] value The @c int value to add
*/
void AddToEachElement(int value);
/*
- * Gets the number of column in the current instance of %IntMatrix.
+ * Gets the number of columns in the current instance of %IntMatrix.
*
* @since 2.0
*
- * @return The number of column in the current instance
+ * @return The number of columns in the current instance
*/
int GetColumnCount(void) const;
*
* @since 2.0
*
- * @return A pointer to @c int array
+ * @return A pointer to the @c int array
* @param[in] columnIndex The target column number in the current instance
- * @exception E_INVALID_ARG The @c columnIndex is larger than the column count of the current instance.
+ * @exception E_INVALID_ARG The specified @c columnIndex is larger than the column count of the current instance.
*/
int* GetColumnN(int columnIndex) const;
*
* @since 2.0
*
- * @return The determinant value of the current instance
+ * @return The determinant value of the current instance
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
- * @remarks If the current instance is not a square matrix, return zero.
+ * @remarks If the current instance is not a square matrix, it returns zero.
*/
int GetDeterminant(void) const;
*
* @since 2.0
*
- * @return The value at the specified row and column of the current instance
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] columnIndex The target column number in the current instance
- * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance.
+ * @return The value at the specified row and column of the current instance
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] columnIndex The target column number in the current instance
+ * @exception E_INVALID_ARG The specified @c columnIndex or the specified @c rowIndex is larger than that of the current instance.
*/
int GetElement(int rowIndex, int columnIndex) const;
IntMatrix* GetInverseN(void) const;
/*
- * Gets the number of row in the current instance of %IntMatrix.
+ * Gets the number of rows in the current instance of %IntMatrix.
*
* @since 2.0
*
- * @return The number of row in the current instance
+ * @return The number of rows in the current instance
*/
int GetRowCount(void) const;
*
* @since 2.0
*
- * @return A pointer to @c int array
+ * @return A pointer to the @c int array
* @param[in] rowIndex The target row number in the current instance
- * @exception E_INVALID_ARG The @c rowIndex is larger than the row count of the current instance.
+ * @exception E_INVALID_ARG The specified @c rowIndex is larger than the row count of the current instance.
*/
int* GetRowN(int rowIndex) const;
* @since 2.0
*
* @return An error code
- * @param[out] value A @c int value
+ * @param[out] value The @c int value
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
*
* @since 2.0
*
- * @return A pointer to the instance of %IntMatrix containing the resulting value of the operation
+ * @return A pointer to the %IntMatrix instance that contains the resulting value of the operation
* @exception E_INVALID_OPERATION The current instance is not a square matrix.
*/
IntMatrix* GetTransposeN(void) const;
* @return An error code
* @param[in] matrix An instance of %IntMatrix
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The column count of the current instance is not same with the row count of the specified instance.
+ * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance.
*/
result Multiply(const IntMatrix& matrix);
/*
- * Multiplies the value to each matrix members of current instance of %IntMatrix.
+ * Multiplies the value to each matrix member of the current instance of %IntMatrix.
*
* @since 2.0
*
- * @param[in] value A @c int value to multiply
+ * @param[in] value The @c int value to multiply
*/
void Multiply(int value);
/*
- * Negates the matrix members of current instance of %IntMatrix.
+ * Negates the matrix members of the current instance of %IntMatrix.
*
* @since 2.0
*/
*
* @return An error code
* @param[in] columnIndex The target column number in the current instance
- * @param[in] pArray An array which includes the values @n The array must be at least row in length.
+ * @param[in] pArray The array which includes the values @n
+ * The array must be at least row in length.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c columnIndex is larger than the column count of the current instance.
*/
result SetColumn(int columnIndex, const int* pArray);
*
* @return An error code
* @param[in] rowIndex The target row number in the current instance
- * @param[in] pArray An array which includes the values @n The array must be at least column in length.
+ * @param[in] pArray The array which includes the values @n
+ * The array must be at least column in length.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c rowIndex is larger than the row count of the current instance.
*/
result SetRow(int rowIndex, const int* pArray);
* @since 2.0
*
* @return An error code
- * @param[in] rowIndex The target row number in the current instance
- * @param[in] columnIndex The target column number in the current instance
- * @param[in] value A @c int value
+ * @param[in] rowIndex The target row number in the current instance
+ * @param[in] columnIndex The target column number in the current instance
+ * @param[in] value The @c int value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance,
- * or the @c columnIndex is larger than the column count of the current instance.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c pArray is @c null.
+ * - The specified @c rowIndex is larger than the row count of the current instance.
+ * - The specified @c columnIndex is larger than the column count of the current instance.
*/
result SetElement(int rowIndex, int columnIndex, int value);
* @since 2.0
*
* @return An error code
- * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length.
- * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
- * else @c false to copy in column-major order
+ * @param[in] pArray The one-dimensional array @n
+ * The array must be at least row * column in length.
+ * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n
+ * else @c false to copy in column-major order
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The pArray is @c null.
+ * @exception E_INVALID_ARG The specified @c pArray is @c null.
*/
result SetValue(const int* pArray, bool rowMajor = true);
/*
- * Sets the matrix members of current instance of %IntMatrix to zero.
+ * Sets the matrix members of the current instance of %IntMatrix to zero.
*
* @since 2.0
*/
* @since 2.0
*
* @return An error code
- * @param[in] matrix An instance of %IntMatrix
+ * @param[in] matrix An instance of %IntMatrix
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance.
+ * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance.
*/
result Subtract(const IntMatrix& matrix);
/*
- * Subtracts the value from each matrix members of current instance of %IntMatrix.
+ * Subtracts the value from each matrix member of the current instance of %IntMatrix.
*
* @since 2.0
*
- * @param[in] value A @c int value to subtract
+ * @param[in] value The @c int value to subtract
*/
void SubtractToEachElement(int value);
* @file FBaseInteger.h
* @brief This is the header file for the %Integer class.
*
- * @see Number() class()
- *
* This header file contains the declarations of the %Integer class.
+ *
+ * @see Number
*/
#ifndef _FBASE_INTEGER_H_
#define _FBASE_INTEGER_H_
*
* @since 2.0
*
- * @param[in] value An integer value
+ * @param[in] value The integer value
*/
Integer(int value = 0);
*
* @since 2.0
*
- * @param[in] value An instance of %Integer
+ * @param[in] value An instance of %Integer to copy
*/
Integer(const Integer& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Integer
+ * @param[in] rhs An instance of %Integer to copy
*/
Integer& operator =(const Integer& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of @c i1 is less than the value of @c i2
- * == 0 if the value of @c i1 is equal to the value of @c i2
- * > 0 if the value of @c i1 is greater than the value of @c i2
+ * < 0 if the value of i1 is less than the value of i2
+ * == 0 if the value of i1 is equal to the value of i2
+ * > 0 if the value of i1 is greater than the value of i2
* @endcode
* @param[in] i1 The first @c int value to compare
* @param[in] i2 The second @c int value to compare
static int Compare(int i1, int i2);
/**
- * Compares the value of the current instance with the value of the specified instance of the %Integer class.
+ * Compares the value of the current instance with the value of the specified instance of %Integer.
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
*
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
* > 0 if the value of the current instance is greater than the value of the specified instance
* @endcode
- * @param[in] value An instance of the %Integer class to compare
+ * @param[in] value An instance of %Integer to compare
*/
int CompareTo(const Integer& value) const;
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing the numeric value
- * @param[out] ret The result of the operation
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
+ * @param[in] s The string that represents the numeric value
+ * @param[out] ret The result of the operation
+ * @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 accepts decimal, hexadecimal, and octal numbers given by the
* following grammar:
* @code
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Integer
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Integer
+ * @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. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c int value.
- *
- * @since 2.0
- *
- * @return An integer value indicating the hash value of the specified @c int value
- * @param[in] val A @c int value to get the hash value
- */
+ * Gets the hash value of the specified @c int value.
+ *
+ * @since 2.0
+ *
+ * @return The integer value that indicates the hash value of the specified @c int value
+ * @param[in] val The @c int value used to get the hash value
+ */
static int GetHashCode(int val);
/**
- * Parses the @c signed @c int equivalent of the specified string representing a numeric value.
+ * Parses the @c signed @c int equivalent of the specified string that represents a numeric value.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
+ * @param[in] s The string that represents the numeric value
* @param[out] ret The result of the operation
* @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 assumes that the string representing the numeric value uses a radix 10.
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method assumes that the string that represents the numeric value that uses the radix @c 10.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int& ret);
/**
- * Parses the @c signed @c int equivalent of the specified string representing a numeric value using the specified radix.
+ * Parses the @c signed @c int equivalent of the specified string that represents a numeric value using the specified radix.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[in] radix The radix of the string representing the numeric value @n
+ * @param[in] s The string that represents the numeric value
+ * @param[in] radix The radix of the string that represents the numeric value @n
* It must either be 2, 8, 10, or 16.
* @param[out] ret The result of the operation
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
* @exception E_OUT_OF_RANGE The specified @c radix is invalid.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int radix, int& ret);
/**
- * Gets the @c signed @c char equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c char equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c char equivalent of the current instance
+ * @return The @c signed @c char equivalent of the current instance
*/
virtual char ToChar(void) const;
/**
- * Gets the @c signed @c short equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c short equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c short equivalent of the current instance
+ * @return The @c signed @c short equivalent of the current instance
*/
virtual short ToShort(void) const;
/**
- * Gets the @c signed @c int equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c int equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c int equivalent of the current instance
+ * @return The @c signed @c int equivalent of the current instance
*/
virtual int ToInt(void) const;
/**
- * Gets the @c signed @c long equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c long equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c long equivalent of the current instance
+ * @return The @c signed @c long equivalent of the current instance
*/
virtual long ToLong(void) const;
/**
- * Gets the @c signed @c long @c long equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c long @c long equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c long @c long equivalent of the current instance
+ * @return The @c signed @c long @c long equivalent of the current instance
*/
virtual long long ToLongLong(void) const;
/**
- * Gets the @c signed @c float equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c float equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c float equivalent of the current instance
+ * @return The @c signed @c float equivalent of the current instance
*/
virtual float ToFloat(void) const;
/**
- * Gets the @c signed @c double equivalent of the current instance of the %Integer class.
+ * Gets the @c signed @c double equivalent of the current instance of %Integer.
*
* @since 2.0
*
- * @return A @c signed @c double equivalent of the current instance
+ * @return The @c signed @c double equivalent of the current instance
*/
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of the %Integer class.
+ * Gets the string that represents the value of the current instance of %Integer.
*
* @since 2.0
*
- * @return A string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c signed @c int value.
+ * Gets the string that represents the specified @c signed @c int value.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c signed @c int value
- * @param[in] value A @c signed @c int value to convert
+ * @return The string that contains the Unicode representation of the specified @c signed @c int value
+ * @param[in] value The @c signed @c int value to convert
*/
static String ToString(int value);
/**
- * A constant holding the maximum value of type @c int. @n
+ * The constant holding the maximum value of type @c int. @n
* A @c short integer can hold a value of upto 2^31-1.
*
* @since 2.0
static const int VALUE_MAX = (int) 0x7FFFFFFF;
/**
- * A constant holding the minimum value of type @c int. @n
+ * The constant holding the minimum value of type @c int. @n
* A @c short integer can hold a value of upto -2^31.
*
* @since 2.0
static const int VALUE_MIN = (int) 0x80000000;
/**
- * An integer value of this instance.
+ * The integer value of this instance.
*
* @since 2.0
*/
* @file FBaseIntegerComparer.h
* @brief This is the header file for the %IntegerComparer class.
*
- * @see Integer and Tizen::Base::Collection::IComparer
- *
* This header file contains the declarations of the %IntegerComparer class.
+ *
+ * @see Integer
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_INTEGER_COMPARER_H_
#define _FBASE_INTEGER_COMPARER_H_
{
/**
* @class IntegerComparer
- * @brief This class checks for equivalence between 2 instances of the Integer type.
+ * @brief This class checks for equivalence between two instances of the %Integer type.
*
* @since 2.0
*
- * The %IntegerComparer class checks for equivalence between 2 instances of the Integer type.
+ * The %IntegerComparer class checks for equivalence between two instances of the Integer type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 The first instance of type %Integer
- * @param[in] obj2 The second instance of type %Integer
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The first instance of type Integer
+ * @param[in] obj2 The second instance of type Integer
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
/**
* @defgroup GroupMacros Debugging Macros
*
- * This page describes Tizen debugging macros.
+ * This page describes the Tizen debugging macros.
*
* @since 2.0
*/
* @{
*/
/**
- * This macro allows display of arbitrary messages for future examination.
+ * This macro allows the display of arbitrary messages for future examination.
*
* @since 2.0
*
* @since 2.0
*
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] ... The message to display
*
* The following example demonstrates how to use the Try macro.
* @since 2.0
*
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
/**
* If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression
-* and goes to label.
+* and goes to the catch label.
*
* @since 2.1
*
* @param[in] condition The condition that is expected to be true
-* @param[in] expr Expressions that are evaluated before going to catchLabel
-* @param[in] catchLabel The label for goto operation
+* @param[in] expr Expressions that are evaluated before going to the CATCH label
+* @param[in] catchLabel The label for the goto operation
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the message is printed and a value is returned.
+ * If the condition is @c false, a message is printed and a value is returned.
*
* @since 2.0
*
else {;}
/**
- * If the condition is @c false, the message is printed, sets the last result and a value is returned.
+ * If the condition is @c false, a message is printed, the last result is set and a value is returned.
*
* @since 2.0
*
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
- * @param[in] r The last result to set
- * @param[in] ... The message to display
+ * @param[in] r The last result to set
+ * @param[in] ... The message to display
* @hideinitializer
*/
#define TryReturnResult(condition, returnValue, r, ...) \
else {;}
/**
- * If the condition is @c false, the message is printed, sets the last result and no value is returned.
+ * If the condition is @c false, a message is printed, the last result is set and no value is returned.
*
* @since 2.0
*
else {;}
/**
- * If the condition is @c false, the message is printed and no value is returned.
+ * If the condition is @c false, a message is printed and no value is returned.
*
* @since 2.0
*
else {;}
/**
- * If the condition is @c false, the message is printed.
+ * If the condition is @c false, a message is printed.
*
* @since 2.0
*
else {;}
/**
-* If the condition is @c false, the informative log message is printed and a value is returned.
+* If the condition is @c false, an informative log message is printed and a value is returned.
*
* @since 2.1
*
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] ... The message to display
* @hideinitializer
*/
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
/**
* If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression
-* and goes to label.
+* and goes to the catch label.
*
* @since 2.1
*
-* @param[in] tag Used to identify the source of a log message
+* @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
-* @param[in] expr Expressions that are evaluated before going to catchLabel
-* @param[in] catchLabel The label for goto operation
+* @param[in] expr Expressions that are evaluated before going to the CATCH label
+* @param[in] catchLabel The label for the goto operation
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the message is printed with a tag and a value is returned.
+ * If the condition is @c false, a message is printed with a tag and a value is returned.
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
* @param[in] ... The message to display
else {;}
/**
- * If the condition is @c false, the message is printed with a tag, sets the last result and a value is returned.
+ * If the condition is @c false, it prints a message with a tag, sets the last result and returns a value.
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
* @param[in] r The last result to set
else {;}
/**
- * If the condition is @c false, the message is printed with a tag, sets the last result and no value is returned.
+ * If the condition is @c false, it prints a message with a tag, sets the last result and does not return any value.
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] r The last result to set
* @param[in] ... The message to display
else {;}
/**
- * If the condition is @c false, the message is printed with a tag and no value is returned.
+ * If the condition is @c false, a message is printed with a tag and no value is returned.
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the message is printed with a tag.
+ * If the condition is @c false, a message is printed with a tag.
*
* @since 2.0
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
-* If the condition is @c false, the informative log message is printed with a tag and a value is returned.
+* If the condition is @c false, an informative log message is printed with a tag and a value is returned.
*
* @since 2.1
*
-* @param[in] tag Used to identify the source of a log message
+* @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
* @param[in] ... The message to display
#else
/**
- * This macro is to protect informative log messages which needs to keep security.
- * It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect informative log messages which need security.
+ * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
*
* @since 2.1
*
#define AppSecureLog(...)
/**
- * This macro is to protect debug log messages which needs to keep security.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect debug log messages which need security.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
*
* @since 2.1
*
#define AppSecureLogDebug(...)
/**
- * This macro is to protect exception log messages which needs to keep security.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect exception log messages which need security.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
*
* @since 2.1
*
#define AppSecureLogException(...)
/**
- * This macro is to protect informative log messages which needs to keep security, with a tag.
- * It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect informative log messages which need security, with a tag.
+ * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
*
* @since 2.1
*
#define AppSecureLogTag(tag, ...)
/**
- * This macro is to protect debug log messages which needs to keep security, with a tag.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect debug log messages which need security, with a tag.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
*
* @since 2.1
*
#define AppSecureLogDebugTag(tag, ...)
/**
- * This macro is to protect exception log messages which needs to keep security, with a tag.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect exception log messages which need security, with a tag.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
*
* @since 2.1
*
/**
* If the condition is @c false, it prints a message, evaluates a cleanup expression,
* and goes to <tt>CATCH</tt>.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] ... The message to display
*
* The following example demonstrates how to use the SecureTry macro.
/**
* If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression
* and goes to <tt>CATCH</tt>.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * It allows the display of exception log messages if compiled with "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
/**
* If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression
- * and goes to label.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * and goes to the catch label.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to catchLabel
- * @param[in] catchLabel The label for goto operation
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
+ * @param[in] catchLabel The label for the goto operation
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the message is printed and a value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed and a value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
else {;}
/**
- * If the condition is @c false, the message is printed, sets the last result and a value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, it prints a message, sets the last result and returns a value.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
else {;}
/**
- * If the condition is @c false, the message is printed, sets the last result and no value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed, the last result is set and no value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
else {;}
/**
- * If the condition is @c false, the message is printed and no value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed and no value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
else {;}
/**
- * If the condition is @c false, the message is printed.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
else {;}
/**
- * If the condition is @c false, the informative log message is printed and a value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, an informative log message is printed and a value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
/**
* If the condition is @c false, it prints a message with a tag, evaluates a cleanup expression
* and goes to <tt>CATCH</tt>.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] ... The message to display
* @hideinitializer
*/
/**
* If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression,
* and goes to <tt>CATCH</tt>.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
/**
* If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression
- * and goes to label.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * and goes to the catch label.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to catchLabel
- * @param[in] catchLabel The label for goto operation
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
+ * @param[in] catchLabel The label for the goto operation
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the message is printed with a tag and a value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed with a tag and a value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
* @param[in] ... The message to display
else {;}
/**
- * If the condition is @c false, the message is printed with a tag, sets the last result and a value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed with a tag, the last result is set and a value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
* @param[in] r The last result to set
else {;}
/**
- * If the condition is @c false, the message is printed with a tag, sets the last result and no value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed with a tag, the last result is set and no value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] r The last result to set
* @param[in] ... The message to display
else {;}
/**
- * If the condition is @c false, the message is printed with a tag and no value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed with a tag and no value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the message is printed with a tag.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, a message is printed with a tag.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
* @hideinitializer
else {;}
/**
- * If the condition is @c false, the informative log message is printed with a tag and a value is returned.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * If the condition is @c false, an informative log message is printed with a tag and a value is returned.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
*
* @since 2.1
*
- * @param[in] tag Used to identify the source of a log message
+ * @param[in] tag Used to identify the source of the log message
* @param[in] condition The condition that is expected to be true
* @param[in] returnValue The value to return when the condition is @c false
* @param[in] ... The message to display
* @file FBaseLong.h
* @brief This is the header file for the %Long class.
*
- * @see Number()
- *
* This header file contains the declarations of the %Long class.
+ *
+ * @see Number
*/
#ifndef _FBASE_LONG_H_
#define _FBASE_LONG_H_
*
* @since 2.0
*
- * The %Long class represents an integer value ranging from -2147483648 to 2147483647
- * , that is, -(2^31) to +((2^31)-1). The class is useful when passing a 32-bit @c signed
+ * The %Long class represents an integer value ranging from @c -2147483648 to @c 2147483647,
+ * that is, -(2^31) to +((2^31)-1). The class is useful when passing a 32-bit @c signed
* integral value to a method that accepts only an instance of Object. Furthermore,
* this class provides methods for converting %Long (and @c long) to String, and %String
* to %Long (and @c long).
*
* @since 2.0
*
- * @param[in] value A @c long value
+ * @param[in] value The @c long value
*/
Long(long value = 0);
*
* @since 2.0
*
- * @param[in] value An instance of %Long
+ * @param[in] value An instance of %Long to copy
*/
Long(const Long& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Long
+ * @param[in] rhs An instance of %Long to copy
*/
Long& operator =(const Long& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of @c l1 is less than the value of @c l2
* == 0 if the value of @c l1 is equal to the value of @c l2
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
*
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
* > 0 if the value of the current instance is greater than the value of the specified instance
* @endcode
- * @param[in] value An instance of the %Long class to compare
+ * @param[in] value An instance of %Long to compare
*/
int CompareTo(const Long& value) const;
/**
- * Checks whether the value of the specified instance of %Object is equal to the value of the current instance of %Long.
+ * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Long.
*
* @since 2.0
*
- * @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Long, @n
+ * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Long, @n
* else @c false
- * @param[in] obj An instance of %Object to compare
+ * @param[in] obj An instance of Object to compare
* @see Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Long
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Long
+ * @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. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c long value.
- *
- * @since 2.0
- *
- * @return An integer value indicating the hash value of the specified @c long value
- * @param[in] val A @c long value to get the hash value
- */
+ * Gets the hash value of the specified @c long value.
+ *
+ * @since 2.0
+ *
+ * @return The integer value that indicates the hash value of the specified @c long value
+ * @param[in] val The @c long value used to get the hash value
+ */
static int GetHashCode(long val);
/**
- * Decodes a string into a @c signed @c long.
+ * Decodes a string into a @c signed @c long value.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
+ * @param[in] s The string that represents the numeric value
* @param[out] ret The result of the operation
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
static result Decode(const String& s, long& ret);
/**
- * Parses the @c signed @c long equivalent of the specified string representing a numeric value.
+ * Parses the @c signed @c long equivalent of the specified string that represents a numeric value.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
+ * @param[in] s The string that represents the numeric value
* @param[out] ret The result of the operation
* @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 assumes that the string representing the numeric value uses a radix 10.
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method assumes that the string that represents the numeric value uses a radix @c 10.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, long& ret);
/**
- * Parses the @c signed @c long equivalent of the specified string representing a numeric value using the specified radix.
+ * Parses the @c signed @c long equivalent of the specified string that represents a numeric value using the specified radix.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[in] radix The radix of the string representing a numeric value @n
- * It must be either 2, 8, 10, or 16.
+ * @param[in] s The string that represents the numeric value
+ * @param[in] radix The radix of the string that represents the 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.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
* @exception E_OUT_OF_RANGE The specified @c radix is invalid.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int radix, long& ret);
/**
- * Gets the @c signed @c char equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c char equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual char ToChar(void) const;
/**
- * Gets the @c signed @c short equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c short equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual short ToShort(void) const;
/**
- * Gets the @c signed @c int equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c int equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual int ToInt(void) const;
/**
- * Gets the @c signed @c long equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c long equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual long ToLong(void) const;
/**
- * Gets the @c signed @c long @c long equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c long @c long equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual long long ToLongLong(void) const;
/**
- * Gets the @c signed @c float equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c float equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual float ToFloat(void) const;
/**
- * Gets the @c signed @c double equivalent of the current instance of the %Long class.
+ * Gets the @c signed @c double equivalent of the current instance of %Long.
*
* @since 2.0
*
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of the %Long class.
+ * Gets the string that represents the value of the current instance of %Long.
*
* @since 2.0
*
- * @return The string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c signed @c long value.
+ * Gets the string that represents the specified @c signed @c long value.
*
* @since 2.0
*
- * @return The string containing a Unicode representation of the specified @c signed @c long value
- * @param[in] value A @c signed @c long value to convert
+ * @return The string that contains the Unicode representation of the specified @c signed @c long value
+ * @param[in] value The @c signed @c long value to convert
*/
static String ToString(long value);
/**
- * A constant holding the maximum value a @c short can have; 2^31-1.
+ * The constant holding the maximum value a @c short value can have; 2^31-1.
*
* @since 2.0
*/
static const long VALUE_MAX = (long) 0x7FFFFFFF;
/**
- * A constant holding the minimum value a @c short can have; -2^31.
+ * The constant holding the minimum value a @c short value can have; -2^31.
*
* @since 2.0
*/
static const long VALUE_MIN = (long) 0x80000000;
/**
- * A @c long value of this instance.
+ * The @c long value of this instance.
*
* @since 2.0
*/
* @file FBaseLongComparer.h
* @brief This is the header file for the %LongComparer class.
*
- * @see Long and Tizen::Base::Collection::IComparer
*
* This header file contains the declarations of the %LongComparer class.
+ *
+ * @see Long
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_LONG_COMPARER_H_
#define _FBASE_LONG_COMPARER_H_
{
/**
* @class LongComparer
- * @brief This class checks for equivalence between 2 instances of the %Long type.
+ * @brief This class checks for equivalence between two instances of the %Long type.
*
* @since 2.0
*
- * The %LongComparer class checks for equivalence between 2 instances of the Long type.
+ * The %LongComparer class checks for equivalence between two instances of the Long type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 The first instance of type %Long
- * @param[in] obj2 The second instance of type %Long
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The first instance of type Long
+ * @param[in] obj2 The second instance of type Long
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
* @file FBaseLongLong.h
* @brief This is the header file for the %LongLong class.
*
- * @see Tizen::Base::Number
- *
* This header file contains the declarations of the %LongLong class.
+ *
+ * @see Tizen::Base::Number
*/
#ifndef _FBASE_LONG_LONG_H_
#define _FBASE_LONG_LONG_H_
*
* @since 2.0
*
- * The %LongLong class represents an integer value ranging from -9223372036854775808 to 9223372036854775807
- * , that is, -(2^63) to +((2^63)-1). The class is useful when passing a 64-bit @c signed
+ * The %LongLong class represents an integer value ranging from @c -9223372036854775808 to @c 9223372036854775807,
+ * that is, @c -(2^63) to @c +((2^63)-1). The class is useful when passing a 64-bit @c signed
* integral value to a method that accepts only an instance of Object. Furthermore,
* this class provides methods for converting %LongLong (and @c long @c long) to String, and %String
* to %LongLong (and @c long @c long).
*
* @since 2.0
*
- * @param[in] value A @c long @c long value
+ * @param[in] value The @c long @c long value
*/
LongLong(long long value = 0);
*
* @since 2.0
*
- * @param[in] value An instance of %LongLong
+ * @param[in] value An instance of %LongLong to copy
*/
LongLong(const LongLong& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %LongLong
+ * @param[in] rhs An instance of %LongLong to copy
*/
LongLong& operator =(const LongLong& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
- * < 0 if the value of @c l1 is less than the value of @c l2
- * == 0 if the value of @c l1 is equal to the value of @c l2
- * > 0 if the value of @c l1 is greater than the value of @c l2
+ * < 0 if the value of l1 is less than the value of l2
+ * == 0 if the value of l1 is equal to the value of l2
+ * > 0 if the value of l1 is greater than the value of l2
* @endcode
* @param[in] l1 The first @c long @c long value to compare
* @param[in] l2 The second @c long @c long value to compare
static int Compare(long long l1, long long l2);
/**
- * Compares the value of the current instance with the value of the specified instance of the %LongLong class.
+ * Compares the value of the current instance with the value of the specified instance of %LongLong.
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @code
* < 0 if the value of the current instance is less than the value of the specified instance
* == 0 if the value of the current instance is equal to the value of the specified instance
* > 0 if the value of the current instance is greater than the value of the specified instance
* @endcode
- * @param[in] value An instance of the %LongLong class to compare
+ * @param[in] value An instance of %LongLong to compare
*/
int CompareTo(const LongLong& value) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %LongLong
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %LongLong
+ * @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. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c long @c long value.
- *
- * @since 2.0
- *
- * @return An integer value indicating the hash value of the specified @c long @c long value
- * @param[in] val A @c long @c long value to get the hash value
+ * Gets the hash value of the specified @c long @c long value.
+ *
+ * @since 2.0
+ *
+ * @return The integer value that indicates the hash value of the specified @c long @c long value
+ * @param[in] val The @c long @c long value used to get the hash value
*/
static int GetHashCode(long long val);
/**
- * Gets the @c signed @c char equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c char equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual char ToChar(void) const;
/**
- * Gets the @c signed @c short equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c short equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual short ToShort(void) const;
/**
- * Gets the @c signed @c int equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c int equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual int ToInt(void) const;
/**
- * Gets the @c signed @c long equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c long equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual long ToLong(void) const;
/**
- * Gets the @c signed @c float equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c float equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual float ToFloat(void) const;
/**
- * Gets the @c signed @c double equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c double equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual double ToDouble(void) const;
/**
- * Gets the @c signed @c long @c long equivalent of the current instance of the %LongLong class.
+ * Gets the @c signed @c long @c long equivalent of the current instance of %LongLong.
*
* @since 2.0
*
virtual long long ToLongLong(void) const;
/**
- * Gets the string representing the value of the current instance of the %LongLong class.
+ * Gets the string that represents the value of the current instance of %LongLong.
*
* @since 2.0
*
- * @return The string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c signed @c long @c long value.
+ * Gets the string that represents the specified @c signed @c long @c long value.
*
* @since 2.0
*
- * @return The string containing a Unicode representation of the specified @c signed @c long @c long value
- * @param[in] value A @c signed @c long @c long value to convert
+ * @return The string that contains the Unicode representation of the specified @c signed @c long @c long value
+ * @param[in] value The @c signed @c long @c long value to convert
*/
static String ToString(long long value);
/**
- * Parses the specified string representing a numeric value and
+ * Parses the specified string that represents a numeric value and
* returns the value as a @c signed @c long @c long (as out parameter).
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
+ * @param[in] s The string that represents the numeric value
* @param[out] ret The result of the operation
* @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 assumes that the string representing the numeric value uses a radix 10.
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method assumes that the string that represents the numeric value uses a radix @c 10.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, long long& ret);
/**
- * Parses the specified string representing a numeric value using the specified radix and
+ * Parses the specified string that represents a numeric value using the specified radix and
* returns the value as a @c signed @c long @c long (as out parameter).
*
* @since 2.1
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[in] radix The radix of the string representing a numeric value @n
+ * @param[in] s The string that represents the numeric value
+ * @param[in] radix The radix of the string that represents 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.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
* @exception E_OUT_OF_RANGE The specified @c radix is invalid.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int radix, long long& ret);
/**
- * A constant holding the maximum value a @c long @c long can have; 2^63-1.
+ * The constant holding the maximum value a @c long @c long can have; @c 2^63-1.
*
* @since 2.0
*/
static const long long VALUE_MAX = (long long) 0x7FFFFFFFFFFFFFFFLL;
/**
- * A constant holding the minimum value a @c long @c long can have; -2^63.
+ * The constant holding the minimum value a @c long @c long can have; @c -2^63.
*
* @since 2.0
*/
static const long long VALUE_MIN = (long long) 0x8000000000000000LL;
/**
- * A @c long @c long value of this instance.
+ * The @c long @c long value of this instance.
*
* @since 2.0
*/
* @file FBaseLongLongComparer.h
* @brief This is the header file for the %LongLongComparer class.
*
- * @see Long and Tizen::Base::Collection::IComparer
*
* This header file contains the declarations of the %LongLongComparer class.
+ *
+ * @see Long
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_LONG_LONG_COMPARER_H_
#define _FBASE_LONG_LONG_COMPARER_H_
{
/**
* @class LongLongComparer
- * @brief This class checks for equivalence between 2 instances of the %LongLong type.
+ * @brief This class checks for equivalence between two instances of the %LongLong type.
*
* @since 2.0
*
- * The %LongLongComparer class checks for equivalence between 2 instances of the %LongLong type.
+ * The %LongLongComparer class checks for equivalence between two instances of the LongLong type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @return An error code
* @param[in] obj1 The first instance of type LongLong
* @param[in] obj2 The second instance of type LongLong
- * @param[out] cmp The result of comparison
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
* @file FBaseNumber.h
* @brief This is the header file for the %Number class.
*
- * This header file contains the declarations and definitions of the %Number class. @n
- * This class is the abstract base class of all wrapped numeric types.
+ * This header file contains the declarations and definitions of the %Number class.
+ *
*/
#ifndef _FBASE_NUMBER_H_
#define _FBASE_NUMBER_H_
virtual ~Number(void) { };
/**
- * Gets the @c signed @c char equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c char equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual char ToChar(void) const = 0;
/**
- * Gets the @c signed @c short equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c short equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual short ToShort(void) const = 0;
/**
- * Gets the @c signed @c int equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c int equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual int ToInt(void) const = 0;
/**
- * Gets the @c signed @c long equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c long equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual long ToLong(void) const = 0;
/**
- * Gets the @c signed @c long @c long equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c long @c long equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual long long ToLongLong(void) const = 0;
/**
- * Gets the @c signed @c float equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c float equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual float ToFloat(void) const = 0;
/**
- * Gets the @c signed @c double equivalent of the current instance of the %Number class.
+ * Gets the @c signed @c double equivalent of the current instance of %Number.
*
* @since 2.0
*
virtual double ToDouble(void) const = 0;
/**
- * Gets the string representing the value of the current instance of the %Number class.
+ * Gets the string that represents the value of the current instance of %Number.
*
* @since 2.0
*
- * @return The string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const = 0;
* @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Object, @n
* else @c false
* @param[in] obj An instance of %Object to compare
- * @remarks The default implementation of this method returns @c true
- * if the two instances have the same address. @n
- * The method can be overridden to support value equality. Furthermore, this method must return the same result as the equality operator.
+ * @remarks
+ * - The default implementation of this method returns @c true,
+ * if the two instances have the same address.
+ * - The method can be overridden to support value equality.
+ * Furthermore, this method must return the same result as the equality operator.
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Object
- * @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. @n
- * The default implementation of this method returns the address of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Object
+ * @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.
+ * - The default implementation of this method returns the address of the current instance.
*/
virtual int GetHashCode(void) const;
* @file FBaseResult.h
* @brief This is the header file for the %Result class.
*
- * This header file contains the declaration of the %Result class.
+ * This header file contains the declarations of the %Result class.
*/
#ifndef _FBASE_RESULT_H_
#define _FBASE_RESULT_H_
#define NUMARGS(...) (sizeof((result[]){0, ##__VA_ARGS__}) / sizeof(result) - 1)
/**
-* This macro returns translated exception when the checked exception doesn't correspond with the conditional exceptions.
-* In contrast, this macro returns the checked exception if it corresponds with the conditional exceptions.
+* This macro returns a translated exception when the checked exception does not correspond to the conditional exceptions.
+* In contrast, this macro returns a checked exception if it corresponds to the conditional exceptions.
*
* @since 2.0
*
* @return The translated exception
-* @param[in] r The result that will be checked
+* @param[in] r The result that is checked
* @param[in] e The translated exception
-* @param[in] ... The list of exceptions that will be excluded in translation process @n
-* All other exceptions than this list will be translated into @c e.
+* @param[in] ... The list of exceptions that are excluded from the translation process @n
+* All the exceptions other than this list are translated into @c e.
*
*
*/
/**
-* This macro returns translated exception when the checked exception corresponds with the conditional exceptions.
-* In contrast, this macro returns the checked exception if it doesn't correspond with the conditional exceptions.
+* This macro returns a translated exception when the checked exception corresponds to the conditional exceptions.
+* In contrast, this macro returns a checked exception if it does not correspond to the conditional exceptions.
*
* @since 2.0
*
* @return The translated exception
-* @param[in] r The result that will be checked
+* @param[in] r The result that is checked
* @param[in] e The translated exception
-* @param[in] ... The list of exceptions that will be included in translation process @n
-* All exceptions in this list will be translated into @c e.
+* @param[in] ... The list of exceptions that are included in the translation process @n
+* All the exceptions in this list are translated into @c e.
*
*/
* @file FBaseShort.h
* @brief This is the header file for the %Short class.
*
- * @see Number()
- *
* This header file contains the declarations of the %Short class.
+ *
+ * @see Number
*/
#ifndef _FBASE_SHORT_H_
#define _FBASE_SHORT_H_
*
* @since 2.0
*
- * @param[in] value A @c short value
+ * @param[in] value The @c short value
*/
Short(short value = 0);
*
* @since 2.0
*
- * @param[in] value An instance of %Short
+ * @param[in] value An instance of %Short to copy
*/
Short(const Short& value);
*
* @since 2.0
*
- * @return A 32-bit @c signed @c integer value
+ * @return The 32-bit @c signed @c integer value
* @param[in] s1 The first @c short value to compare
* @param[in] s2 The second @c short value to compare
*
* @code
- * < 0 if @c s1 is less than @c s2
- * == 0 if @c s1 is equal to @c s2
- * > 0 if @c s1 is greater than @c s2
+ * < 0 if s1 is less than s2
+ * == 0 if s1 is equal to s2
+ * > 0 if s1 is greater than s2
* @endcode
*/
static int Compare(short s1, short s2);
/**
- * Compares the value of the current instance of the %Short class
- * with the value of the specified instance of the %Short class.
+ * Compares the value of the current instance of %Short
+ * with the value of the specified instance of %Short.
*
* @since 2.0
*
- * @return A @c signed 32-bit @c integer value
- * @param[in] value An instance of the %Short class to compare
+ * @return The @c signed 32-bit @c integer value
+ * @param[in] value An instance of %Short to compare
*
* @code
- * < 0 if the value of the current instance is less than that of the specified instance
- * == 0 if the value of the current instance is equal to that of the specified instance
- * > 0 if the value of the current instance is greater than that of the specified instance
+ * < 0 if the value of the current instance is less than the specified instance
+ * == 0 if the value of the current instance is equal to the specified instance
+ * > 0 if the value of the current instance is greater than the specified instance
* @endcode
*/
int CompareTo(const Short& value) const;
*
* @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Short, @n
* else @c false
- * @param[in] obj An instance of Object to compare
+ * @param[in] obj An instance of Object to compare
* @remarks The method returns @c false if the specified object is not of the
* type @c short.
* @see Tizen::Base::Object::Equals()
*
* @return @c true if the value of the current instance is equal to the specified @c short value, @n
* else @c false
- * @param[in] value A @c short value to compare
+ * @param[in] value The @c short value to compare
*/
bool Equals(short value) const;
*
* @since 2.0
*
- * @return An integer value indicating the hash value of the current instance of %Short
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @return The integer value that indicates the hash value of the current instance of %Short
+ * @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. @n
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the hash value of the specified @c short value.
+ * Gets the hash value of the specified @c short value.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An integer value indicating the hash value of the specified @c short value
- * @param[in] val A @c short value to get the hash value
+ * @return The integer value that indicates the hash value of the specified @c short value
+ * @param[in] val The @c short value used to get the hash value
*/
static int GetHashCode(short val);
*
* @since 2.0
*
- * @return An error code
- * @param[in] s A numeric value
- * @param[out] ret The result of the operation
+ * @return An error code
+ * @param[in] s The numeric value
+ * @param[out] ret The result of the operation
* @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 accepts decimal, hexadecimal, and octal numbers given by the
static result Decode(const String& s, short& ret);
/**
- * Parses the specified string representing a numeric value and
+ * Parses the specified string that represents a numeric value and
* returns the value as @c signed @c short.
*
* @since 2.0
*
- * @return An error code
- * @param[in] s A string representing a numeric value
+ * @return An error code
+ * @param[in] s The string that represents the numeric value
* @param[out] ret The result of the operation
* @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 assumes that the string representing the numeric value uses a radix 10.
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method assumes that the string that represents the numeric value that uses a radix @c 10.
+ * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, short& ret);
/**
- * Parses the specified string representing a numeric value
+ * Parses the specified string that represents a numeric value
* using the specified radix and returns the value as @c signed @c short.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A string representing a numeric value
- * @param[in] radix The radix of the string representing a numeric value @n
- * It must either be @c 2, @c 8, @c 10, or @c 16.
+ * @param[in] s The string that represents the numeric value
+ * @param[in] radix The radix of the string that represents the numeric value @n
+ * It must either be 2, 8, 10, or 16.
* @param[out] ret The result of the operation
* @exception E_SUCCESS The method is successful.
* @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
* @exception E_OUT_OF_RANGE The specified @c radix is invalid.
- * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& s, int radix, short& ret);
/**
- * Gets the @c signed @c char equivalent of the current instance of the %Short class.
+ * Gets the @c signed @c char equivalent of the current instance of %Short.
*
* @since 2.0
*
- * @return A @c signed @c char equivalent of the current instance
+ * @return The @c signed @c char equivalent of the current instance
*/
virtual char ToChar(void) const;
/**
- * Gets the @c signed @c short equivalent of the current instance of the %Short class.
+ * Gets the @c signed @c short equivalent of the current instance of %Short.
*
* @since 2.0
*
- * @return A @c signed @c short equivalent of the current instance
+ * @return The @c signed @c short equivalent of the current instance
*/
virtual short ToShort(void) const;
/**
- * Gets the @c signed @c int equivalent of the current instance of the %Short class.
+ * Gets the @c signed @c int equivalent of the current instance of %Short.
*
* @since 2.0
*
- * @return A @c signed @c int equivalent of the current instance
+ * @return The @c signed @c int equivalent of the current instance
*/
virtual int ToInt(void) const;
/**
- * Gets the @c signed @c long equivalent of the current instance of the %Short class.
+ * Gets the @c signed @c long equivalent of the current instance of %Short.
*
* @since 2.0
*
- * @return A @c signed @c long equivalent of the current instance
+ * @return The @c signed @c long equivalent of the current instance
*/
virtual long ToLong(void) const;
/**
- * Gets the @c signed @c long @c long equivalent of the current instance of the %Short class.
- *
- * @since 2.0
- *
- * @return A @c signed @c long @c long equivalent of the current instance
- */
+ * Gets the @c signed @c long @c long equivalent of the current instance of %Short.
+ *
+ * @since 2.0
+ *
+ * @return The @c signed @c long @c long equivalent of the current instance
+ */
virtual long long ToLongLong(void) const;
/**
- * Gets the @c signed @c float equivalent of the current instance of the %Short class.
+ * Gets the @c signed @c float equivalent of the current instance of %Short.
*
* @since 2.0
*
- * @return A @c signed @c float equivalent of the current instance
+ * @return The @c signed @c float equivalent of the current instance
*/
virtual float ToFloat(void) const;
/**
- * Gets the @c signed @c double equivalent of the current instance of the %Short class.
+ * Gets the @c signed @c double equivalent of the current instance of %Short.
*
* @since 2.0
*
- * @return A @c signed @c double equivalent of the current instance
+ * @return The @c signed @c double equivalent of the current instance
*/
virtual double ToDouble(void) const;
/**
- * Gets the string representing the value of the current instance of the %Short class.
+ * Gets the string that represents the value of the current instance of %Short.
*
* @since 2.0
*
- * @return A string representing the value of the current instance
+ * @return The string that represents the value of the current instance
*/
virtual String ToString(void) const;
/**
- * Gets the string representing the specified @c signed @c short value.
+ * Gets the string that represents the specified @c signed @c short value.
*
* @since 2.0
*
- * @return A string containing a Unicode representation of the specified @c signed @c short value
- * @param[in] value A @c signed @c short value to convert
+ * @return The string that contains the Unicode representation of the specified @c signed @c short value
+ * @param[in] value The @c signed @c short value to convert
*/
static String ToString(short value);
/**
- * A constant holding the maximum value a @c short will be equal to 2^15-1.
+ * The constant holding the maximum value a @c short can be equal to 2^15-1.
*
* @since 2.0
*/
static const short VALUE_MAX = (short) 0x7FFF;
/**
- * A constant holding the minimum value a @c short will be equal to -2^15.
+ * The constant holding the minimum value a @c short can be equal to -2^15.
*
* @since 2.0
*/
static const short VALUE_MIN = (short) 0x8000;
/**
- * A @c short value of this instance.
+ * The @c short value of this instance.
*
* @since 2.0
*/
* @file FBaseShortComparer.h
* @brief This is the header file for the %ShortComparer class.
*
+ * This header file contains the declarations of the %ShortComparer class.
+ *
* @see Short
* @see Tizen::Base::Collection::IComparer
- *
- * This header file contains the declarations of the %ShortComparer class.
*/
#ifndef _FBASE_SHORT_COMPARER_H_
#define _FBASE_SHORT_COMPARER_H_
{
/**
* @class ShortComparer
- * @brief This class compares 2 instances of the %Short type for equivalence.
+ * @brief This class compares two instances of the %Short type for equivalence.
*
* @since 2.0
*
- * The %ShortComparer class compares 2 instances of the Short type for equivalence.
+ * The %ShortComparer class compares two instances of the Short type for equivalence.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
*
* @since 2.0
*
- * @return An error code
- * @param[in] obj1 An object of Short to compare
- * @param[in] obj2 An object of Short to compare
- * @param[out] cmp The result of comparison
+ * @return An error code
+ * @param[in] obj1 The object of Short to compare
+ * @param[in] obj2 The object of Short to compare
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
- * @remarks The value of @c cmp can be:
+ * @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
*
* @since 2.0
*
- * @param[in] capacity The default capacity of this instance
+ * @param[in] capacity The default capacity of this instance
*/
String(int capacity);
*
* @since 2.0
*
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
String(wchar_t ch);
*
* @since 2.0
*
- * @param[in] pValue A pointer to an array of Unicode characters
+ * @param[in] pValue A pointer to the array of Unicode characters
*/
String(const wchar_t* pValue);
*
* @since 2.0
*
- * @param[in] pValue A pointer to an array of UTF-8 characters
+ * @param[in] pValue A pointer to the array of UTF-8 characters
*/
String(const char* pValue);
*
* @since 2.0
*
- * @param[in] value An instance of %String
+ * @param[in] value An instance of %String to copy
*/
String(const String& value);
/**
- * TThis destructor overrides Tizen::Base::Object::~Object().
+ * This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
*
- * @remarks The internally allocated memory block is freed when the instance is destroyed.
+ * @remarks The internally allocated memory block is freed when the instance is destroyed.
*/
virtual ~String(void);
/**
- * Returns the Unicode character at the specified @c index.
+ * Gets the Unicode character at the specified index.
*
* @since 2.0
*
- * @return A const reference to the Unicode character
- * @param[in] index An index within the current instance of %String
+ * @return A constant reference to the Unicode character
+ * @param[in] index The index within the current instance of %String
*/
const wchar_t& operator [](int index) const;
/**
- * Returns a reference to the Unicode character at the specified @c index.
+ * Gets a reference to the Unicode character at the specified index.
*
* @since 2.0
*
* @return A reference to the Unicode character
- * @param[in] index An index within the current instance of %String
+ * @param[in] index The index within the current instance of %String
*/
wchar_t& operator [](int index);
* @since 2.0
*
* @return A reference to the %String instance
- * @param[in] pRhs A pointer to an array of Unicode characters
+ * @param[in] pRhs A pointer to the array of Unicode characters
*/
String& operator =(const wchar_t* pRhs);
* @since 2.0
*
* @return A reference to the %String instance
- * @param[in] rhs An instance of %String
+ * @param[in] rhs An instance of %String to copy
*/
String& operator =(const String& rhs);
* @since 2.0
*
* @return A reference to the %String instance
- * @param[in] pRhs A pointer to an array of Unicode characters
+ * @param[in] pRhs A pointer to the array of Unicode characters
*/
String& operator +=(const wchar_t* pRhs);
*
* @since 2.0
*
- * @return The concatenated %String instance
+ * @return The concatenated %String instance
* @param[in] lhs A reference to the %String instance on the left-hand side of the operator
* @param[in] rhs A reference to the %String instance on the right-hand side of the operator
*/
*
* @since 2.0
*
- * @return @c true if the text of the specified %String instance equals the calling instance's text, @n
+ * @return @c true if the text of the specified %String instance equals the calling instance's text, @n
* else @c false
- * @param[in] rhs A reference to the %String instance on the right-hand side of the operator
- * @remarks The operator performs an ordinal comparison of each Unicode character.
+ * @param[in] rhs A reference to the %String instance on the right-hand side of the operator
+ * @remarks The operator performs an ordinal comparison of each Unicode character.
*/
bool operator ==(const String& rhs) const;
*
* @since 2.0
*
- * @return @c true if the text of the specified %String instance is not equal to the calling instance's text, @n
+ * @return @c true if the text of the specified %String instance is not equal to the calling instance's text, @n
* else @c false
* @param[in] rhs A reference to the %String instance on the right-hand side of the operator
- * @remarks The operator performs an ordinal comparison of each Unicode character.
+ * @remarks The operator performs an ordinal comparison of each Unicode character.
*/
bool operator !=(const String& rhs) const;
* @since 2.0
*
* @return An error code
- * @param[in] ch A @c wchar_t value to insert
+ * @param[in] ch The @c wchar_t value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(wchar_t ch);
* @since 2.0
*
* @return An error code
- * @param[in] ch A @c char value to insert
+ * @param[in] ch The @c char value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(char ch);
/**
- * Appends the string representing the specified 32-bit @c int value to this
+ * Appends the string that represents the specified 32-bit @c int value to this
* instance of %String.
*
* @since 2.0
*
* @return An error code
- * @param[in] i A 32-bit integer value to insert
+ * @param[in] i The 32-bit integer value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(int i);
/**
- * Appends the string representing the specified @c short value to this
+ * Appends the string that represents the specified @c short value to this
* instance of %String.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A @c short value to insert
+ * @param[in] s The @c short value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(short s);
/**
- * Appends the string representing the specified @c long value to this
+ * Appends the string that represents the specified @c long value to this
* instance of %String.
*
* @since 2.0
*
* @return An error code
- * @param[in] l A @c long value to insert
+ * @param[in] l The @c long value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(long l);
/**
- * Appends the string representing the specified @c long @c long value to this
+ * Appends the string that represents the specified @c long @c long value to this
* instance of %String.
*
* @since 2.0
*
* @return An error code
- * @param[in] ll A @c long @c long value to insert
+ * @param[in] ll The @c long @c long value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(long long ll);
/**
- * Appends the string representing the specified @c float value to this
+ * Appends the string that represents the specified @c float value to this
* instance of %String.
*
* @since 2.0
*
* @return An error code
- * @param[in] f A @c float value to insert
+ * @param[in] f The @c float value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(float f);
/**
- * Appends the string representing the specified @c double value to this
+ * Appends the string that represents the specified @c double value to this
* instance of %String.
*
* @since 2.0
*
* @return An error code
- * @param[in] d A @c double value to insert
+ * @param[in] d The @c double value to insert
* @exception E_SUCCESS The method is successful.
*/
result Append(double d);
* @since 2.0
*
* @return An error code
- * @param[in] p A pointer to a Unicode character array
+ * @param[in] p A pointer to the Unicode character array
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A @c null pointer is passed.
*/
* @since 2.0
*
* @return An error code
- * @param[in] str An instance of %String to append
+ * @param[in] str An instance of %String to append
* @exception E_SUCCESS The method is successful.
*/
result Append(const String& str);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @param[in] str0 The first %String instance to compare
* @param[in] str1 The second %String instance to compare
- * @remarks This method performs an ordinal comparison of each Unicode
- * character contained in the two given %String instances.
+ * @remarks This method performs an ordinal comparison of each Unicode
+ * character contained in the two given %String instances. @n
* For instance, "U+xxx" is greater than "U+XXX", but smaller than "U+yyy".
*
* @code
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
- *@code
+ * @return The 32-bit @c signed integer value
+ * @code
* < 0 if the value of the current instance is less than the value of the specified %String instance
* == 0 if the value of the current instance is equal to the value of the specified %String instance
* > 0 if the value of the current instance is greater than the value of the specified %String instance
- *@endcode
+ * @endcode
* @param[in] str An instance of %String to compare
- * @remarks This method performs an ordinal comparison of each Unicode character. For instance,
- * L"U+xxx" is greater than L"U+XXX", but smaller than L"U+yyy".
+ * @remarks This method performs an ordinal comparison of each Unicode character. @n
+ * For instance, L"U+xxx" is greater than L"U+XXX", but smaller than L"U+yyy".
*/
int CompareTo(const String& str) const;
* @since 2.0
*
* @return An error code
- * @param[in] minLength A minimum length to ensure
+ * @param[in] minLength The minimum length to ensure
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c minLength is negative.
*/
* else @c false
*
* @remarks This method performs an ordinal comparison of each Unicode
- * character contained in the two given %String instances.
+ * character contained in the two given %String instances.
*/
bool Equals(const String& str, bool caseSensitive) const;
* @param[in] length The maximum number of wide characters to write, including the terminating @c null character
* @param[in] pFormat The wide character format specifier
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c length is negative or @c pFormat is @c null.
- * @remarks If an "l" modifier is present in @c pFormat (for example, L"@%ls"), it is a pointer to an array of wide characters. @n
- * @remarks A pointer to an array of UTF-8 characters is not allowed in the Format() method (for example, Format(20, L"@%s", pUTF8Str)).
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c length is negative.
+ * - The specified @c pFormat is @c null.
+ * @remarks
+ * - If an "l" modifier is present in @c pFormat (for example, L"@%ls"), it is a pointer to an array of wide characters.
+ * - A pointer to an array of UTF-8 characters is not allowed in the Format() method (for example, Format(20, L"@%s", pUTF8Str)).
* The following format specifiers are supported in this method:
* @code
* specifier Output
*
* @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 hash function used must generate a random distribution
- * for all inputs.
+ * @return The hash value of the current instance
+ * @remarks Two equal instances must return the same hash value. @n
+ * For better performance, the hash function used must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
* @param[in] indexAt The position of the character
* @param[out] ch The character at the specified index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result GetCharAt(int indexAt, wchar_t& ch) const;
/**
* Searches for a character in the calling instance. @n
- * Gets the index of the first character that matches to
+ * Gets the index of the first character that matches
* the specified character in this instance.
*
* @since 2.0
*
* @return An error code
* @param[in] ch The Unicode character to locate
- * @param[in] startIndex The starting position of search
+ * @param[in] startIndex The starting position of the search
* @param[out] indexOf The index of the character
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified character is not found.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified character is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
*/
result IndexOf(wchar_t ch, int startIndex, int& indexOf) const;
* @param[out] indexOf The index of the substring
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified string is not found.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
*/
result IndexOf(const String& str, int startIndex, int& indexOf) const;
/**
- * Inserts the string representing the specified Unicode character
+ * Inserts the string that represents the specified Unicode character
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
*
- * @param[in] ch A Unicode character to insert
+ * @param[in] ch The Unicode character to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(wchar_t ch, int indexAt);
/**
- * Inserts the string representing the specified @c char value
+ * Inserts the string that represents the specified @c char value
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
*
- * @param[in] ch A @c char value to insert
+ * @param[in] ch The @c char value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(char ch, int indexAt);
/**
- * Inserts the string representing the specified 16-bit integer
+ * Inserts the string that represents the specified 16-bit integer
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] s A 16-bit integer value to insert
+ * @param[in] s The 16-bit integer value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(short s, int indexAt);
/**
- * Inserts the string representing the specified 32-bit integer
+ * Inserts the string that represents the specified 32-bit integer
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] i A 32-bit integer value to insert
+ * @param[in] i The 32-bit integer value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(int i, int indexAt);
/**
- * Inserts the string representing the specified @c long value
+ * Inserts the string that represents the specified @c long value
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] l A @c long value to insert
+ * @param[in] l The @c long value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(long l, int indexAt);
/**
- * Inserts the string representing the specified @c long @c long value
+ * Inserts the string that represents the specified @c long @c long value
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] ll A @c long @c long value to insert
+ * @param[in] ll The @c long @c long value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(long long ll, int indexAt);
/**
- * Inserts the string representing the specified @c float value
+ * Inserts the string that represents the specified @c float value
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] f A @c float value to insert
+ * @param[in] f The @c float value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(float f, int indexAt);
/**
- * Inserts the string representing the specified @c double value
+ * Inserts the string that represents the specified @c double value
* at the specified position in the calling instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] d A @c double value to insert
+ * @param[in] d The @c double value to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(double d, int indexAt);
/**
- * Inserts the string representing the specified @c null-terminated
+ * Inserts the string that represents the specified @c null-terminated
* string at the specified position in the calling instance.
*
* @since 2.0
* @param[in] p An instance of %String to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
* @exception E_INVALID_ARG A @c null pointer is passed.
*/
result Insert(const wchar_t* p, int indexAt);
/**
- * Inserts the string representing the specified instance of %String
+ * Inserts the string that represents the specified instance of %String
* at the specified position in the calling instance.
*
* @since 2.0
* @param[in] str An instance of %String to insert
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result Insert(const String& str, int indexAt);
*
* @return An error code
* @param[in] ch The Unicode character to locate
- * @param[in] startIndex The starting position of search
+ * @param[in] startIndex The starting position of the search
* @param[out] indexOf The index of character
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified character is not found.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
*/
result LastIndexOf(wchar_t ch, int startIndex, int& indexOf) const;
*
* @return An error code
* @param[in] str An instance of %String to locate
- * @param[in] startIndex The starting position of search
+ * @param[in] startIndex The starting position of the search
* @param[out] indexOf The index of the substring
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified character is not found.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0.
- * @remarks If the substring is empty, E_SUCCESS is returned and the value of @c indexOf is set to @c startIndex.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
+ * @remarks If the substring is empty, @c E_SUCCESS is returned and the value of @c indexOf is set to @c startIndex.
*/
result LastIndexOf(const String& str, int startIndex, int& indexOf) const;
* @param[in] startIndex The position where the removal begins
* @param[in] length The number of characters to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is out of range. @n
- * - The specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. @n
- * - The specified @c count is either greater than the length of substring starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is either greater than the length of the substring starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
*/
result Remove(int startIndex, int length);
/**
- * Replaces all occurrences of the specified characters.
+ * Replaces all the occurrences of the specified characters.
*
* @since 2.0
*
- * @param[in] original The character to replace
- * @param[in] replace The character to replace all occurrences of @c original
+ * @param[in] original The character to replace
+ * @param[in] replace The character to replace all the occurrences of @c original
*/
void Replace(wchar_t original, wchar_t replace);
/**
- * Replaces all occurrences of the specified string.
+ * Replaces all the occurrences of the specified string.
*
* @since 2.0
*
* @return An error code
* @param[in] original An instance of %String to replace
- * @param[in] replace An instance of %String to replace all occurrences of @c original
+ * @param[in] replace An instance of %String to replace all the occurrences of @c original
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c original is an empty string.
*/
result Replace(const String& original, const String& replace);
/**
- * Replaces all occurrences of the specified string within the substring
+ * Replaces all the occurrences of the specified string within the substring
* of this instance of %String.
*
* @since 2.0
*
* @return An error code
* @param[in] original An instance of %String to replace
- * @param[in] replace An instance of %String to replace all occurrences of @c original
+ * @param[in] replace An instance of %String to replace all the occurrences of @c original
* @param[in] startIndex The starting position of the substring
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c original is an empty string.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
*/
result Replace(const String& original, const String& replace, int startIndex);
/**
- * Reverses the sequence of characters in the calling instance.
+ * Reverses the sequence of the characters in the calling instance.
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[in] ch A new character
+ * @param[in] ch The new character
* @param[in] indexAt The position of the character
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c indexAt is either greater than or equal to the length of the current instance.
+ * - The specified @c indexAt is less than @c 0.
*/
result SetCharAt(wchar_t ch, int indexAt);
* @param[in] newLength The new length
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c newLength is negative.
- * @remarks If the new length is greater than the current length, the
- * string is padded with spaces. On the other hand,
- * if the new length is smaller than the current length, then
- * the text contained in this instance is truncated.
+ * @remarks If the new length is greater than the current length, the
+ * string is padded with spaces. @n
+ * On the other hand, if the new length is smaller than the current length, then
+ * the text contained in this instance is truncated.
*/
result SetLength(int newLength);
* @param[in] startIndex The starting index of the substring
* @param[out] out The substring
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range, or
- * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
*/
result SubString(int startIndex, String& out) const;
* @param[in] length The length of the substring
* @param[out] out The substring
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is out of range. @n
- * - The specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. @n
- * - The specified @c length is either greater than the length of substring starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is out of the valid range.
+ * - The specified @c startIndex is either greater than or equal to the length of the current instance.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c length is either greater than the length of the substring starting from @c startIndex.
+ * - The specified @c length is less than @c 0.
*/
result SubString(int startIndex, int length, String& out) const;
*
* @since 2.0
*
- * @return @c true if this instance starts with the specified text, @n
+ * @return @c true if this instance starts with the specified text, @n
* else @c false
* @param[in] str The string to match
* @param[in] startIndex The start position of the string
*
* @since 2.0
*
- * @return @c true if this instance ends with the specified text, @n
+ * @return @c true if this instance ends with the specified text, @n
* else @c false
* @param[in] str An instance of %String to match
*/
* Gets the lowercase form of the string in the calling instance. @n
* Unicode characters other than the English alphabets are not changed.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToLowerCase(%String& out) method that supports Unicode characters other than the English alphabets.
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as a new method has been introduced.
+ * Instead of using this method, use the ToLowerCase(%String& out) method that supports Unicode characters other than the English alphabets.
+ * @since 2.0
*
* @return An error code
- * @param[out] out An instance of %String that contains the modified value of the calling instance
+ * @param[out] out An instance of %String that contains the modified value of the calling instance
* @exception E_SUCCESS The method is successful.
* @endif
*/
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToUpperCase(%String& out) method that supports Unicode characters other than the English alphabets.
+ * Instead of using this method, use the ToUpperCase(%String& out) method that supports Unicode characters other than the English alphabets.
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[out] out An instance of %String that contains the modified value of the calling instance
* @exception E_SUCCESS The method is successful.
* @endif
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[out] out An instance of %String that contains the modified value of the calling instance
* @exception E_SUCCESS The method is successful.
*/
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets.
+ * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
* @endif
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets.
+ * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
* @endif
* @since 2.0
*
* @return A Unicode pointer to the calling instance's internal buffer
- * @remarks GetPointer() does not guarantee that every call to this function returns same address.
+ * @remarks GetPointer() does not guarantee that every call to this method returns the same address.
*/
const wchar_t* GetPointer(void) const;
*
* @since 2.0
*
- * @return @c true if this instance contains the specified substring, @n
- * else @c false
+ * @return @c true if this instance contains the specified substring, @n
+ * else @c false
* @param[in] str The string to match
*/
bool Contains(const String& str) const;
/**
- * A constant holding the default capacity of %String.
+ * The constant holding the default capacity of %String.
*
* @since 2.0
*/
//
/**
- * @file FBaseStringComparer.h
+ * @file FBaseStringComparer.h
* @brief This is the header file for the %StringComparer class.
*
- * @see String and Tizen::Base::Collection::IComparer
- *
* This header file contains the declarations of the %StringComparer class.
+ *
+ * @see String
+ * @see Tizen::Base::Collection::IComparer
*/
#ifndef _FBASE_STRING_COMPARER_H_
#define _FBASE_STRING_COMPARER_H_
{
/**
* @class StringComparer
- * @brief This class checks for equivalence between 2 instances of the %String type.
+ * @brief This class checks for equivalence between two instances of the %String type.
*
* @since 2.0
*
- * The %StringComparer class checks for equivalence between 2 instances of the String type.
+ * The %StringComparer class checks for equivalence between two instances of the String type.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 An object of String to compare
- * @param[in] obj2 An object of String to compare
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The object of String to compare
+ * @param[in] obj2 The object of String to compare
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
*
* @since 2.1
*
- * @return The hash code of an instance of type String
+ * @return The hash code of the instance of type String
* @param[in] str The String instance whose hash code is requested
- * @remarks The hash algorithm is usually specific to a type.
- * 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
+ * - The hash algorithm is usually specific to a type.
+ * - 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(const Tizen::Base::String& str) const;
*
* @return The hash code of the specified object
* @param[in] obj The Object whose hash code is requested
- * @remarks The hash algorithm is usually specific to a type.
- * 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
+ * - The hash algorithm is usually specific to a type.
+ * - 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(const Tizen::Base::Object& obj) const;
* @file FBaseSysLog.h
* @brief This is the header file for the %Log macros.
*
- * This header file defines the %Log macros.
+ * This header file defines the Log macros.
*/
#ifndef _FBASE_SYS_LOG_H_
/**
* @mainpage Tizen Platform API Reference
*
- * The Tizen platform API Reference provides descriptions of APIs for the platform developers.
+ * The Tizen platform API Reference provides the description of APIs for the platform developers.
*/
/**
* @defgroup GroupMacros Debugging Macros
*
- * This page describes Tizen debugging macros used by the Tizen modules.
- * These debugging macros should use specific NID ( Namespace ID ) to distinguish each Tizen modules.
+ * This page describes the Tizen debugging macros used by the Tizen modules.
+ * These debugging macros should use specific NIDs ( Namespace ID ) to distinguish each Tizen module.
*
* @since 2.0
*/
*/
/**
- * This macro allows display of informative log messages.
+ * This macro allows the display of informative log messages.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] ... The message to display
+ * @param[in] ... The message to display
*
- * The following example demonstrates how to use the SysLog macro.
+ * The following example demonstrates how to use the %SysLog macro.
*
* @code
* bool
#define SysLog(NID, ...) SysLogInternal(NID, __PRETTY_FUNCTION__, __LINE__, __VA_ARGS__)
/**
- * This macro allows display of exception log messages with a tag and sets the last result.
+ * This macro allows the display of exception log messages with a tag and sets the last result.
* This system log macro is for the platform modules.
*
* @since 2.0
#define SysLogException(NID, r, ...) SysLogExceptionInternal(NID, r, __PRETTY_FUNCTION__, __LINE__, __VA_ARGS__)
/**
- * This macro allows display of informative log messages with a tag.
+ * This macro allows the display of informative log messages with a tag.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
* @param[in] tag The user defined tag
- * @param[in] ... The message to display
+ * @param[in] ... The message to display
*
* The following example demonstrates how to use the SysLogTag macro.
*
#define SysLogTag(NID, tag, ...) SysLogTagInternal(NID, tag, __PRETTY_FUNCTION__, __LINE__, __VA_ARGS__)
/**
- * This macro allows display of exception log messages with a tag and sets the last result.
+ * This macro allows the display of exception log messages with a tag and sets the last result.
* This system log macro is for the platform modules.
*
* @since 2.0
* @param[in] NID The Tizen namespace
* @param[in] tag The user defined tag
* @param[in] r The last result to set
- * @param[in] ... The message to display
+ * @param[in] ... The message to display
*
* The following example demonstrates how to use the SysLogTagException macro.
*
/**
- * This macro allows display of informative log message with a tag, when the condition is @c false.
+ * This macro allows the display of informative log messages with a tag, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
*
* The following example demonstrates how to use the SysTryLog macro.
} while (0);
/**
- * This macro allows display of informative log message, when the condition is @c false.
- * Executes statements and goes to label.
+ * This macro allows the display of informative log messages, when the condition is @c false.
+ * Executes statements and goes to the catch label.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] ... The message to display
*
* The following example demonstrates how to use the SysTryLogCatch macro.
} while (0);
/**
- * This macro allows display of informative log message and returns returnValue, when the condition is @c false.
+ * This macro allows the display of informative log messages and returns @c returnValue, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
*
- * @param[in] NID The Tizen namespace
+ * @param[in] NID The Tizen namespace
* @param[in] condition The condition that is expected to be true
- * @param[in] returnValue The value to return when the condition is @c false
- * @param[in] ... The message to display
+ * @param[in] returnValue The value to return when the condition is @c false
+ * @param[in] ... The message to display
*
* The following example demonstrates how to use the SysTryLogReturn macro.
*
/**
- * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false.
+ * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] returnValue The value to return when the condition is @c false
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] returnValue The value to return when the condition is @c false
* @param[in] r The last result to set
* @param[in] ... The message to display
*
} while (0);
/**
- * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false.
+ * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false.
* This is a shorthand macro for SysTryReturn(NID, condition, r, r, "[" # r "] " ...).
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] r The last result to set
* @param[in] ... The message to display
*
} while (0);
/**
- * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false.
+ * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] r The last result to set
* @param[in] ... The message to display
*
} while (0);
/**
- * This macro allows display of exception log message with a tag, when the condition is @c false.
- * Executes statements, sets the last result and goes to label.
+ * This macro allows the display of exception log messages with a tag, when the condition is @c false.
+ * Executes statements, sets the last result and goes to the catch label.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] r The last result to set
* @param[in] ... The message to display
*
} while (0);
/**
- * This macro allows display of exception log message with a tag, when the condition is @c false.
- * Executes statements, sets the last result and goes to label.
+ * This macro allows the display of exception log messages with a tag, when the condition is @c false.
+ * Executes statements, sets the last result and goes to the catch label.
* This system log macro is for the platform modules.
*
* @since 2.0
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to catchLabel label
- * @param[in] catchLabel The label for goto operation
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
+ * @param[in] catchLabel The label for the goto operation
* @param[in] r The last result to set
* @param[in] ... The message to display
*
/**
- * This macro allows display of exception log message and the program will expire, when the condition is @c false.
+ * This macro allows the display of exception log messages and the program expires, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
} while (0);
/**
- * This macro allows display of exception log message with a tag and the program will expire, when the condition is @c false.
+ * This macro allows the display of exception log messages with a tag and the program expires, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
*
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
*
* The following example demonstrates how to use the SysAssertf macro.
/**
- * This macro generates an error message during compile time, when the condition is @c false.
+ * This macro generates an error message during the compile time, when the condition is @c false.
* This system log macro is for the platform modules.
*
* @since 2.0
/**
- * This macro allows display of exception log messages.
+ * This macro allows the display of exception log messages.
* This system log macro is for the platform modules.
*
* @since 2.0
#else
/**
- * This macro is to protect informative log messages which needs to keep security.
- * It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect informative log messages which need security.
+ * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
#define SysSecureLog(NID, ...)
/**
- * This macro is to protect exception log messages which needs to keep security, and sets the last result.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro is used to protect exception log messages which needs security, and sets the last result.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
#define SysSecureLogException(NID, r,...) SetLastResult(r);
/**
- * This macro is to protect informative log messages which needs to keep security, with a tag.
- * It allows display of informative log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, it will be removed in the compile time.
+ * This macro is used to protect informative log messages which need security, with a tag.
+ * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, it is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
#define SysSecureLogTag(NID, tag, ...)
/**
- * This macro is to protect exception log messages which needs to keep security, with a tag and sets the last result.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro is used to protect exception log messages which need security, with a tag and sets the last result.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
#endif
/**
- * This macro allows display of informative log message with a tag, when the condition is @c false.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of informative log messages with a tag, when the condition is @c false.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] ... The message to display
*
* The following example demonstrates how to use the SysSecureTry macro.
} while (0);
/**
- * This macro allows display of informative log message, when the condition is @c false.
- * Executes statements and goes to label.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of informative log messages, when the condition is @c false.
+ * Executes statements and goes to the catch label.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] ... The message to display
* @hideinitializer
*/
} while (0);
/**
- * This macro allows display of informative log message and returns returnValue, when the condition is @c false.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of informative log messages and returns @c returnValue, when the condition is @c false.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] returnValue The value to return when the condition is @c false
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] returnValue The value to return when the condition is @c false
* @param[in] ... The message to display
* @hideinitializer
*/
} while (0);
/**
- * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] returnValue The value to return when the condition is @c false
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] returnValue The value to return when the condition is @c false
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
#if defined(_SECURE_LOG)
/**
- * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false.
+ * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false.
* This is a shorthand macro for SysSecureTryReturn(NID, condition, r, r, "[" # r "] " ...).
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
#endif
/**
- * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
+ * @param[in] condition The condition that is expected to be true
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
} while (0);
/**
- * This macro allows display of exception log message with a tag, when the condition is @c false.
- * Executes statements, sets the last result and goes to label.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of exception log messages with a tag, when the condition is @c false.
+ * Executes statements, sets the last result and goes to the catch label.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to CATCH label
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
} while (0);
/**
- * This macro allows display of exception log message with a tag, when the condition is @c false.
- * Executes statements, sets the last result and goes to label.
- * It allows display of exception log messages if compiled with "_SECURE_LOG" definition.
- * Otherwise, log printing functionality will be removed in the compile time.
+ * This macro allows the display of exception log messages with a tag, when the condition is @c false.
+ * Executes statements, sets the last result and goes to the catch label.
+ * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition.
+ * Otherwise, the log printing functionality is removed in the compile time.
* This system log macro is for the platform modules.
*
* @since 2.1
*
* @param[in] NID The Tizen namespace
- * @param[in] condition The condition that is expected to be true
- * @param[in] expr Expressions that are evaluated before going to catchLabel label
- * @param[in] catchLabel The label for goto operation
+ * @param[in] condition The condition that is expected to be true
+ * @param[in] expr Expressions that are evaluated before going to the CATCH label
+ * @param[in] catchLabel The label for the goto operation
* @param[in] r The last result to set
* @param[in] ... The message to display
* @hideinitializer
bool operator !=(const TimeSpan& rhs) const;
/**
- * Checks whether the value of the calling instance is less than that of
- * the specified instance of %TimeSpan.
+ * Checks whether the value of the calling instance is less than
+ * the value of the specified instance of %TimeSpan.
*
* @since 2.0
*
- * @return @c true if the value of the calling instance is less than that of the specified instance of %TimeSpan, @n
+ * @return @c true if the value of the calling instance is less than the value of the specified instance of %TimeSpan, @n
* else @c false
* @param[in] rhs An instance of %TimeSpan to compare
*/
bool operator <(const TimeSpan& rhs) const;
/**
- * Checks whether the value of the calling instance is greater than that of
- * the specified instance of %TimeSpan.
+ * Checks whether the value of the calling instance is greater than
+ * the value of the specified instance of %TimeSpan.
*
* @since 2.0
*
- * @return @c true if the value of the calling instance is greater than that of the specified instance of %TimeSpan, @n
+ * @return @c true if the value of the calling instance is greater than the value of the specified instance of %TimeSpan, @n
* else @c false
* @param[in] rhs An instance of %TimeSpan to compare
*/
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @param[in] t1 An instance of %TimeSpan to compare
* @param[in] t2 An instance of %TimeSpan to compare
*
* @code
- * < 0 if the value of @c t1 is less than the value of @c t2
- * == 0 if the value of @c t1 is equal to the value of @c t2
- * > 0 if the value of @c t1 is greater than the value of @c t2
+ * < 0 if the value of t1 is less than the value of t2
+ * == 0 if the value of t1 is equal to the value of t2
+ * > 0 if the value of t1 is greater than the value of t2
* @endcode
*/
static int Compare(const TimeSpan& t1, const TimeSpan& t2);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
+ * @return The 32-bit @c signed integer value
* @param[in] value An instance of %TimeSpan to compare
*
* @code
- * < 0 if the value of the current instance is less than the value of @c obj
- * == 0 if the value of the current instance is equal to the value of @c obj
- * > 0 if the value of the current instance is greater than the value of @c obj
+ * < 0 if the value of the current instance is less than the value of obj
+ * == 0 if the value of the current instance is equal to the value of obj
+ * > 0 if the value of the current instance is greater than the value of obj
* @endcode
*/
int CompareTo(const TimeSpan& value) const;
*
* @since 2.0
*
- * @return An instance of %TimeSpan containing the absolute value
- * @remarks This method is used to get absolute difference between two %TimeSpan instances.
+ * @return An instance of %TimeSpan that contains the absolute value
+ * @remarks This method is used to get the absolute difference between two %TimeSpan instances.
*
* @code
* TimeSpan t1(1000); // 1000 milliseconds
*
* @since 2.0
*
- * @return An instance of %Timespan containing the negative value of the calling instance
+ * @return An instance of %Timespan that contains the negative value of the calling instance
*/
TimeSpan Negate(void) const;
long long GetTicks(void) const;
/**
- * A constant holding the number of ticks in a day.
+ * The constant holding the number of ticks in a day.
*
* @since 2.0
*/
static const long long NUM_OF_TICKS_IN_DAY = 86400000LL;
/**
- * A constant holding the number of ticks in an hour.
+ * The constant holding the number of ticks in an hour.
*
* @since 2.0
*/
static const long long NUM_OF_TICKS_IN_HOUR = 3600000LL;
/**
- * A constant holding the number of ticks in a minute.
+ * The constant holding the number of ticks in a minute.
*
* @since 2.0
*/
static const long long NUM_OF_TICKS_IN_MINUTE = 60000LL;
/**
- * A constant holding the number of ticks in a second.
+ * The constant holding the number of ticks in a second.
*
* @since 2.0
*/
*/
enum SortOrder
{
- SORT_ORDER_ASCENDING = 0, /**< A constant for sorting the results in ascending order */
- SORT_ORDER_DESCENDING, /**< A constant for sorting the results in descending order */
- SORT_ORDER_NONE /**< A constant for indicating the results are not sorted */
+ SORT_ORDER_ASCENDING = 0, /**< A constant for sorting the results in the ascending order */
+ SORT_ORDER_DESCENDING, /**< A constant for sorting the results in the descending order */
+ SORT_ORDER_NONE /**< A constant for indicating that the results are not sorted */
};
*/
enum ComparisonOperator
{
- COMPARISON_OP_EQUAL = 0, /**< A comparison operator that checks the value equality */
- COMPARISON_OP_NOT_EQUAL, /**< A comparison operator that checks the value inequality */
+ COMPARISON_OP_EQUAL = 0, /**< A comparison operator that checks the value's equality */
+ COMPARISON_OP_NOT_EQUAL, /**< A comparison operator that checks the value's inequality */
COMPARISON_OP_GREATER_THAN, /**< A comparison operator that checks whether a value is greater than the other */
COMPARISON_OP_LESS_THAN, /**< A comparison operator that checks whether a value is less than the other */
COMPARISON_OP_GREATER_THAN_EQUAL_TO, /**< A comparison operator that checks whether a value is greater than or equal to the other */
#include <FBaseUtilScanner.h>
/**
- * @namespace Tizen::Base::Utility
- * @brief This namespace contains classes for various utilities.
+ * @namespace Tizen::Base::Utility
+ * @brief This namespace contains classes for various utilities.
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FBase.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* The %Utility namespace contains interfaces and classes that
* define various utilities of an object, such as Math and StringTokenizer.
- * It also contains methods to perform some common functions needed by the applications, such as file zipping and URL encoding and decoding.
+ * It also contains methods to perform some common functions needed by applications, such as file zipping, and URL encoding and decoding.
*
- * For more information on the %
Base::Utility namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/utility_namespace.htm">Utility</a>.
+ * For more information on the %Utility namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/utility_namespace.htm">Utility</a>.
*
* The following diagram illustrates the relationships between the classes belonging to the %Utility namespace.
* @image html base_utility_namespace_classdiagram.png
* @return A pointer to the ByteBuffer instance with the deflated equivalent of the source buffer @n
* The buffer's limit is the length of the deflated data, @n
* else @c null if an exception occurs.
- * @param[in] src The buffer to deflate
- * @param[in] byteCount The number of bytes to deflate from the source buffer
- * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
- * By default, it is set to @c DEFAULT_COMPRESSION.
- * @exception E_SUCCESS The method is successful.
+ * @param[in] src The buffer to deflate
+ * @param[in] byteCount The number of bytes to deflate from the source buffer
+ * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
+ * By default, it is set to @c DEFAULT_COMPRESSION.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @return A pointer to the ByteBuffer instance with the deflated equivalent of the source buffer @n
* The buffer's limit is the length of the deflated data, @n
* else @c null if an exception occurs.
- * @param[in] src The buffer to deflate
- * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
- * By default, it is set to @c DEFAULT_COMPRESSION.
- * @exception E_SUCCESS The method is successful.
+ * @param[in] src The buffer to deflate
+ * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
+ * By default, it is set to @c DEFAULT_COMPRESSION.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Utility::Inflator
*/
/**
* Initializes this instance of %FileUnzipper with the specified filepath. @n
- * This method opens a zip file in the read mode.
+ * The %Construct() method opens a zip file in the read mode.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] filePath The path of the file to open or create
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @param [in] filePath The path of the file to open or create
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified file path is inaccessible as per the %Tizen platform policy.
+ * @exception E_ILLEGAL_ACCESS The specified @c filePath is inaccessible as per the Tizen platform policy.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_IO An unexpected device failure has occurred.
+ * @exception E_IO An unexpected device failure has occurred.
* @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
* @see Tizen::Io::File
*/
* Unzips a zip file at the specified path or destination.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] dirPath A directory path to unzip
+ * @param [in] dirPath The directory path to unzip
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
* @exception E_IO An unexpected device failure has occurred.
- * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
- * @remarks This operation consumes a lot of time if the zip-archive contains large number of files or
- * directories.
- * In such cases, it is recommended to call this method in a separate thread.
+ * @remarks
+ * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
+ * - This operation consumes a lot of time if the zip-archive contains large number of files or
+ * directories. @n
+ * In such cases, it is recommended to call this method in a separate thread.
* @see Tizen::Io::File
*/
result UnzipTo(const String& dirPath) const;
* Unzips a zip entry from a zip-archive to the specified path.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] dirPath A directory path to unzip
- * @param [in] zipEntryName A zip entry name that could be a file or directory name
+ * @param [in] dirPath The directory path to unzip
+ * @param [in] zipEntryName The zip entry name that could be a file or a directory name
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations. @n
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The entry of the specified file or path cannot be found in the archive.
* @exception E_IO An unexpected device failure has occurred.
- * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
- * @remarks If the value of @c zipEntryName is a directory name present in the archive, this method
+ * @remarks
+ * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
+ * - If the value of @c zipEntryName is a directory name present in the archive, this method
* creates an empty directory. @n
* For example, UnzipTo(Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/", L"/someDir/") will create @b '[AppDataPath]/Test/someDir'
- * directory only, and the files or subdirectories under @b 'someDir' will not be extracted.
+ * directory only, and the files or subdirectories under @b 'someDir' are not extracted.
* @see Tizen::Io::File
*/
result UnzipTo(const String& dirPath, const String& zipEntryName) const;
int GetDirectoryCount(void) const;
/**
- * Gets a zip entry associated with the file or directory name passed as parameter.
+ * Gets a zip entry associated with the file or directory name passed as a parameter.
*
* @since 2.0
*
* @return An error code
- * @param [in] zipEntryName A zip entry name that could be a file or directory name
+ * @param [in] zipEntryName The zip entry name that could be a file or directory name
* @param [out] entry A reference to the ZipEntry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
* @exception E_FILE_NOT_FOUND The entry of the specified file or path cannot be found in the archive.
* @exception E_IO An unexpected device failure has occurred.
- * @remarks If the value of @c zipEntryName is a directory name, it must have a suffix '/'.
- * For example, @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/" or @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/DATA/".
+ * @remarks If the value of @c zipEntryName is a directory name, it must have a suffix '/'. @n
+ * For example, @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/" or @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/DATA/".
*/
result GetEntry(const String& zipEntryName, ZipEntry& entry) const;
* @since 2.0
*
* @return An error code
- * @param [in] index An index of the zip entry to access @n
+ * @param [in] index The index of the zip entry to access @n
* The index starts from @c 0.
* @param [out] entry A reference to the ZipEntry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified index is out of range, or an invalid index is passed.
+ * @exception E_INVALID_ARG The specified index is either invalid or out of the valid range.
* @exception E_IO An unexpected device failure has occurred.
*/
result GetEntry(int index, ZipEntry& entry) const;
/**
* Initializes this instance of %FileZipper with the specified filepath. @n
- * This method opens an existing zip file in append mode. If the file does not exist, it creates and opens the file in
+ * This method opens an existing zip file in the append mode. If the file does not exist, it creates and opens the file in the
* append mode.
*
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] filePath The path of the zip file to open or create
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @param [in] filePath The path of the zip file to open or create
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
- * @exception E_IO An unexpected device failure has occurred.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
+ * @exception E_IO An unexpected device failure has occurred.
* @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
* @see Tizen::Io::File
*/
* @endif
*
* @return An error code
- * @param [in] filePath The path of the file to add to the zip file
- * @param [in] excludePath Set to @c true to exclude the path and to store only the file name, @n
- * else @c false to insert the entire path name in the zip-archive
- * @param [in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
- * By default, it is set to @c DEFAULT_COMPRESSION.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
- * - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found.
+ * @param [in] filePath The path of the file to add to the zip file
+ * @param [in] excludePath Set to @c true to exclude the path and to store only the file name, @n
+ * else @c false to insert the entire path name in the zip-archive
+ * @param [in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n
+ * By default, it is set to @c DEFAULT_COMPRESSION.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
+ * - The specified path is invalid.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found.
* @exception E_FILE_ALREADY_EXIST The specified file already exists in the zip-archive, but the
* flag for overwriting the file is not set.
- * @exception E_IO An unexpected device failure has occurred.
- * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
- * @remarks If the value of @c excludePath is set to @c false, full path name is inserted to the zip-
+ * @exception E_IO An unexpected device failure has occurred.
+ * @remarks
+ * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
+ * - If the value of @c excludePath is set to @c false, the full path name is inserted to the zip-
* archive. Therefore, developers should handle the path name carefully. @n
- * For example, if you add @b '/Test/data.txt' file to the zip-archive, and if the
- * @c excludePath parameter is set to @c false, while unzipping the file in @b '/Test'
+ * For example, if you add @b '/Test/data.txt' file to the zip-archive, and if
+ * @c excludePath is set to @c false, while unzipping the file in @b '/Test'
* directory, then the file is extracted in @b '/Test/Test/data.txt'.
* @see Tizen::Io::File
*/
* @return A pointer to the ByteBuffer instance with the inflated equivalent of the source buffer @n
* The buffer's limit is the length of the inflated data, @n
* else @c null if an exception occurs.
- * @param[in] src The buffer to inflate
- * @param[in] byteCount The number of bytes to inflate from the source buffer
- * @exception E_SUCCESS The method is successful.
+ * @param[in] src The buffer to inflate
+ * @param[in] byteCount The number of bytes to inflate from the source buffer
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Utility::Deflator
*/
* @return A pointer to the ByteBuffer instance with the inflated equivalent of the source buffer @n
* The buffer's limit is the length of the inflated data, @n
* else @c null if an exception occurs.
- * @param[in] src The buffer to inflate
- * @exception E_SUCCESS The method is successful.
+ * @param[in] src The buffer to inflate
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Utility::Deflator
*/
* @param[in] linkType The link type
* @param[in] link The link
* @remarks The link's @c text is set to the same string as @c link.
- * @see Tizen::Base::Utility::LinkType
*/
LinkInfo(LinkType linkType, const Tizen::Base::String& link);
*
* @param[in] linkType The link type
* @param[in] link The link
- * @param[in] text A string that represents the link
- * @see Tizen::Base::Utility::LinkType
+ * @param[in] text The string that represents the link
*/
LinkInfo(LinkType linkType, const Tizen::Base::String& link, const Tizen::Base::String& text);
* @since 2.0
*
* @return A reference to the calling instance
- * @param[in] rhs An instance of %LinkInfo
+ * @param[in] rhs An instance of %LinkInfo to copy
*/
LinkInfo& operator =(const LinkInfo& rhs);
*
* @return The link type
* @see SetLinkType()
- * @see Tizen::Base::Utility::LinkType
*/
LinkType GetLinkType(void) const;
*
* @param[in] linkType The link type
* @see GetLinkType()
- * @see Tizen::Base::Utility::LinkType
*/
void SetLinkType(LinkType linkType);
{
/**
* @class Math
- * @brief This class is the wrapper class for %Math Library.
+ * @brief This class is the wrapper class for the %Math Library.
*
* @since 2.0
*
static int Abs(int x);
/**
- * Gets the arc sine of the specified @c double integer. @n
+ * Gets the arc sine of the specified @c double integer. @n
* Returns a value between @c -PI/2 and @c PI/2.
*
* @since 2.0
*
* @return The arc sine of the input, @n
- * else Not-a-Number if @c x is out of range
+ * else Not-a-Number if @c x is out of the valid range
* @param[in] x A radian angle @n
- * It must be within the range @c -1 to @c 1 (inclusive).
+ * It must be within the range @c -1 to @c 1 (inclusive).
* @see Acos()
* @see Atan()
*/
static double Asin(double x);
/**
- * Gets the arc cosine of the specified double integer. @n
+ * Gets the arc cosine of the specified double integer. @n
* Returns a value between @c 0 and @c PI.
*
* @since 2.0
*
* @return The arc cosine of the input, @n
- * else Not-a-Number if @c x is out of range
+ * else Not-a-Number if @c x is out of the valid range
* @param[in] x A radian angle @n
- * It must be within the range @c -1 to @c 1 (inclusive).
+ * It must be within the range @c -1 to @c 1 (inclusive).
* @see Asin()
* @see Atan()
*/
static double Acos(double x);
/**
- * Gets the arc tangent of the specified @c double integer. @n
+ * Gets the arc tangent of the specified @c double integer. @n
* Returns a value between @c -PI/2 and @c PI/2.
*
* @since 2.0
*
* @return The arc tangent of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
* @see Asin()
* @see Acos()
*/
* @since 2.0
*
* @return The smallest integer that is greater than or equal to the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Ceiling(double x);
/**
- * Gets the cosine of the specified @c double integer. @n
+ * Gets the cosine of the specified @c double integer. @n
* Returns a value between @c -1 and @c 1.
*
* @since 2.0
*
- * @return The cosine of the input
+ * @return The cosine of the input
* @param[in] x A radian angle
* @see Sin()
* @see Tan()
static double Cos(double x);
/**
- * Gets the hyperbolic cosine of the specified @c double integer.
+ * Gets the hyperbolic cosine of the specified @c double integer.
*
* @since 2.0
*
static double Cosh(double x);
/**
- * Gets the exponential value of the specified @c double integer.
+ * Gets the exponential value of the specified @c double integer.
*
* @since 2.0
*
* @return The exponential value of the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Exp(double x);
* @since 2.0
*
* @return The largest @c double integer that is less than or equal to the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Floor(double x);
* @since 2.0
*
* @return The natural logarithm of the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Log(double x);
* @since 2.0
*
* @return The logarithm to the base 10 of the input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Log10(double x);
* @since 2.0
*
* @return The greater of the two integer values
- * @param[in] x An integer value
- * @param[in] y An integer value
+ * @param[in] x An integer value
+ * @param[in] y An integer value
* @see Min()
*/
static int Max(int x, int y);
* @since 2.0
*
* @return The greater of the two floating point values
- * @param[in] x A floating point value
- * @param[in] y A floating point value
- * @see Min()
+ * @param[in] x A floating point value
+ * @param[in] y A floating point value
+ * @see Min()
*/
static double Max(double x, double y);
* @since 2.0
*
* @return The smaller of the two integer values
- * @param[in] x An integer value
- * @param[in] y An integer value
+ * @param[in] x An integer value
+ * @param[in] y An integer value
* @see Max()
*/
static int Min(int x, int y);
* @since 2.0
*
* @return The smaller of the two @c double values
- * @param[in] x A floating point value
- * @param[in] y A floating point value
+ * @param[in] x A floating point value
+ * @param[in] y A floating point value
* @see Max()
*/
static double Min(double x, double y);
* @since 2.0
*
* @return @c x raised to the power of @c y, @n
- * else Not-a-Number if @c x and @c y do not satisfy the conditions described below
- * @param[in] x A floating point value
- * @param[in] y A floating point value
- * @remarks @li @c x cannot be negative if @c y is a fractional value.
- * @li @c x cannot be @c 0 if @c y is less than or equal to @c 0.
+ * else Not-a-Number if @c x and @c y do not satisfy the conditions described below
+ * @param[in] x A floating point value
+ * @param[in] y A floating point value
+ * @remarks
+ * - @li @c x cannot be negative if @c y is a fractional value.
+ * - @li @c x cannot be @c 0 if @c y is less than or equal to @c 0.
*/
static double Pow(double x, double y);
* @since 2.0
*
* @return The closest integer to the specified input
- * @param[in] x A floating point value
+ * @param[in] x A floating point value
*/
static double Round(double x);
/**
- * Gets the sine of the specified @c double integer. @n
+ * Gets the sine of the specified @c double integer. @n
* Returns a value between @c -1 and @c 1.
*
* @since 2.0
*
* @return The sine of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
* @see Cos()
* @see Tan()
*/
static double Sin(double x);
/**
- * Gets the hyperbolic sine of the specified @c double integer.
+ * Gets the hyperbolic sine of the specified @c double integer.
*
* @since 2.0
*
* @return The hyperbolic sine of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
*/
static double Sinh(double x);
* @since 2.0
*
* @return The square root of the input, @n
- * else Not-a-Number if @c x is a negative number
- * @param[in] x A non-negative floating point value
+ * else Not-a-Number if @c x is a negative number
+ * @param[in] x A non-negative floating point value
*/
static double Sqrt(double x);
/**
- * Gets the tangent of the specified @c double integer.
+ * Gets the tangent of the specified @c double integer.
*
* @since 2.0
*
* @return The tangent of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
* @see Sin()
* @see Cos()
*/
* @since 2.0
*
* @return The hyperbolic tangent of the input
- * @param[in] x A radian angle
+ * @param[in] x A radian angle
*/
static double Tanh(double x);
*
* @since 2.0
*
- * @param[in] seed An integer value to use as seed by the pseudo-random number generator algorithm
+ * @param[in] seed The integer value used as a seed by the pseudo-random number generator algorithm
* @see Rand()
*/
static void Srand(unsigned int seed);
*
* @since 2.0
*
- * @return An integer value between @c 0 and @c RAND_VALUE_MAX
+ * @return The integer value between @c 0 and @c RAND_VALUE_MAX
* @remarks This method uses a seed to generate the pseudo-random numbers, that must be initialized to some distinctive value using Srand().
* @see Srand()
*/
static int Rand(void);
/**
- * Gets the constant value of E (the base of natural logarithms).
+ * Gets the constant value of E (the base of natural logarithms).
*
* @since 2.0
*
static const double GetE(void);
/**
- * Gets the constant value of PI.
+ * Gets the constant value of PI.
*
* @since 2.0
*
static const double GetPi(void);
/**
- * The maximum value that can be returned by the Rand() method.
- *
- * @since 2.0
- */
+ * The maximum value that can be returned by the Rand() method.
+ *
+ * @since 2.0
+ */
static const int RAND_VALUE_MAX = 32767; // 0x7fff
*/
enum RegularExpressionOptions
{
- REGEX_CASELESS = 0x00000001, /**< The case insensitive match option */
- REGEX_MULTI_LINE = 0x00000002, /**< The multiple lines match option @n
- Without this option, (^) matches only at the start of the string, while ($) matches only at
- the end of the string, or before a terminating newline. */
- REGEX_DOTALL = 0x00000004, /**< The dot matches newlines option @n
- Without this option, a dot does not match when the current position is at a newline. */
+ REGEX_CASELESS = 0x00000001, /**< The case insensitive match option */
+ REGEX_MULTI_LINE = 0x00000002, /**< The multiple lines match option @n
+ Without this option, (^) matches only at the start of the string, while ($) matches only at
+ the end of the string, or before a terminating newline */
+ REGEX_DOTALL = 0x00000004, /**< The dot matches newlines option @n
+ Without this option, a dot does not match when the current position is at a newline */
REGEX_EXTENDED = 0x00000008, /**< The ignored whitespaces in a pattern */
- REGEX_DOLLAR_ENDONLY = 0x00000020, /**< The option to match the dollar symbol ($) only at the end @n
- Without this option, a dollar symbol also matches immediately before a newline. */
- REGEX_UNGREEDY = 0x00000200, /**< The option to reverse the (*) and (*?) symbols @n
- If this option is set, the quantifiers are not greedy by default, however they are, if followed by a question mark. */
- REGEX_UNICODE = 0x01000000, /**< The option to support the unicode characters @n
- Without this option, only the ASCII characters are recognized. */
+ REGEX_DOLLAR_ENDONLY = 0x00000020, /**< The option to match the dollar symbol ($) only at the end @n
+ Without this option, a dollar symbol also matches immediately before a newline */
+ REGEX_UNGREEDY = 0x00000200, /**< The option to reverse the (*) and (*?) symbols @n
+ If this option is set, the quantifiers are not greedy by default, however they are, if followed by a question mark */
+ REGEX_UNICODE = 0x01000000, /**< The option to support the unicode characters @n
+ Without this option, only the ASCII characters are recognized */
};
/**
* @class RegularExpression
- * @brief This class provides the functionality for a regular expression.
+ * @brief This class provides the functionality for a regular expression.
*
* @since 2.0
*
- * The %RegularExpression class provides operations of a regular expression based on PCRE and the syntax based on
+ * The %RegularExpression class provides the operations of a regular expression based on PCRE and the syntax based on
* the Perl regular expression.
* The various supported operations are Match(), Replace(), and Consume().
*
* @since 2.0
*
* @return An error code
- * @param[in] pattern The pattern to use
- * @param[in] options The option for the regular expression
- * @exception E_SUCCESS The method is successful.
+ * @param[in] pattern The pattern to use
+ * @param[in] options The option for the regular expression
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has already been constructed.
- * @exception E_INVALID_ARG The length of the specified @c pattern parameter is @c 0.
+ * @exception E_INVALID_ARG The length of the specified @c pattern is @c 0.
*
* The following example demonstrates how to use the %Construct() method.
* @code
*
* @return @c true if the text matches successfully, @n
* else @c false
- * @param[in] text The text to match
- * @param[in] fullMatch Set to @c true to match exactly, @n
- * else @c false to match any substring of the text
- * @param[out] pMatchedString A list of the matched string instances @n
- * The count of the matched items is acquired from IList::GetCount() and
- * the maximum count of the items is @c 16.
+ * @param[in] text The text to match
+ * @param[in] fullMatch Set to @c true to match exactly, @n
+ * else @c false to match any substring of the text
+ * @param[out] pMatchedString The list of the matched string instances @n
+ * The count of the matched items is acquired from IList::GetCount() and
+ * the maximum count of the items is @c 16.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been constructed as yet.
- * @exception E_INVALID_ARG The length of the specified @c text parameter is @c 0.
+ * @exception E_INVALID_ARG The length of the specified @c text is @c 0.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - If the grouping subpatterns are used in a pattern,
- * the @c pMatchedString list will contain the grouping data. @n
+ * - If the grouping subpatterns are used in a pattern, the @c pMatchedString list contains the grouping data. @n
* For example, if the pattern has two grouping subpatterns,
- * there will be three data sets in the @c pMatchedString list. @n
- * The first data set will be a full grouping data and the second
- * and the third data sets will contain individual grouping data.
- * - Because this method returns a new instance through an out-parameter @c pMatchedString,
+ * there are three data sets in the @c pMatchedString list.
+ * The first data set contains full grouping data while the second
+ * and third data set contains individual grouping data.
+ * Because this method returns a new instance through an out-parameter @c pMatchedString,
* the caller needs to delete it after use. @n
- * Setting the element deleter of @c pMatchedString to SingleObjectDeleter is recommended.
+ * - Setting the element deleter of @c pMatchedString to SingleObjectDeleter is recommended.
*
* The following example demonstrates how to use the %Match() method.
*
/**
* Matches the pattern from the starting point of the text and removes the matched string. @n
- * If the pattern does not match the text at the starting point, it will return @c false.
+ * If the pattern does not match the text at the starting point, it returns @c false.
*
* @since 2.0
*
* @return @c true if the text matches successfully, @n
* else @c false
- * @param[in, out] text The text to consume
- * @param[out] pMatchedString A list of matched string instances @n
- * The count of the matched items is acquired from IList::GetCount() and
- * the maximum count of the items is @c 16.
+ * @param[in, out] text The text to consume
+ * @param[out] pMatchedString The list of matched string instances @n
+ * The count of the matched items is acquired from IList::GetCount() and
+ * the maximum count of the items is @c 16.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been constructed as yet.
- * @exception E_INVALID_ARG The length of the specified @c text parameter is @c 0.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the grouping subpatterns are used in a pattern, the @c pMatchedString list will
- * contain the grouping data. @n
+ * @exception E_INVALID_ARG The length of the specified @c text is @c 0.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the grouping subpatterns are used in a pattern, the @c pMatchedString list
+ * contains grouping data. @n
* For example, if the pattern has two grouping subpatterns,
- * there will be three data sets in the @c pMatchedString list. @n
- * The first data set will be a full grouping data and the second
- * and the third data sets will contain individual grouping data.
+ * there are three data sets in the @c pMatchedString list. @n
+ * The first data set contains full grouping data while the second
+ * and the third data set contains individual grouping data.
*
* The following example demonstrates how to use the %Consume() method.
* @code
*
* @return @c true if the text matches successfully, @n
* else @c false
- * @param[in, out] text The text to find and consume
- * @param[out] pMatchedString A list of matched string instances @n
- * The count of the matched items is acquired from IList::GetCount() and
- * the maximum count of the items is @c 16.
+ * @param[in, out] text The text to find and consume
+ * @param[out] pMatchedString The list of matched string instances @n
+ * The count of the matched items is acquired from IList::GetCount() and
+ * the maximum count of the items is @c 16.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been constructed as yet.
- * @exception E_INVALID_ARG The length of the specified @c text parameter is @c 0.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the grouping subpatterns are used in a pattern,
- * the @c pMatchedString list will contain the grouping data. @n
+ * @exception E_INVALID_ARG The length of the specified @c text is @c 0.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the grouping subpatterns are used in a pattern,
+ * the @c pMatchedString list contains grouping data. @n
* For example, if the pattern has two grouping subpatterns,
- * there will be three data sets in the @c pMatchedString list. @n
- * The first data set will be a full grouping data and the second
- * and the third data sets will contain individual grouping data.
+ * there are three data sets in the @c pMatchedString list. @n
+ * The first data set contains full grouping data while the second
+ * and the third data sets contains individual grouping data.
*
* The following example demonstrates how to use the %FindAndConsume() method.
*
*
* @return @c true if the text is replaced successfully, @n
* else @c false
- * @param[in, out] text The text to replace when it is matched to a pattern
- * @param[in] rewrite The text with which to replace
- * @param[in] globalReplace Set to @c true to replace globally, @n
- * else @c false to replace the first match of the pattern in the text
- * @param[in] startPos The starting position of the text
+ * @param[in, out] text The text to replace when it is matched to a pattern
+ * @param[in] rewrite The text with which to replace
+ * @param[in] globalReplace Set to @c true to replace globally, @n
+ * else @c false to replace the first match of the pattern in the text
+ * @param[in] startPos The starting position of the text
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been constructed as yet.
- * @exception E_INVALID_ARG The length of the specified @c pattern parameter is @c 0, or
- * the size of @c pMatchedString exceeds limitations.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified @c pattern is @c 0.
+ * - The size of @c pMatchedString exceeds the limitations.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
* The following example demonstrates how to use the %Replace() method.
*
* @return @c true if the text is extracted successfully, @n
* else @c false
- * @param[in] text The text to match
- * @param[in] rewrite The text to replace
- * @param[out] out The text to extract
+ * @param[in] text The text to match
+ * @param[in] rewrite The text to replace
+ * @param[out] out The text to extract
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance has not been constructed as yet.
- * @exception E_INVALID_ARG The length of the specified @c pattern parameter is @c 0, or
- * the size of @c pMatchedString exceeds limitations.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified @c pattern is @c 0.
+ * - The size of @c pMatchedString exceeds the limitations.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*
* The following example demonstrates how to use the %Extract() method.
*
* @since 2.0
*
- * @return The pattern used to compile the regular expression @n An empty string if this instance is not initialized
+ * @return The pattern used to compile the regular expression, @n
+ * else an empty string if this instance is not initialized
*/
Tizen::Base::String GetPattern(void) const;
*
* @since 2.0
*
- * @param[in] options The logical OR operator values of RegularExpressionOptions
+ * @param[in] options The logical OR operator values of RegularExpressionOptions
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The value of @c options is invalid.
+ * @exception E_INVALID_ARG The value of the specified @c options is invalid.
*/
result SetOptions(unsigned long options);
{
/**
* @class Scanner
- * @brief This class provides to parse primitive types and strings, and supports to use regular expressions and various encoding schemes.
+ * @brief This class provides methods to parse primitive types and strings, and supports the use of regular expressions and various encoding schemes.
* @since 2.1
*
- * The %Scanner class breaks the input, which can be either a %String instance or strings from a file, into tokens using a delimiter.
+ * The %Scanner class breaks the input, which can either be a String instance or strings from a file, into tokens using a delimiter.
* The delimiter is set to whitespace as a default value. The resulting tokens are converted into values of different types according
* to the methods in %Scanner.
*
*
* @since 2.1
* @return An error code
- * @param[in] inputStr The string to scan
+ * @param[in] inputStr The string to scan
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified @c string parameter is @c 0.
+ * @exception E_INVALID_ARG The length of the specified @c string is @c 0.
*/
result Construct(const String& inputStr);
*
* @since 2.1
* @return An error code
- * @param[in] inputFilePath The file to read to construct input data
- * @param[in] encodingScheme The encoding type of the file
- * @exception E_SUCCESS The method is successful.
+ * @param[in] inputFilePath The file to read to construct input data
+ * @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 The file operation is invalid.
- * @exception E_INVALID_ARG The specified encoding scheme does not exist.
+ * @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.
*/
result Construct(const String& inputFilePath, const String& encodingScheme);
/**
- * Gets the substring of the input data matching to the pattern constructed from the specified string. @n
- * Delimiter will be ignored and the returned string does not include any line terminator.
- * If such a pattern in the input data is not found upto the next line terminator, return an empty string through the out parameter, matchedStr.
+ * Gets the substring of the input data matching the pattern constructed from the specified string. @n
+ * Delimiter is ignored and the returned string does not include any line terminator.
+ * If such a pattern in the input data is not found upto the next line terminator, the %FindInLine() method returns an empty string through the out parameter, @c matchedStr.
*
* @since 2.1
* @return An error code
* @param[in] patternStr The string to construct the pattern
* @param[out] matchedStr The matched string or empty string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The length of the specified @c string parameter is @c 0.
- * @exception E_DATA_NOT_FOUND No substring is found in the input data of current instance.
+ * @exception E_INVALID_ARG The length of the specified @c string is @c 0.
+ * @exception E_DATA_NOT_FOUND No substring is found in the input data of the current instance.
*/
result FindInLine(const String& patternStr, String& matchedStr);
/**
* Gets the substring matching the pattern from the input data. @n
- * Delimiter will be ignored and the returned string does not include any line terminator.
- * If such a pattern in the input data is not found upto the next line terminator, return an empty string through the out parameter, matchedStr.
+ * Delimiter is ignored and the returned string does not include any line terminator.
+ * If such a pattern in the input data is not found upto the next line terminator, the %FindInLine() method returns an empty string through the out parameter, @c matchedStr.
*
* @since 2.1
* @return An error code
- * @param[in] pattern The pattern to compile for finding substring from input data
- * @param[out] matchedStr The matched string or empty string
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_FOUND No substring is found in the input data of current instance.
+ * @param[in] pattern The pattern to compile for finding the substring from the input data
+ * @param[out] matchedStr The matched string or empty string
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND No substring is found in the input data of the current instance.
*/
result FindInLine(const RegularExpression& pattern, String& matchedStr);
/**
- * Gets the next token as @c signed @c char. @n Next token is converted to @c signed @c char using default radix.
- * The @c signed @c char can hold value from -128 to 127.
+ * Gets the next token as @c signed @c char. @n The next token is converted to a @c signed @c char using a default radix.
+ * The @c signed @c char can hold values from -128 to 127.
*
* @since 2.1
* @return An error code
- * @param[out] nextSignedChar The next token as a @c signed @c char
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid signed @c char value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextSignedChar The next token as a @c signed @c char
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid signed @c char value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextSignedChar(signed char& nextSignedChar) const;
/**
- * Gets the next token as @c signed @c char. @n Next token is converted to @c signed @c char using specified @c radix.
- * The @c signed @c char can hold value from -128 to 127.
+ * Gets the next token as @c signed @c char. @n The next token is converted to a @c signed @c char using the specified @c radix.
+ * The @c signed @c char can hold values from -128 to 127.
*
* @since 2.1
* @return An error code
- * @param[out] nextSignedChar The next token as a @c signed @c char
- * @param[in] radix The radix to use for conversion
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c char value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextSignedChar The next token as a @c signed @c char
+ * @param[in] radix The radix to use for conversion
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c char value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextSignedChar(signed char& nextSignedChar, int radix) const;
/**
- * Gets the next token as @c int. @n Next token is converted to signed integer using default radix.
- * The signed integer can hold value from -2^31 to 2^31-1.
+ * Gets the next token as @c int. @n The next token is converted to a @c signed integer using a default radix.
+ * The @c signed integer can hold values from -2^31 to 2^31-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextInt The next token as a signed integer
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid integer value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextInt The next token as a @c signed integer
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed integer value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextInt(int& nextInt) const;
/**
- * Gets the next token as @c int. @n Next token is converted to signed integer using specified @c radix.
- * The signed integer can hold value from -2^31 to 2^31-1.
+ * Gets the next token as @c int. @n The next token is converted to a @c signed integer using the specified @c radix.
+ * The @c signed integer can hold values from -2^31 to 2^31-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextInt The next token as a signed integer
- * @param[in] radix The radix to use for conversion
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid integer value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextInt The next token as a @c signed integer
+ * @param[in] radix The radix to use for conversion
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed integer value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextInt(int& nextInt, int radix) const;
/**
- * Gets the next token as @c short. @n Next token is converted to signed @c short using default radix.
- * The signed @c short can hold value from -2^15 to 2^15-1.
+ * Gets the next token as @c short. @n The next token is converted to a @c signed @c short using a default radix.
+ * The @c signed @c short can hold values from -2^15 to 2^15-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextShort The next token as a signed @c short
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c short value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextShort The next token as a signed @c short
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c short value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextShort(short& nextShort) const;
/**
- * Gets the next token as @c short. @n Next token is converted to signed @c short using specified @c radix.
- * The signed @c short can hold value from -2^15 to 2^15-1.
+ * Gets the next token as @c short. @n The next token is converted to a @c signed @c short using the specified @c radix.
+ * The @c signed @c short can hold values from -2^15 to 2^15-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextShort The next token as a signed @c short
- * @param[in] radix The radix to use for conversion
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c short value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextShort The next token as a @c signed @c short
+ * @param[in] radix The radix to use for conversion
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c short value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextShort(short& nextShort, int radix) const;
/**
- * Gets the next token as @c long @c long. @n Next token is converted to signed @c long @c long using default radix.
- * The signed @c long @c long can hold value from -2^63 to 2^63-1.
+ * Gets the next token as @c long @c long. @n The next token is converted to a @c signed @c long @c long using a default radix.
+ * The @c signed @c long @c long can hold values from -2^63 to 2^63-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextLongLong The next token as a signed @c long @c long
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c long @c long value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextLongLong The next token as a @c signed @c long @c long
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c long @c long value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextLongLong(long long& nextLongLong) const;
/**
- * Gets the next token as @c long @c long. @n Next token is converted to signed @c long @c long using specified @c radix.
- * The signed @c long @c long can hold value from -2^63 to 2^63-1.
+ * Gets the next token as @c long @c long. @n The next token is converted to a @c signed @c long @c long using the specified @c radix.
+ * The @c signed @c long @c long can hold values from -2^63 to 2^63-1.
*
* @since 2.1
* @return An error code
- * @param[out] nextLongLong The next token as a signed @c long @c long
- * @param[in] radix The radix to use for conversion
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c long @c long value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextLongLong The next token as a @c signed @c long @c long
+ * @param[in] radix The radix to use for conversion
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c long @c long value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextLongLong(long long& nextLongLong, int radix) const;
/**
- * Gets the next token as @c float. @n Next token is converted to @c float.
- * The signed @c float can hold a single-precision 32-bit floating number.
+ * Gets the next token as @c float. @n The next token is converted to @c float.
+ * The @c signed @c float can hold a single-precision 32-bit floating number.
*
* @since 2.1
* @return An error code
- * @param[out] nextFloat The next token as a @c float
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c float value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextFloat The next token as a @c float
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c float value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextFloat(float& nextFloat) const;
/**
- * Gets the next token as @c double. @n Next token is converted to @c double.
+ * Gets the next token as @c double. @n The next token is converted to @c double.
* The signed @c double can hold a double-precision 64-bit floating number.
*
* @since 2.1
* @return An error code
- * @param[out] nextDouble The next token as a @c double
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c double value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextDouble The next token as a @c double
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c double value.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextDouble(double& nextDouble) const;
/**
- * Gets the next token as @c bool. @n Next token is converted to boolean.
+ * Gets the next token as @c bool. @n The next token is converted to boolean.
* Nothing can be converted, except true/TRUE or false/FALSE.
*
* @since 2.1
* @return An error code
- * @param[out] nextBool The next token as @c bool
- * @exception E_SUCCESS The method is successful.
- * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c bool value.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextBool The next token as @c bool
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c bool value.
+ * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
*/
result GetNextBool(bool& nextBool) const;
/**
- * Gets the input string up to next line delimiter and advances the %Scanner to the beginning of the next line. @n
+ * Gets the input string up to the next line delimiter and advances the %Scanner to the beginning of the next line. @n
* The returned string does not include any line terminator.
*
* @since 2.1
* @return An error code
- * @param[out] nextLine The next line as an instance of String
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_ENOUGH There are no remaining lines for the current instance of %Scanner.
+ * @param[out] nextLine The next line as an instance of String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_ENOUGH There are no lines remaining for the current instance of %Scanner.
*
* The following example demonstrates how to use the %GetNextLine() method.
*
*
* @since 2.1
* @return An error code
- * @param[out] nextTok The next token as an instance of String
- * @exception E_SUCCESS The method is successful.
- * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner.
+ * @param[out] nextTok The next token as an instance of String
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*
* The following example demonstrates how to use the %GetNextToken() method.
* @code
result GetNextToken(String& nextTok) const;
/**
- * Gets the next token as String if it matches to the pattern constructed from the specified string.
+ * Gets the next token as String if it matches the pattern constructed from the specified string.
*
* @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, @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.
+ * @param[in] pattern The string from which to construct the pattern
+ * @param[out] nextTok The next token as an instance of String, @n
+ * else an empty string if it is does not match
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND The next token does not match the pattern.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextToken(const String& pattern, String& nextTok) const;
/**
- * Gets the next token as String if it matches to the pattern.
+ * Gets the next token as String if it matches the pattern.
*
* @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, @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.
+ * @param[in] pattern The pattern to find
+ * @param[out] nextTok The next token as an instance of String, @n
+ * else an empty string if it is does not match
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DATA_NOT_FOUND The next token does not match the pattern.
+ * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner.
*/
result GetNextToken(const RegularExpression& pattern, String& nextTok) const;
*
* @since 2.1
* @return @c true if the current instance has another token, @n
- * else @c false
+ * else @c false
*/
bool HasNextToken(void) const;
/**
- * Checks whether the next token matches to the pattern constructed from the specified string.
+ * Checks whether the next token matches the pattern constructed from the specified string.
*
* @since 2.1
- * @return @c true if the next token matches to the pattern constructed from the specified string, @n
- * else @c false
+ * @return @c true if the next token matches the pattern constructed from the specified string, @n
+ * else @c false
* @param[in] pattern The string to construct the pattern
*/
bool HasNextToken(const String& pattern) const;
/**
- * Checks whether the next token matches to the pattern.
+ * Checks whether the next token matches the pattern.
*
* @since 2.1
- * @return @c true if the next token matches to the pattern, @n
- * else @c false
+ * @return @c true if the next token matches the pattern, @n
+ * else @c false
* @param[in] pattern The pattern to find
*/
bool HasNextToken(const RegularExpression& pattern) const;
/**
* Checks whether the next token can be translated into a valid @c signed @c char value in the default radix.
- * The @c signed @c char can hold value from -128 to 127.
+ * The @c signed @c char can hold values from -128 to 127.
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c signed @c char value in the current radix, @n
- * else @c false
+ * else @c false
*/
bool IsNextTokenConvertibleToSignedChar(void) const;
/**
* Checks whether the next token can be translated into a valid @c signed @c char value in the specified @c radix.
- * The @c signed @c char can hold value from -128 to 127.
+ * The @c signed @c char can hold values from -128 to 127.
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c signed @c char value in the current radix, @n
- * else @c false
- * @param[in] radix The radix to use to translate the token as a valid @c signed @c char value
+ * else @c false
+ * @param[in] radix The radix used to translate the token as a valid @c signed @c char value
*/
bool IsNextTokenConvertibleToSignedChar(int radix) const;
/**
* Checks whether the next token can be translated into a valid @c int value in the default radix. @n
- * The signed integer can hold value from -2^31 to 2^31-1.
+ * The @c signed integer can hold values from -2^31 to 2^31-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n
- * else @c false
+ * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n
+ * else @c false
*/
bool IsNextTokenConvertibleToInt(void) const;
/**
* Checks whether the next token can be translated into a valid @c int value in the specified @c radix. @n
- * The signed integer can hold value from -2^31 to 2^31-1.
+ * The @c signed integer can hold values from -2^31 to 2^31-1.
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c int value in the current radix, @n
- * else @c false
- * @param[in] radix The radix to use to translate the token as a valid @c int value
+ * else @c false
+ * @param[in] radix The radix used to translate the token as a valid @c int value
*/
bool IsNextTokenConvertibleToInt(int radix) const;
/**
* Checks whether the next token can be translated into a valid @c short value in the default radix. @n
- * The signed @c short can hold value from -2^15 to 2^15-1.
+ * The @c signed @c short can hold values from -2^15 to 2^15-1.
*
* @since 2.1
- * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n
- * else @c false
+ * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n
+ * else @c false
*/
bool IsNextTokenConvertibleToShort(void) const;
/**
* Checks whether the next token can be translated into a valid @c short value in the specified @c radix. @n
- * The signed @c short can hold value from -2^15 to 2^15-1.
+ * The @c signed @c short can hold values from -2^15 to 2^15-1.
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c short value in the current radix, @n
- * else @c false
- * @param[in] radix The radix to use to translate the token as a valid @c short value
+ * else @c false
+ * @param[in] radix The radix used to translate the token as a valid @c short value
*/
bool IsNextTokenConvertibleToShort(int radix) const;
/**
* Checks whether the next token can be translated into a valid @c long @c long value. @n
- * The signed @c long @c long can hold value from -2^63 to 2^63-1.
+ * The @c signed @c long @c long can hold value from -2^63 to 2^63-1.
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c long @c long value in the current radix, @n
- * else @c false
+ * else @c false
*/
bool IsNextTokenConvertibleToLongLong(void) const;
/**
* Checks whether the next token can be translated into a valid @c float value. @n
- * The signed @c float can hold a single-precision 32-bit floating number.
+ * The @c signed @c float can hold a single-precision 32-bit floating number.
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c float value in the current radix, @n
- * else @c false
+ * else @c false
*/
bool IsNextTokenConvertibleToFloat(void) const;
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c double value in the current radix, @n
- * else @c false
+ * else @c false
*/
bool IsNextTokenConvertibleToDouble(void) const;
*
* @since 2.1
* @return @c true if the next token can be translated into a valid @c bool value, @n
- * else @c false
+ * else @c false
*/
bool IsNextTokenConvertibleToBool(void) const;
*
* @since 2.1
* @return @c true if the input data of the current instance of %Scanner has another line, @n
- * else @c false
+ * else @c false
*/
bool HasNextLine(void) const;
* @file FBaseUtilStringTokenizer.h
* @brief This is the header file for the %StringTokenizer class.
*
- * @see String()
- *
* This header file contains the declarations of the %StringTokenizer class.
+ *
+ * @see Tizen::Base::String
*/
#ifndef _FBASE_UTIL_STRING_TOKENIZER_H_
*
* @param[in] value An instance of String to parse
* @param[in] delimiters The delimiters
- * @param[in] isToken A flag indicating whether to return the delimiters as tokens @n
+ * @param[in] isToken The flag that indicates whether to return the delimiters as tokens @n
* Set to @c true to treat the delimiters as tokens, @n
* else @c false to skip the delimiters.
*
virtual ~StringTokenizer(void);
/**
- * Gets the token count indicating the number of times the GetNextToken() method can be called before it returns an error code.
+ * Gets the token count that indicates the number of times the %GetNextToken() method can be called before it returns an error code.
*
* @since 2.0
*
- * @return An integer value indicating the number of times the GetNextToken() method can be called
+ * @return The integer value that indicates the number of times the GetNextToken() method can be called
*/
int GetTokenCount(void);
* @since 2.0
*
* @return An error code
- * @param[out] token The next token
+ * @param[out] token The next token
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The string tokenizer has no more tokens.
*/
* @since 2.0
*
* @return An error code
- * @param[in] delimiters The new delimiters
+ * @param[in] delimiters The new delimiters
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*
{
/**
* @class StringUtil
- * @brief This class provides various utility methods for %String.
+ * @brief This class provides utility methods for %String operations.
*
* @since 2.0
*
- * The %StringUtil class provides various utility methods for String.
+ * The %StringUtil class provides utility methods for String operations.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/utility_namespace.htm">Utility</a>.
*
* Converts an McharBuffer to a null-terminated string. @n
* The position of the buffer is not changed.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the WcharBufferToString(const WcharBuffer& mb, String& str) method.
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the WcharBufferToString(const WcharBuffer& mb, String& str) method.
+ * @since 2.0
*
* @return An error code
- * @param[in] mb An instance of McharBuffer
- * @param[out] str The current position
+ * @param[in] mb An instance of McharBuffer
+ * @param[out] str The null-terminated string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * @c null does not exist between the position and limit of buffer.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - @c null does not exist between the position and limit of buffer.
* @endif
*/
static result MbToString(const McharBuffer& mb, String& str);
* Converts an WcharBuffer to a null-terminated string. @n
* The position of the buffer is not changed.
*
- * @since 2.0
+ * @since 2.0
*
* @return An error code
* @param[in] wb An instance of WcharBuffer
- * @param[out] str The current position
+ * @param[out] str The null-terminated string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * @c null does not exist between the position and limit of buffer.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - @c null does not exist between the position and limit of buffer.
*/
static result WcharBufferToString(const WcharBuffer& wb, String& str);
* Gets a new McharBuffer from the specified string. @n
* The buffer's limit is the length of the string plus one and the starting position is @c 0.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the StringToWcharBufferN(const String& str) method.
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the StringToWcharBufferN(const String& str) method.
+ * @since 2.0
*
* @return A pointer to the McharBuffer instance from the specified string, @n
* else @c null if an exception occurs
* Gets a new WcharBuffer from the specified string. @n
* The buffer's limit is the length of the string plus one and the starting position is @c 0.
*
- * @since 2.0
+ * @since 2.0
*
* @return A pointer to the WcharBuffer instance from the specified string, @n
* else @c null if an exception occurs
* Gets a new McharBuffer from a substring of the specified string. @n
* The buffer's limit is the length of the string plus one and the starting position is @c 0.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the StringToWcharBufferN(const String& str, int index, int length) method.
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the StringToWcharBufferN(const String& str, int index, int length) method.
+ * @since 2.0
*
* @return A pointer to the McharBuffer instance from the substring of the specified string, @n
* else @c null if an exception occurs
/**
* @if OSPDEPREC
- * Gets the string length in the McharBuffer. @n
+ * Gets the string length in the specified McharBuffer. @n
* The string length is the length from the current position of the %McharBuffer to the @c null character.
* The position of the buffer is not changed.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the GetStringLengthInWcharBuffer(const WcharBuffer& wb) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the GetStringLengthInWcharBuffer(const WcharBuffer& wb) method.
*
* @since 2.0
*
static int GetStringLengthInMb(const McharBuffer& mb);
/**
- * Gets the string length in the WcharBuffer. @n
+ * Gets the string length in the specified WcharBuffer. @n
* The string length is the length from the current position of the %WcharBuffer to the @c null character.
* The position of the buffer is not changed.
*
*
* @return A pointer to the ByteBuffer instance encoded from the specified string, @n
* else @c null if an exception occurs
- * @param[in] unicodeString A string to encode
+ * @param[in] unicodeString The string to encode
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::ByteBuffer
- * @see Tizen::Base::String
*/
static ByteBuffer* StringToUtf8N(const String& unicodeString);
* @since 2.0
*
* @return An error code
- * @param[in] pUtf8String A pointer to a String instance containing UTF-8 codes
+ * @param[in] pUtf8String A pointer to the String instance containing UTF-8 codes
* @param[out] unicodeString A string containing Unicode characters
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c pUtf8String is a @c null reference.
*
* @return A pointer to the ByteBuffer instance decoded from the specified string, @n
* else @c null if an exception occurs
- * @param[in] base64String A string to decode
+ * @param[in] base64String The string to decode
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The specified @c base64String is not a valid Base64 string.
* @since 2.0
*
* @return An error code
- * @param[in] buffer An instance of ByteBuffer to encode
- * @param[out] encodedString An instance of String consisting of base 64 characters
+ * @param[in] buffer An instance of ByteBuffer to encode
+ * @param[out] encodedString An instance of String consisting of base 64 characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c buffer is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The @c buffer is empty.
*
* The following example demonstrates how to use the %EncodeToBase64String() method.
*
*/
enum CompressionLevel
{
- BEST_SPEED = 0, /**< For best speed */
- BEST_COMPRESSION, /**< For best compression */
- DEFAULT_COMPRESSION /**< For average speed and average compression */
+ BEST_SPEED = 0, /**< The compression level for best speed */
+ BEST_COMPRESSION, /**< The compression level for best compression */
+ DEFAULT_COMPRESSION /**< The compression level for average speed and average compression */
};
/**
* @class Uri
- * @brief This class provides useful methods for URI.
+ * @brief This class provides methods for managing URI.
*
* @since 2.0
*
- * The %Uri class represents a Uniform Resource Identifier (URI) as defined by RFC2396 and provides accessors
- * which access the URI component.
- * It also provides methods for creating, accessing, normalizing, resolving, and relativizing %Uri instances.
+ * The %Uri class represents a Uniform Resource Identifier (URI) as defined by RFC2396 and provides methods
+ * for managing URI.
+ * The %Uri class provides methods for creating, accessing, normalizing, resolving, and relativizing %Uri instances.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/uri.htm">URI</a>.
*
virtual ~Uri(void);
/**
- * Sets the current %Uri instance to the value of the specified instance of %Uri.
+ * Sets the current %Uri instance with the value of the specified %Uri instance.
*
* @since 2.0
*
- * @param[in] uri An instance of %Uri
+ * @param[in] uri An instance of %Uri to set
*/
void SetUri(const Uri& uri);
/**
- * Sets the current %Uri instance by parsing a given string.
+ * Sets the current %Uri instance by parsing the specified string.
*
* @since 2.0
*
* @return An error code
- * @param[in] str A string to parse into a URI
+ * @param[in] str The string to parse for URI value
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c str is an empty string.
* @exception E_INVALID_FORMAT The specified @c str violates the URI syntax (RFC 2396).
result SetUri(const Tizen::Base::String& str);
/**
- * Sets an absolute %Uri instance with given components.
+ * Sets an absolute %Uri instance with specified components.
*
* @since 2.0
*
* @return An error code
- * @param[in] scheme The scheme
- * @param[in] ssp The scheme-specific-part
- * @param[in] fragment The fragment
+ * @param[in] scheme The scheme
+ * @param[in] ssp The scheme-specific-part
+ * @param[in] fragment The fragment
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396).
+ * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396).
*/
result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& ssp, const Tizen::Base::String& fragment);
* @since 2.0
*
* @return An error code
- * @param[in] scheme The scheme
- * @param[in] userInfo The user name and authorization
- * @param[in] host The host name
- * @param[in] port The port number
- * @param[in] path The path
- * @param[in] query The query
- * @param[in] fragment The fragment
+ * @param[in] scheme The scheme
+ * @param[in] userInfo The user name and authorization
+ * @param[in] host The host name
+ * @param[in] port The port number
+ * @param[in] path The path
+ * @param[in] query The query
+ * @param[in] fragment The fragment
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396).
+ * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396).
*/
result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& userInfo, const Tizen::Base::String& host, int port, const Tizen::Base::String& path, const Tizen::Base::String& query, const Tizen::Base::String& fragment);
* @since 2.0
*
* @return An error code
- * @param[in] scheme The scheme
- * @param[in] host The host name
- * @param[in] path The path
- * @param[in] fragment The fragment
+ * @param[in] scheme The scheme
+ * @param[in] host The host name
+ * @param[in] path The path
+ * @param[in] fragment The fragment
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396).
+ * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396).
* @remarks The authority and query component are left empty, and the port is set to @c -1.
*/
result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& host, const Tizen::Base::String& path, const Tizen::Base::String& fragment);
* @since 2.0
*
* @return An error code
- * @param[in] scheme The scheme
- * @param[in] authority The authority
- * @param[in] path The path
- * @param[in] query The query
- * @param[in] fragment The fragment
+ * @param[in] scheme The scheme
+ * @param[in] authority The authority
+ * @param[in] path The path
+ * @param[in] query The query
+ * @param[in] fragment The fragment
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396).
+ * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396).
*/
result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& authority, const Tizen::Base::String& path, const Tizen::Base::String& query, const Tizen::Base::String& fragment);
* @return The value of the authority component, @n
* else an empty string if the authority component is undefined
* @remarks The string returned by this method is equal to the string returned by GetEncodedAuthority(),
- * except that all sequences of the escaped octets are decoded.
+ * except that all the sequences of the escaped octets are decoded.
*/
Tizen::Base::String GetAuthority(void) const;
* @return The value of the fragment component, @n
* else an empty string if the fragment component is undefined
* @remarks The string returned by this method is equal to the string returned by GetEncodedFragment(),
- * except that all sequences of the escaped octets are decoded.
+ * except that all the sequences of the escaped octets are decoded.
*/
Tizen::Base::String GetFragment(void) const;
* @return The value of the path component, @n
* else an empty string if the path component is undefined
* @remarks The string returned by this method is equal to the string returned by GetEncodedPath(),
- * except that all sequences of the escaped octets are decoded.
+ * except that all the sequences of the escaped octets are decoded.
*/
Tizen::Base::String GetPath(void) const;
* @return The value of the query component, @n
* else an empty string if the query component is undefined
* @remarks The string returned by this method is equal to the string returned by GetEncodedQuery(),
- * except that all sequences of the escaped octets are decoded.
+ * except that all the sequences of the escaped octets are decoded.
*/
Tizen::Base::String GetQuery(void) const;
* @return The value of the scheme-specific-part component, @n
* else an empty string if the scheme-specific-part component is undefined
* @remarks The string returned by this method is equal to the string returned by GetEncodedSchemeSpecificPart(),
- * except that all sequences of the escaped octets are decoded.
+ * except that all the sequences of the escaped octets are decoded.
*/
Tizen::Base::String GetSchemeSpecificPart(void) const;
* @return The value of the user-info component, @n
* else an empty string if the user-info component is undefined
* @remarks The string returned by this method is equal to the string returned by GetEncodedUserInfo(),
- * except that all sequences of the escaped octets are decoded.
+ * except that all the sequences of the escaped octets are decoded.
*/
Tizen::Base::String GetUserInfo(void) const;
/**
- * Checks whether the calling %Uri instance is an opaque URI.
+ * Checks whether the current %Uri instance is an opaque URI.
*
* @since 2.0
*
Tizen::Base::String GetEncodedString(void) const;
/**
- * Compares the calling URI instance to the specified %Uri instance. @n
+ * Compares the current URI instance with the specified %Uri instance. @n
* When comparing corresponding components of two URIs, if one component in the current instance is undefined
* but the other is defined, then the current instance is considered to be less than the given object.
*
* = 0 if the current instance is equal to the given object
* > 0 if the current instance is greater than the given object
* @endcode
- * @param[in] uri An instance of %Uri
+ * @param[in] uri An instance of %Uri to compare
* @remarks
*
* Ordering of URIs
* to the ordering of fragments, without regard to case.
* 5. Authority
* If two hierarchical URIs have identical schemes, they are ordered according to the authority,
- * without regard to the case.
+ * without regard to the case. @n
* 5-1. Server-based authority
* If two URIs are server-based, they are ordered according to their user-information,
* without regard to case.
*
* @return @c true if the two instances are equal, @n
* else @c false
- * @param[in] obj The object to compare with the current instance
- * @remarks Two equal instances must return the same hash value. The default
- * implementation of this method returns @c true if two instances
- * have the same address. @n
- * The method can be overridden to support value equality. Furthermore, the Equals()
+ * @param[in] obj The object to compare with the current instance
+ * @remarks
+ * - Two equal instances must return the same hash value. @n The default
+ * implementation of this method returns @c true if the two instances
+ * have the same address.
+ * - The method can be overridden to support value equality. Furthermore, the Equals()
* method must return the same results as the equality operator.
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* @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 inputs.
*/
virtual int GetHashCode(void) const;
* @return The normalized URI, @n
* else the current URI in case any error occurs
* @remarks Normalization is the process of removing unnecessary "." and ".." segments from the path component of the
- * hierarchical URI. All "." segments are removed and If a ".." segment is preceded by a non-".." segment,
- * both of these segments are removed. If a URI is opaque, the normalization has no effect.
+ * hierarchical URI. All "." segments are removed.
+ * If a ".." segment is preceded by a non-".." segment,
+ * both the segments are removed. If a URI is opaque, the normalization has no effect.
*
* The following example demonstrates how to use the %Normalize() method.
*
* @param[out] uri The parsed URI
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The authority component is defined but cannot be parsed as a server-based authority.
- * @remarks This method is provided because the generic URI syntax cannot always distinguish a malformed server-based authority from a legitimate registry-based authority.
+ * @remarks This method is provided because the generic URI syntax cannot always distinguish a malformed server-based authority from a legitimate registry-based authority. @n
* For example, the authority component in the URI string "//foo:bar/" is not a legal
* server-based authority but it is legal as a registry-based authority.
*/
/**
- * Relativizes the specified %Uri instance against the calling %Uri instance.
+ * Relativizes the specified %Uri instance against the current %Uri instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] uri The %Uri to relativize against the calling %Uri
+ * @param[in] uri The %Uri to relativize against the current %Uri instance
* @param[out] resultUri The relativized URI
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Relativization is the opposite of Resolution. It is used
- * to divide a URI into the base URI and the relative URI.
+ * @remarks
+ * - Relativization is the opposite of Resolution.
+ * - It is used to divide a URI into the base URI and the relative URI.
*/
result Relativize(const Uri& uri, Uri& resultUri);
/**
- * Resolves the specified %Uri instance against the calling %Uri instance.
+ * Resolves the specified %Uri instance against the current %Uri instance.
*
* @since 2.0
*
* @param[out] resultUri The resolved URI
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Resolution is the process of resolving a URI against another, base URI. For hierarchical URI,
- * the path of the original is resolved against the path of the base URI and then normalized. @
- * For example, to resolve the URI "/downloads/tizen-sdk" against the base URI "https://developer.tizen.org",
+ * @remarks
+ * - Resolution is the process of resolving a URI against another, base URI.
+ * - For a hierarchical URI, the path of the original URI is resolved against the path of the base URI and then normalized. @n
+ * For example, when you resolve the URI "/downloads/tizen-sdk" against the base URI "https://developer.tizen.org",
* the resultant URI is "https://developer.tizen.org/downloads/tizen-sdk".
*/
result Resolve(const Uri& uri, Uri& resultUri);
* @since 2.0
*
* @return An error code
- * @param[in] authority The authority
+ * @param[in] authority The authority to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
/**
- * Sets the fragment component to the specified String instance.
+ * Sets the fragment component to the specified String instance
*
* @since 2.0
*
* @return An error code
- * @param[in] fragment The new fragment
+ * @param[in] fragment The fragment to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] host The new host
+ * @param[in] host The host to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] path The new path component
+ * @param[in] path The path to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] port The new port component
+ * @param[in] port The port to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c port is negative.
*/
* @since 2.0
*
* @return An error code
- * @param[in] query The new query string
+ * @param[in] query The query to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] scheme The new scheme
+ * @param[in] scheme The scheme to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] ssp The new scheme-specific-part component
+ * @param[in] ssp The scheme-specific-part to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] userInfo The new user-info string
+ * @param[in] userInfo The user-info to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_FORMAT The specified string is invalid.
*/
/**
- * Gets the content of the calling %Uri instance as a string containing escaped octets.
+ * Gets the content of the current %Uri instance as a string containing escaped octets.
*
* @since 2.0
*
- * @return The content of this URI as a string containing escaped octets
+ * @return The content of the current %Uri instance as a string containing escaped octets
*/
Tizen::Base::String ToString(void) const;
{
public:
/**
- * Decodes an encoded string using a specific encoding scheme.
+ * Decodes the specified encoded string using the specified encoding scheme.
*
* @since 2.0
*
* @exception E_SYSTEM A system error has occurred.
* @exception E_UNSUPPORTED_TYPE The specified encoding scheme is not supported.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method is used for decoding. It decodes an application/x-www-form-urlencoded string using a
- * specific encoding scheme. The supplied encoding scheme is used to determine what characters are represented
- * by any consecutive sequences of the form "%ab", where ab is the two-digit hexadecimal representation of a
- * byte.
- *@see UrlEncoder
+ * @remarks This method is used for decoding. It decodes an application/x-www-form-urlencoded string using a
+ * specific encoding scheme. @n
+ * The supplied encoding scheme is used to determine what characters are represented
+ * by any consecutive sequences of the form "%ab", where ab is the two-digit hexadecimal representation of a
+ * byte.
+ * @see UrlEncoder
*/
static result Decode(const Tizen::Base::String& str, const Tizen::Base::String& encodingScheme, Tizen::Base::String& decodedStr);
{
public:
/**
- * Encodes an input string using a specific encoding scheme. @n
+ * Encodes the specified input string using the specified encoding scheme. @n
* It encodes all unsafe characters of a string.
*
* @since 2.0
* @param[out] encodedStr The encoded string
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_UNSUPPORTED_TYPE The specified encoding scheme is not supported.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks This method is used for encoding. It encodes input string into an
- * application/x-www-form-urlencoded format using a specific encoding scheme. This method uses the specified
- * encoding scheme to obtain the bytes for unsafe characters.
- *@see UrlDecoder
+ * @remarks This method is used for encoding. @n
+ * It encodes input string into an
+ * application/x-www-form-urlencoded format using a specific encoding scheme. @n
+ * This method uses the specified encoding scheme to obtain the bytes for unsafe characters.
+ * @see UrlDecoder
*/
static result Encode(const Tizen::Base::String& str, const Tizen::Base::String& encodingScheme, Tizen::Base::String& encodedStr);
{
/**
* @class ZipEntry
- * @brief This class provides access to the entries of a zip-archive.
+ * @brief This class provides methods to access the entries of a zip-archive.
*
* @since 2.0
*
virtual ~ZipEntry(void);
/**
- * Gets an entry name associated with a zip entry. @n
+ * Gets the entry name associated with the zip entry. @n
* It can be a file or directory name.
*
* @since 2.0
*
- * @return An entry name
+ * @return The entry name
*
*/
String GetName(void) const;
/**
- * Gets the compression level associated with a zip entry.
+ * Gets the compression level associated with the zip entry.
*
* @since 2.0
*
- * @return The compression level associated with a zip entry
+ * @return The compression level associated with the zip entry
*
*/
CompressionLevel GetCompressionLevel(void) const;
/**
- * Checks whether a zip entry is a file or directory.
+ * Checks whether the zip entry is a file or directory.
*
* @since 2.0
*
bool IsDirectory(void) const;
/**
- * Gets the compressed size of a zip entry.
+ * Gets the compressed size of the zip entry.
*
* @since 2.0
*
- * @return The compressed size of a zip entry
+ * @return The compressed size of the zip entry
*/
unsigned long GetCompressedSize(void) const;
/**
- * Gets the uncompressed size of a zip entry.
+ * Gets the uncompressed size of the zip entry.
*
* @since 2.0
*
- * @return The uncompressed size of a zip entry
+ * @return The uncompressed size of the zip entry
*/
unsigned long GetUncompressedSize(void) const;
/**
- * Gets the name of a zip file to which %ZipEntry belongs.
+ * Gets the name of the zip file to which %ZipEntry belongs.
*
* @since 2.0
*
- * @return The name of a zip file
- * @remarks This method returns the name of a zip file that is opened
- * in the FileUnzipper::Construct() method.
+ * @return The name of the zip file
+ * @remarks This method returns the name of the zip file that is opened
+ * in the FileUnzipper::Construct() method.
*/
String GetArchiveName(void) const;
/**
- * Compares the specified instance to the calling instance.
+ * Compares the specified instance to the current instance.
*
* @since 2.0
*
* @return @c true if the specified instance equals the current instance, @n
* else @c false
- * @param[in] obj The object to compare with the current instance
+ * @param[in] obj The object to compare with the current instance
* @remarks This method returns @c true if all the attributes in the instance are same.
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
{
/**
* @class UuId
- * @brief This class is the base class of the wrapped UUID types and provides useful operators.
+ * @brief This class is the base class of the wrapped UUID types and provides methods for UUIDs.
*
* @since 2.0
*
- * The %UuId class is the base class of the wrapped UUID types and provides useful operators. The UUID consists of 32 hexadecimal digits displayed in 5 groups separated by hyphens to form a total of 36 characters (32 digits and 4 hyphens '-').
+ * The %UuId class is the base class of the wrapped UUID types and provides useful operators. The UUID consists of 32 hexadecimal
+ * digits displayed in 5 groups separated by hyphens to form a total of 36 characters (32 digits and 4 hyphens '-').
*
* It also provides operators for assignment and equality, and methods for parsing, comparing, and generalization.
*
* @if OSPDEPREC
* Initializes an instance of %UuId with the value of the specified UUID.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as a UUID type is deprecated.
- * Instead of using this method, use the UuId(const byte uuid[16]) method.
- * @since 2.0
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as a UUID type is deprecated.
+ * Instead of using this method, use the UuId(const byte uuid[16]) method.
+ * @since 2.0
*
* @param[in] uuid An instance of UUID
* @endif
UuId(const UUID& uuid);
/**
- * Initializes an instance of %UuId with the uuid value.
+ * Initializes an instance of %UuId with the specified uuid value.
*
* @since 2.0
*
* @return @c true if the UUID and the %UuId instance are equal, @n
* else @c false
* @param[in] uuid1 An instance of UUID
- * @param[in] uuid2 An instance of %UuId
+ * @param[in] uuid2 An instance of %UuId
* @endif
*/
_OSP_EXPORT_ friend bool operator ==(const UUID& uuid1, const UuId& uuid2);
*
* @since 2.0
*
- * @return @c true if the two IDs are equal, @n
+ * @return @c true if the two instances are equal, @n
* else @c false
* @param[in] uuid An instance of %UuId
*/
*
* @return @c true if the specified instance of Object is equal to the current instance of %UuId, @n
* else @c false
- * @param[in] obj An instance of Object to compare
- * @remarks This method can be overridden to support value equality. Furthermore, the method must return the same result as the equality operator.
+ * @param[in] obj An instance of Object to compare
+ * @remarks This method can be overridden to support value equality. @n
+ * Furthermore, the method must return the same result
+ * as the equality operator.
* @see Tizen::Base::Object::GetHashCode()
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The integer value equivalent of the hash value of the current instance of %UuId
- * @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. @n
- * The default implementation of this method returns the value of the current instance.
+ * @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 inputs.
+ * - The default implementation of this method returns the value of the current instance.
*/
virtual int GetHashCode(void) const;
/**
- * Gets the string representing the value of the current instance when implemented by a class.
+ * Gets the string representing the value of the current instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An instance of the String class with the unicode representation of the value of the current instance @n
- * If an error such as E_OUT_OF_MEMORY occurs, an empty string is returned.
+ * @return An instance of the String class with the unicode representation of the value of the current instance, @n
+ * else an empty string if an error such as @c E_OUT_OF_MEMORY occurs
*/
String ToString(void) const;
* @exception E_INVALID_ARG The string does not contain an %UuId that can be parsed.
* @remarks
* - The format of a string representing a %UuId value is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (For example, 130DF2EC-8233-4975-B03D-F0AD99E3449D).
- * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+ * - This method guarantees that the original value of out-parameter is not changed when the method returns an error.
*/
static result Parse(const String& str, UuId& uuid);
/**
* Generates a new %UuId instance with a random value.
*
- * @since 2.0
+ * @since 2.0
*
* @return A new %UuId instance
*/
static UuId* GenerateN(void);
/**
- * Get a new invalid %UuId instance.
+ * Gets a new invalid %UuId instance.
*
- * @since 2.0
+ * @since 2.0
*
* @return A new invalid %UuId instance
*/
static const UuId INVALID_UUID;
/**
- * A byte array of uuid value.
+ * A byte array of the uuid value.
*
* @since 2.0
*/
projects / platform / framework / native / appfw.git / commitdiff