Flush app registry before releasing file lock
[platform/framework/native/appfw.git] / inc / FLclCurrency.h
index e02bce2..200fb40 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -36,7 +35,7 @@ class Locale;
 
 /**
  * @class              Currency
- * @brief              This class represents currencies.
+ * @brief              This class provides methods for currencies.
  *
  * @since              2.0
  *
@@ -55,11 +54,10 @@ 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()
         */
        Currency(void);
 
@@ -81,13 +79,13 @@ public:
         * @endif
         * @since                       2.0
         * @if OSPCOMPAT
-        * @compatibility     This method has compatibility issues with OSP compatibile applications. @n
-        *                              For more information, see @ref CompCurrencyConstructPage "here".
+        * @compatibility       This method has compatibility issues with OSP compatible applications. @n
+        *                                      For more information, see @ref CompCurrencyConstructPage "here".
         * @endif
         *
         * @return                      An error code
-        * @param[in]           locale                                          The specified @c locale to get the currency symbol
-        * @exception           E_SUCCESS                                       The method is successful.
+        * @param[in]           locale                          The specified @c locale to get the currency symbol
+        * @exception           E_SUCCESS                       The method is successful.
         * @exception           E_INVALID_ARG           The specified @c locale is not supported.
         */
        result Construct(const Locale& locale);
@@ -95,37 +93,38 @@ public:
 
        /**
         * Initializes this instance of %Currency with the specified currency code. @n
-        * Currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), the currency code is "KRW".
+        * The currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), 
+        * the currency code is "KRW".
         *
         * @if OSPCOMPAT
         * @brief <i> [Compatibility] </i>
         * @endif
         * @since                       2.0
         * @if OSPCOMPAT
-        * @compatibility     This method has compatibility issues with OSP compatibile applications. @n
-         *                              For more information, see @ref CompCurrencyConstructPage "here".
+        * @compatibility       This method has compatibility issues with OSP compatible applications. @n
+     *                                 For more information, see @ref CompCurrencyConstructPage "here".
         * @endif
         *
         * @return                      An error code
-        * @param[in]           currencyCode                            The specified currency code to get the currency symbol
-        * @exception           E_SUCCESS                                       The method is successful.
+        * @param[in]           currencyCode            The specified currency code to get the currency symbol
+        * @exception           E_SUCCESS                       The method is successful.
         * @exception           E_INVALID_ARG           The specified @c currencyCode is not supported.
-        * @exception           E_OUT_OF_MEMORY                         The memory is insufficient.
+        * @exception           E_OUT_OF_MEMORY         The memory is insufficient.
         */
        result Construct(const Tizen::Base::String& currencyCode);
        /**
         * @if OSPCOMPAT
-         * @page                    CompCurrencyConstructPage Compatibility for Construct()
-         * @section                   CompCurrencyConstructIssueSection Issues
-         * Implementation of this method in OSP compatible applications has the following issue: @n
-         * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid.
-         *
-         * @section                 CompCurrencyConstructSolutionSection Resolutions
-         * This issue has been resolved in Tizen.
+        * @page                CompCurrencyConstructPage Compatibility for Construct()
+        * @section             CompCurrencyConstructIssueSection Issues
+        * Implementation of this method in OSP compatible applications has the following issue: @n
+        * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid.
+        *
+        * @section             CompCurrencyConstructSolutionSection Resolutions
+        * This issue has been resolved in Tizen.
         * @par When working in Tizen:
-         * -# The method returns E_INVALID_ARG if the argument is invalid.
+        * -# The method returns E_INVALID_ARG if the argument is invalid.
         * @endif
-         */
+        */
 
 
        /**
@@ -159,7 +158,7 @@ public:
         *
         * @return                      @c true if the value of the specified instance is equal to that of 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
         */
        virtual bool Equals(const Tizen::Base::Object& obj) const;
 
@@ -181,7 +180,7 @@ public:
         *                                      else a @c null pointer is returned if there is no currency available or there is some failure @n
         *                                      The array is a list of all the available currencies.
         * @exception           E_OUT_OF_MEMORY                         The memory is insufficient.
-        * @remarks                                     The specific error code can be accessed using the GetLastResult() method.
+        * @remarks                     The specific error code can be accessed using the GetLastResult() method.
         */
        static Tizen::Base::Collection::IList* GetAvailableCurrenciesN(void);