Add IPC sync result for SerialPort::Write()
[platform/framework/native/appfw.git] / inc / FSysBattery.h
index 7cc8b14..9a995ec 100644 (file)
@@ -42,9 +42,8 @@ namespace Tizen { namespace System
  * @deprecated This class is deprecated. Instead of using this class, use the PowerManager class.
  * @final      This class is not intended for extension.
  *
- * The %Battery class provides methods to get the status related to battery levels and
- * determine whether the battery is currently being charged.
- * You cannot create an instance of this class directly.
+ * The %Battery class provides methods to get the status related to battery levels and determine whether the battery is 
+ * currently being charged. You cannot create an instance of this class directly.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/battery_status.htm">Battery Status</a>.
  * @endif
@@ -66,12 +65,12 @@ public:
         * @compatibility       This method has compatibility issues with OSP compatible applications. @n
         *                                      For more information, see @ref CompGetCurrentLevelInPercentage "here".
         * @endif
-        * @return      An error code
-        * @param[out]  level   The percentage of the charge remaining in the battery
-        * @exception   E_SUCCESS       The method is successful.
+        * @return              An error code
+        * @param[out]  level                   The percentage of the charge remaining in the battery
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE The battery service is not available.
-        * @exception   E_SYSTEM        The method cannot proceed due to a severe system error.
-        * @remarks The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum).
+        * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
+        * @remarks     The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum).
         * @endcond
         */
        static result GetCurrentLevelInPercentage(int& level);
@@ -102,11 +101,11 @@ public:
         * @compatibility       This method has compatibility issues with OSP compatible applications. @n
         *                                      For more information, see @ref CompGetCurrentLevel "here".
         * @endif
-        * @return      An error code
+        * @return              An error code
         * @param[out]  level           A value from the enumerator BatteryLevel indicating the current charging level
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE The battery service is not available.
-        * @exception   E_SYSTEM        The method cannot proceed due to a severe system error.
+        * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         * @endcond
         */
        static result GetCurrentLevel(BatteryLevel& level);
@@ -139,10 +138,10 @@ public:
         * @endif
         * @return      An error code
         * @param[out]  charging        Set to @c true if the charging cable is connected to the phone, @n
-        *                              else @c false
-        * @exception   E_SUCCESS       The method is successful.
+        *                                                      else @c false
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE The battery service is not available.
-        * @exception   E_SYSTEM        The method cannot proceed due to a severe system error.
+        * @exception   E_SYSTEM                The method cannot proceed due to a severe system error.
         * @endcond
         */
        static result IsCharging(bool& charging);