From 65a9859a4cdb754f2247e2b540154c5b11cd6d9c Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Fri, 28 Jul 2017 14:43:03 +0530 Subject: [PATCH] Review storage API cs files PS2: Edited as per comments PS3: Recover deleted files PS6: Restore unchanged files Change-Id: I0d7e58d2309382ece7d779cf0f372cdf032c6504 --- LICENSE | 0 packaging/csapi-storage.manifest | 0 src/Tizen.System.Storage/Storage/DirectoryType.cs | 20 ++++++------ src/Tizen.System.Storage/Storage/Storage.cs | 38 +++++++++++----------- src/Tizen.System.Storage/Storage/StorageArea.cs | 6 ++-- src/Tizen.System.Storage/Storage/StorageManager.cs | 4 +-- src/Tizen.System.Storage/Storage/StorageState.cs | 8 ++--- 7 files changed, 38 insertions(+), 38 deletions(-) mode change 100755 => 100644 LICENSE mode change 100755 => 100644 packaging/csapi-storage.manifest diff --git a/LICENSE b/LICENSE old mode 100755 new mode 100644 diff --git a/packaging/csapi-storage.manifest b/packaging/csapi-storage.manifest old mode 100755 new mode 100644 diff --git a/src/Tizen.System.Storage/Storage/DirectoryType.cs b/src/Tizen.System.Storage/Storage/DirectoryType.cs index ed4cb2b..e3b996f 100644 --- a/src/Tizen.System.Storage/Storage/DirectoryType.cs +++ b/src/Tizen.System.Storage/Storage/DirectoryType.cs @@ -17,53 +17,53 @@ namespace Tizen.System { /// - /// Enumeration of the storage directory types. + /// Enumeration for the DirectoryType storage. /// /// 3 public enum DirectoryType { /// - /// Image directory + /// Image directory. /// /// 3 Images = Interop.Storage.DirectoryType.Images, /// - /// Sounds directory + /// Sounds directory. /// /// 3 Sounds = Interop.Storage.DirectoryType.Sounds, /// - /// Videos directory + /// Videos directory. /// /// 3 Videos = Interop.Storage.DirectoryType.Videos, /// - /// Camera directory + /// Camera directory. /// /// 3 Camera = Interop.Storage.DirectoryType.Camera, /// - /// Downloads directory + /// Downloads directory. /// /// 3 Downloads = Interop.Storage.DirectoryType.Downloads, /// - /// Music directory + /// Music directory. /// /// 3 Music = Interop.Storage.DirectoryType.Music, /// - /// Documents directory + /// Documents directory. /// /// 3 Documents = Interop.Storage.DirectoryType.Documents, /// - /// Others directory + /// Others directory. /// /// 3 Others = Interop.Storage.DirectoryType.Others, /// - /// System ringtones directory. Only available for internal storage. + /// System ringtones directory is only available for an internal storage. /// /// 3 Ringtones = Interop.Storage.DirectoryType.Ringtones, diff --git a/src/Tizen.System.Storage/Storage/Storage.cs b/src/Tizen.System.Storage/Storage/Storage.cs index ce70b88..adc6359 100644 --- a/src/Tizen.System.Storage/Storage/Storage.cs +++ b/src/Tizen.System.Storage/Storage/Storage.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System { /// - /// class to access storage device information + /// The class to access the storage device information. /// public class Storage { @@ -75,7 +75,7 @@ namespace Tizen.System /// StorageStateChanged event. This event is occurred when a storage state changes. /// /// - /// Storage state will be updated before calling event handler. + /// The storage state will be updated before calling the event handler. /// /// 3 /// @@ -112,28 +112,28 @@ namespace Tizen.System } /// - /// Storage ID + /// The storage ID. /// /// 3 public int Id { get; } /// - /// Type of the storage + /// The type of storage. /// /// 3 public StorageArea StorageType { get; } /// - /// Root directory for the storage + /// The root directory for the storage. /// /// 3 public string RootDirectory { get; } /// - /// Total storage size in bytes + /// The total storage size in bytes. /// /// 3 public ulong TotalSpace { get { return _totalSpace; } } /// - /// Storage state + /// The StorageState. /// /// 3 public StorageState State @@ -153,7 +153,7 @@ namespace Tizen.System } /// - /// Available storage size in bytes + /// The available storage size in bytes. /// /// 3 public ulong AvaliableSpace @@ -172,26 +172,26 @@ namespace Tizen.System } /// - /// Absolute path for given directory type in storage + /// Absolute path for a given directory type in the storage. /// /// - /// returned directory path may not exist, so you must make sure that it exists before using it. - /// For accessing internal storage except Ringtones directory, app should have http://tizen.org/privilege/mediastorage privilege. - /// For accessing Ringtones directory, app should have http://tizen.org/privilege/systemsettings privilege. - /// For accessing external storage, app should have http://tizen.org/privilege/externalstorage privilege. + /// The returned directory path may not exist, so you must make sure that it exists before using it. + /// For accessing internal storage except the ringtones directory, the application should have http://tizen.org/privilege/mediastorage privilege. + /// For accessing ringtones directory, the application should have http://tizen.org/privilege/systemsettings privilege. + /// For accessing external storage, the application should have http://tizen.org/privilege/externalstorage privilege. /// /// 3 - /// Directory type - /// Absolute path for given directory type in storage - /// Thrown when failed because of a invalid arguament - /// Thrown when failed due to out of memory exception - /// Thrown when failed if storage is not supported or app does not have permission to access directory path + /// Directory type. + /// Absolute path for a given directory type in the storage. + /// Thrown when failed because of an invalid argument. + /// Thrown when failed due to out of memory exception. + /// Thrown when failed if the storage is not supported or the application does not have the permission to access the directory path. /// http://tizen.org/privilege/mediastorage /// http://tizen.org/privilege/systemsettings /// http://tizen.org/privilege/externalstorage /// /// - /// // To get video directories for all supported storage, + /// // To get the video directories for all the supported storage, /// var storageList = StorageManager.Storages as List<Storage>; /// foreach (var storage in storageList) /// { diff --git a/src/Tizen.System.Storage/Storage/StorageArea.cs b/src/Tizen.System.Storage/Storage/StorageArea.cs index 7a0e80d..2d9a26b 100644 --- a/src/Tizen.System.Storage/Storage/StorageArea.cs +++ b/src/Tizen.System.Storage/Storage/StorageArea.cs @@ -17,18 +17,18 @@ namespace Tizen.System { /// - /// Enumeration for storage area types. + /// Enumeration for the storage area types. /// /// 3 public enum StorageArea { /// - /// Internal device storage (built-in storage in a device, non-removable) + /// Internal device storage (built-in storage in a device, non-removable). /// /// 3 Internal = Interop.Storage.StorageArea.Internal, /// - /// External storage + /// External storage. /// /// 3 External = Interop.Storage.StorageArea.External, diff --git a/src/Tizen.System.Storage/Storage/StorageManager.cs b/src/Tizen.System.Storage/Storage/StorageManager.cs index dc16470..0335b2e 100644 --- a/src/Tizen.System.Storage/Storage/StorageManager.cs +++ b/src/Tizen.System.Storage/Storage/StorageManager.cs @@ -20,14 +20,14 @@ using System.Collections.Generic; namespace Tizen.System { /// - /// Storage Manager, provides properties/ methods to access storage in the device. + /// The StorageManager provides the properties or methods to access storage in the device. /// public static class StorageManager { private const string LogTag = "Tizen.System"; /// - /// List of all storage in the device + /// List of all storage in the device. /// /// 3 public static IEnumerable Storages diff --git a/src/Tizen.System.Storage/Storage/StorageState.cs b/src/Tizen.System.Storage/Storage/StorageState.cs index 49151b6..fc60550 100644 --- a/src/Tizen.System.Storage/Storage/StorageState.cs +++ b/src/Tizen.System.Storage/Storage/StorageState.cs @@ -23,22 +23,22 @@ namespace Tizen.System public enum StorageState { /// - /// Storage is present but cannot be mounted. Typically it happens if the file system of the storage is corrupted + /// The storage is present but cannot be mounted. Typically, it happens if the file system of the storage is corrupted. /// /// 3 Unmountable = Interop.Storage.StorageState.Unmountable, /// - /// Storage is not present or removed + /// The storage is not present or removed. /// /// 3 Removed = Interop.Storage.StorageState.Removed, /// - /// Storage is mounted with read/write access + /// The storage is mounted with read/write access. /// /// 3 Mounted = Interop.Storage.StorageState.Mounted, /// - /// Storage is mounted with read only access + /// The storage is mounted with read-only access. /// /// 3 MountedReadOnly = Interop.Storage.StorageState.MountedReadOnly, -- 2.7.4