/**
* @class DateTimeSymbols
- * @brief This class provides methods that help in providing date and time symbols.
+ * @brief This class provides methods for date and time symbols.
*
* @since 2.0
*
- * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months, the days of the week, and the time zone data.
- * It is also used by DateTimeFormatter.
- * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week.
+ * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months,
+ * the days of the week, and the time zone data. It is also used by DateTimeFormatter.
+ * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of
+ * the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/datetime_formatter.htm">Date and Time Formatter</a>.
*
public:
/**
* This is the default constructor for this class. @n
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. For full construction, the Construct() method
+ * must be called right after calling this constructor.
*
* @since 2.0
- *
- * @see Construct()
*/
DateTimeSymbols(void);
* Initializes this instance of %DateTimeSymbols with the specified @c locale and @c calendarType.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
* @endif
*
* @return An error code
* @param[in] calendarType The calendar type
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid.
+ * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid.
*/
result Construct(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN);
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompDateTimeSymbolsConstructPage "here".
* @endif
*
* @return An error code
* @param[in] calendarType The calendar type
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified @c calendarType is invalid.
+ * @exception E_INVALID_ARG The specified @c calendarType is invalid.
*/
result Construct(CalendarType calendarType);
/**
* @if OSPCOMPAT
- * @page CompDateTimeSymbolsConstructPage Compatibility for Construct()
- * @section CompDateTimeSymbolsConstructIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid.
- *
- * @section CompDateTimeSymbolsConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen.
- * @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c calendarType is invalid.
+ * @page CompDateTimeSymbolsConstructPage Compatibility for Construct()
+ * @section CompDateTimeSymbolsConstructIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid.
+ *
+ * @section CompDateTimeSymbolsConstructSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
+ * @par When working in Tizen:
+ * -# The method returns E_INVALID_ARG if the @c calendarType is invalid.
* @endif
- */
+ */
/**
/**
* Sets the era strings. @n
- * Multiple strings can be concatenated by '|'. For example: "AD|BC".
+ * Multiple strings can be concatenated using '|'. For example: "AD|BC".
*
* @since 2.0
*
* @return An error code
- * @param[in] eras The era strings concatenated by '|'
+ * @param[in] eras The era strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c eras contains an invalid value.
* @see GetEras()
/**
* Gets the list of the month name strings. @n
- * For example: "January", "February", etc.
+ * For example: "January", "February".
*
* @since 2.0
*
/**
- * Sets the month name strings concatenated by '|'. @n
+ * Sets the month name strings concatenated using '|'. @n
* For example: "January|February|March|April|May|June|July|August|September|October|November|December".
*
* @since 2.0
*
* @return An error code
- * @param[in] months The new month strings concatenated by '|'
+ * @param[in] months The month strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c months contains an invalid value.
* @see GetMonths()
/**
* Gets the list of the short month name strings. @n
- * For example: "Jan", "Feb", etc.
+ * For example: "Jan", "Feb".
*
* @since 2.0
*
/**
- * Sets the short month name strings concatenated by '|'. @n
+ * Sets the short month name strings concatenated using '|'. @n
* For example: "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec".
*
- * @since 2.0
+ * @since 2.0
* @return An error code
- * @param[in] shortMonths The new short month name strings concatenated by '|'
+ * @param[in] shortMonths The short month name strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n See the valid string in the description of the method.
- * @see GetShortMonths()
+ * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n
+ * See the valid string in the description of the method.
+ * @see GetShortMonths()
*/
result SetShortMonths(const Tizen::Base::String& shortMonths);
/**
* Gets the list of the weekday name strings. @n
- * For example: "Sunday", "Monday", etc.
+ * For example: "Sunday", "Monday".
*
* @since 2.0
*
* @since 2.0
*
* @return An error code
- * @param[in] weekdays The new weekday name strings concatenated by '|'
+ * @param[in] weekdays The weekday name strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c weekdays contains an invalid value.
* @see GetWeekdays()
/**
* Gets the list of the short weekday name strings. @n
- * For example: "Sun", "Mon", etc.
+ * For example: "Sun", "Mon".
*
* @since 2.0
*
/**
- * Sets the weekday name strings concatenated by '|'. @n
+ * Sets the weekday name strings concatenated using '|'. @n
* For example: "Sun|Mon|Tue|Wed|Thu|Fri|Sat".
*
* @since 2.0
*
* @return An error code
- * @param[in] shortWeekdays The new short weekday strings concatenated by '|'
+ * @param[in] shortWeekdays The short weekday strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c shortWeekdays contains an invalid value.
* @see GetShortWeekdays()
/**
- * Sets the AM/PM strings concatenated by '|'. @n
+ * Sets the AM/PM strings concatenated using '|'. @n
* For example: "AM|PM".
*
* @since 2.0
*
* @return An error code
- * @param[in] amPm The new AM/PM strings concatenated by '|'
+ * @param[in] amPm The AM/PM strings concatenated using '|'
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c amPm contains an invalid value.
* @see GetAmPm()
* Gets the name of the time zone. @n
* For example: "Eastern European Time (EET)", "Eastern European Summer Time (EEST)".
*
- * @since 2.0
+ * @since 2.0
*
- * @return The time zone name, @n
- * else an empty string if @c timeZoneId is not found @n
- * or the time zone name of @c timeZoneStyle is not found.
+ * @return The time zone name, @n
+ * else an empty string if @c timeZoneId is not found @n
+ * or the time zone name of @c timeZoneStyle is not found.
* @param[in] timeZoneId The time zone ID
* @param[in] timeZoneStyle The parameter may contain one of the following time zone styles:
* @li The normal time zone (0)
* @return An error code
* @param[in] timeZoneId The time zone ID @n
* For example: "Europe/Helsinki".
- * @param[in] concatenatedTimeZoneName The new concatenated time zone name @n
+ * @param[in] concatenatedTimeZoneName The concatenated time zone name @n
* For example, "Eastern European Time|EET|Eastern European Summer Time|EEST".
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c timeZoneId or @c concatenatedTimeZoneName contains an invalid value.
* @exception E_OBJ_NOT_FOUND The specified @c timeZoneId is not found.
- * @see GetTimeZoneName()
- * @see AddTimeZoneName()
+ * @see GetTimeZoneName()
+ * @see AddTimeZoneName()
*/
result SetTimeZoneName(const Tizen::Base::String& timeZoneId, const Tizen::Base::String& concatenatedTimeZoneName);
/**
- * Adds a new time zone name string that is related to time zone ID.
+ * Adds the time zone name that is related to time zone ID.
*
* @since 2.0
*
projects / platform / framework / native / appfw.git / blobdiff