Add IPC sync result for SerialPort::Write()

[platform/framework/native/appfw.git] / inc / FIoMmcStorageManager.h

diff --git a/inc/FIoMmcStorageManager.h b/inc/FIoMmcStorageManager.h
index b21970b..52ca436 100644 (file)
--- a/inc/FIoMmcStorageManager.h
+++ b/inc/FIoMmcStorageManager.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -34,29 +33,74 @@ namespace Tizen { namespace Io
 {
 
 /**
-* @class       MmcStorageManager
-* @brief       This class provides methods to mount, unmount, and format external MMC.
-*
-* @since       2.0
-*
-* @final       This class is not intended for extension.
-*
-* The %MmcStorageManager class provides methods to mount, unmount, and format external MMC.
-*
-* @see IMmcStorageMountListener
-* @see IMmcStorageFormatListener
-*/
+ * @class      MmcStorageManager
+ * @brief      This class provides methods to mount, unmount, and format external MMC.
+ *
+ * @since      2.0
+ *
+ * @final      This class is not intended for extension.
+ *
+ * The %MmcStorageManager class provides methods to mount, unmount, and format external MMC.
+ *
+ * @see IMmcStorageMountListener
+ * @see IMmcStorageFormatListener
+ *
+ * @code
+ *
+ * #include <FBase.h>
+ * #include <FIo.h>
+ *
+ * using namespace Tizen::Base;
+ * using namespace Tizen::Io;
+ *
+ * class MyMmcStorageMountListener
+ * : public Tizen::Io::IMmcStorageMountListener
+ * {
+ * public:
+ *     void OnMmcStorageMounted (result r)
+ *     {
+ *             if (!IsFailed(r))
+ *             {
+ *                     AppLog(“External MMC is mounted”);
+ *             }
+ *     }
+ *
+ *     void OnMmcStorageUnmounted (result r)
+ *     {
+ *             if (!IsFailed(r))
+ *             {
+ *                 AppLog(“External MMC is unmounted”);
+ *             }
+ *     }
+ * };
+ *
+ * void
+ * MyClass::Execute(void)
+ * {
+ *             MyMmcStorageMountListener* pMyMmcStorageMountListener = new MyMmcStorageMountListener();
+ *
+ *             MmcStorageManager* pMmcStorageMgr = new MmcStorageManager();
+ *
+ *             pMmcStorageMgr->AddMmcStorageMountListener(*pMyMmcStorageMountListener);
+ *
+ *             pMmcStorageMgr->Mount();
+ *
+ *             pMmcStorageMgr->Unmount();
+ * }
+ *
+ * @endcode
+ */
 class _OSP_EXPORT_ MmcStorageManager
            : public Tizen::Base::Object
 {
 
 public:
        /**
-       * Gets the MMC storage manager instance.
+       * Gets the pointer to the %MmcStorageManager instance.
        *
        * @since                2.0
        *
-       * @return               A pointer to %MmcStorageManager instance if this method is successful, @n
+       * @return               The pointer to %MmcStorageManager instance if this method is successful, @n
        *                               else @c null
        * @exception    E_SUCCESS                       The method is successful.
        * @exception    E_SYSTEM                        The method cannot proceed due to a severe system error.
@@ -65,14 +109,15 @@ public:
        static MmcStorageManager* GetInstance(void);
 
        /**
-       * Mounts file system of external MMC.
+       * Mounts the file system of the external MMC.
        *
        * @since                2.0
        * @privlevel    platform
-       * @privilege    %http://tizen.org/privilege/systemsetting.read
+       * @privilege    %http://tizen.org/privilege/settingmanager.write @n
+       *                               (%http://tizen.org/privilege/systemsetting.read is deprecated.)
        *
        * @return               An error code
-       * @exception    E_SUCCESS                       Mount operation is successfully started.
+       * @exception    E_SUCCESS                       The mount operation is successfully started.
        * @exception    E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
        * @exception    E_INVALID_OPERATION     The external MMC has already been mounted.
        * @exception    E_SERVICE_BUSY          One of mount, unmount and format operations is ongoing.
@@ -83,14 +128,15 @@ public:
        result Mount(void);
 
        /**
-       * Unmounts file system of external MMC.
+       * Unmounts the file system of the external MMC.
        *
        * @since                2.0
        * @privlevel    platform
-       * @privilege    %http://tizen.org/privilege/systemsetting.read
+       * @privilege    %http://tizen.org/privilege/settingmanager.write @n
+       *                               (%http://tizen.org/privilege/systemsetting.read is deprecated.)
        *
        * @return               An error code
-       * @exception    E_SUCCESS                       Unmount operation is successfully started.
+       * @exception    E_SUCCESS                       The unmount operation is successfully started.
        * @exception    E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
        * @exception    E_INVALID_OPERATION     The external MMC has already been unmounted.
        * @exception    E_SERVICE_BUSY          One of mount, unmount and format operations is ongoing.
@@ -99,14 +145,15 @@ public:
        result Unmount(void);
 
        /**
-       * Formats file system of external MMC.
+       * Formats the file system of the external MMC.
        *
        * @since                2.0
        * @privlevel    platform
-       * @privilege    %http://tizen.org/privilege/systemsetting.read
+       * @privilege    %http://tizen.org/privilege/settingmanager.write @n
+       *                               (%http://tizen.org/privilege/systemsetting.read is deprecated.)
        *
        * @return               An error code
-       * @exception    E_SUCCESS                       Format operation is successfully started.
+       * @exception    E_SUCCESS                       The format operation is successfully started.
        * @exception    E_PRIVILEGE_DENIED      The application does not have the privilege to call this method.
        * @exception    E_INVALID_OPERATION     The external MMC should be unmounted for format operation.
        * @exception    E_SERVICE_BUSY          One of mount, unmount and format operations is ongoing.