Skip to content

Commit

Permalink
[Tizen.System.Storage] Update the description of APIs
Browse files Browse the repository at this point in the history
Update the description of Tizen.System.Storage APIs

Signed-off-by: Unsung Lee <[email protected]>
  • Loading branch information
Unsung Lee authored and chanwoochoi committed Sep 30, 2024
1 parent 9b73d80 commit e83b0b2
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/Tizen.System.Storage/Storage/Storage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -157,32 +157,32 @@ public event EventHandler StorageStateChanged
}

/// <summary>
/// The storage ID.
/// The storage ID. It is the identifier used to determine whether the corresponding storage is internal or external.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
public int Id { get; }
/// <summary>
/// The type of storage.
/// The type of storage. It has one of three values: internal, external or extended internal.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
public StorageArea StorageType { get { return (StorageArea)_storagetype; } }
/// <summary>
/// The root directory for the storage.
/// The root directory for the storage. It generally has an absolute path.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
public string RootDirectory { get; }
/// <summary>
/// The total storage size in bytes.
/// The total storage space in bytes. The type of value is ulong.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
public ulong TotalSpace { get { return _totalSpace; } }

/// <summary>
/// The StorageState.
/// The StorageState. It contains information about the mounted state of the storage.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand All @@ -203,7 +203,7 @@ public StorageState State
}

/// <summary>
/// The StorageDevice.
/// The StorageDevice. It indicates information such as sdcard or USB storage.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand All @@ -222,7 +222,7 @@ public StorageDevice DeviceType
}

/// <summary>
/// The type of file system.
/// The type of file system. For example, it can be ext3 or ext4.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand All @@ -241,7 +241,7 @@ public string Fstype
}

/// <summary>
/// The UUID of the file system.
/// The UUID of the file system. It is a unique value that serves as immutable identifier.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand All @@ -260,7 +260,7 @@ public string Fsuuid
}

/// <summary>
/// Information whether this is a primary partition.
/// Information whether this is a primary partition or not.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand All @@ -279,7 +279,7 @@ public bool Primary
}

/// <summary>
/// The flags for the storage status.
/// The flags for the storage status. It is a piece of information representing storage.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand Down Expand Up @@ -320,7 +320,7 @@ public ulong AvaliableSpace
}

/// <summary>
/// The available storage size in bytes.
/// The available storage size in bytes. The type of value is ulong.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
Expand All @@ -340,7 +340,7 @@ public ulong AvailableSpace
}

/// <summary>
/// Absolute path for a given directory type in the storage.
/// Gets the absolute path to the root directory of the given storage.
/// </summary>
/// <remarks>
/// The returned directory path may not exist, so you must make sure that it exists before using it.
Expand Down
14 changes: 14 additions & 0 deletions src/Tizen.System.Storage/Storage/StorageManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@ private static void UnregisterChangedEvent(StorageArea type)
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
/// <exception cref="NotSupportedException">Thrown when the storage is not supported.</exception>
/// <seealso cref="UnSetChangedEvent(StorageArea, EventHandler)"/>
/// <example>
/// <code>
/// EventHandler callback = (s, e) =>
/// {
/// var storage = s as Storage;
/// if (storage == null) return;
/// };
///
/// StorageManager.SetChangedEvent(StorageArea.External, callback);
/// StorageManager.UnSetChangedEvent(StorageArea.External, callback);
/// </code>
/// </example>
public static void SetChangedEvent(StorageArea type, EventHandler handler)
{
if (type == StorageArea.Internal)
Expand Down Expand Up @@ -138,6 +151,7 @@ public static void SetChangedEvent(StorageArea type, EventHandler handler)
/// <since_tizen> 5 </since_tizen>
/// <feature> http://tizen.org/feature/storage.external </feature>
/// <exception cref="NotSupportedException">Thrown when the storage is not supported.</exception>
/// <seealso cref="SetChangedEvent(StorageArea, EventHandler)"/>
public static void UnsetChangedEvent(StorageArea type, EventHandler handler)
{
if (type == StorageArea.Internal)
Expand Down

0 comments on commit e83b0b2

Please sign in to comment.