Add IPC sync result for SerialPort::Write()

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

diff --git a/inc/FSysEnvironment.h b/inc/FSysEnvironment.h
index aec9cf4..f124bb2 100644 (file)
--- a/inc/FSysEnvironment.h
+++ b/inc/FSysEnvironment.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);
@@ -73,20 +72,24 @@ class _OSP_EXPORT_ Environment
 
 public:
        /**
-       * Gets the path for the media directory that is usually used to store media contents.
+       * Gets the path for the media directory that stores the media contents.
        *
        * @since 2.0
        *
        * @return       The media directory path
+       * @remarks      If the platform policy is changed or the device is different, the returned file path can be different. @n
+       *                       Rather than changing the returned file path as hard coding, use as it is.
        */
        static Tizen::Base::String GetMediaPath(void);
 
        /**
-       * Gets the path for the default download directory that is usually used to store downloaded contents by the Tizen::Content::DownloadManager class.
+       * Gets the path for the default download directory that stores the downloaded contents by the Tizen::Content::DownloadManager class.
        *
        * @since 2.0
        *
        * @return       The default download directory path
+       * @remarks      If the platform policy is changed or the device is different, the returned file path can be different. @n
+       *                       Rather than changing the returned file path as hard coding, use as it is.
        */
        static Tizen::Base::String GetDefaultDownloadPath(void);
 
@@ -96,20 +99,25 @@ public:
        * @since 2.0
        *
        * @return       The external storage directory path
+       * @remarks      If the platform policy is changed or the device is different, the returned file path can be different. @n
+       *                       Rather than changing the returned file path as hard coding, use as it is.
        */
        static Tizen::Base::String GetExternalStoragePath(void);
 
        /**
        * Gets the directory path according to the pre-defined directory type.
        *
-       * @since        2.0
+       * @since                2.0
        *
-       * @return       The pre-defined directory path according to the specified @c dirType, @n
-       *               else an empty string if the specified @c dirType is invalid
-       * @param[in]    dirType The pre-defined directory type
-       * @remarks      The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist,
-       *               so you must make sure that it exists before using it.
-       * @see          Tizen::Io::Directory::Create()
+       * @return               The pre-defined directory path according to the specified @c dirType, @n
+       *                               else an empty string if the specified @c dirType is invalid
+       * @param[in]    dirType         The pre-defined directory type
+       * @remarks
+       *                               - The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist,
+       *                                 so you must make sure that it exists before using it.
+       *                               - If the platform policy is changed or the device is different, the returned file path can be different. @n
+       *                                 Rather than changing the returned file path as hard coding, use as it is.
+       * @see                  Tizen::Io::Directory::Create()
        */
        static Tizen::Base::String GetPredefinedPath(PredefinedDirectoryType dirType);