//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @class NumberSymbols
- * @brief This class provides methods that help in providing number symbols.
+ * @brief This class provides methods for number symbols.
*
* @since 2.0
*
- * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by NumberFormatter to format numbers.
- * %NumberFormatter creates its own instance of %NumberSymbols from its locale data. %NumberSymbols can be adopted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created. If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it.
+ * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by
+ * NumberFormatter to format numbers. %NumberFormatter creates its own instance of %NumberSymbols from its locale data.
+ * %NumberSymbols can be adapted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created.
+ * If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/locales/num_symbols_currencies.htm">Number Symbols and Currencies</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()
+ * @since 2.0
*/
NumberSymbols(void);
* Initializes this instance of %NumberSymbols with the specified @c locale.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompNumberSymbolsConstructPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompNumberSymbolsConstructPage "here".
* @endif
*
* @return An error code
- * @param[in] locale An instance of Locale
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] locale An instance of Locale
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c locale is invalid.
*/
result Construct(const Locale& locale);
/**
* @if OSPCOMPAT
- * @page CompNumberSymbolsConstructPage Compatibility for Construct()
- * @section CompNumberSymbolsConstructIssueSection Issues
- * Implementation of this method in OSP compatible applications has the following issue: @n
- * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid.
- *
- * @section CompNumberSymbolsConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen.
+ * @page CompNumberSymbolsConstructPage Compatibility for Construct()
+ * @section CompNumberSymbolsConstructIssueSection Issues
+ * Implementation of this method in OSP compatible applications has the following issue: @n
+ * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid.
+ *
+ * @section CompNumberSymbolsConstructSolutionSection Resolutions
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
- * -# The method returns E_INVALID_ARG if the @c locale is invalid.
+ * -# The method returns @c E_INVALID_ARG if the @c locale is invalid.
* @endif
- */
+ */
/**
* Gets the character used for number format.
* @return The character used for number format, @n
* else an empty string if the @c symbol is invalid
* @param[in] symbol The number format symbol instance
- * @see SetNumberSymbol()
+ * @see SetNumberSymbol()
*/
Tizen::Base::String GetNumberSymbol(NumberSymbol symbol) const;
* @param[in] symbol A symbol to set
* @param[in] str The new string for symbol
* @exception E_SUCCESS The method is successful.
- * @see GetNumberSymbol()
+ * @see GetNumberSymbol()
*/
result SetNumberSymbol(NumberSymbol symbol, const Tizen::Base::String& str);
* @since 2.0
*
* @return A pointer to the current instance of Locale, @n
- * else @c null if this method fails
+ * else @c null if it fails
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Locale* GetLocale(void) const;