From c380105b4351fa112dfb5afee2510893ce9eac53 Mon Sep 17 00:00:00 2001 From: Youngjae Cho Date: Tue, 24 Sep 2024 17:42:55 +0900 Subject: [PATCH] [System.Information] Elaborate API description Signed-off-by: Youngjae Cho --- .../Common/Information.cs | 2 +- .../Usage/ProcessCpuUsage.cs | 12 +++++----- .../Usage/ProcessMemoryUsage.cs | 24 +++++++++---------- .../Usage/SystemCpuUsage.cs | 18 +++++++------- .../Usage/SystemMemoryUsage.cs | 14 +++++------ 5 files changed, 35 insertions(+), 35 deletions(-) diff --git a/src/Tizen.System.Information/Common/Information.cs b/src/Tizen.System.Information/Common/Information.cs index 62a01aaea06..8ae73edfa6c 100644 --- a/src/Tizen.System.Information/Common/Information.cs +++ b/src/Tizen.System.Information/Common/Information.cs @@ -124,7 +124,7 @@ private static bool TryGetSystemInfoValue(string key, out T value) #pragma warning restore CS0618 // Type or member is obsolete /// - /// Gets the value of the feature. + /// Gets the value of the feature. It accepts both system and runtime feature key. /// /// 4 /// The type of . diff --git a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs index f42fee9d2ae..53a387772d7 100755 --- a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs +++ b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs @@ -23,7 +23,7 @@ namespace Tizen.System { /// - /// The class for CPU usage per process. + /// The class for CPU usage per given list of process. /// /// 3 public class ProcessCpuUsage @@ -32,7 +32,7 @@ public class ProcessCpuUsage private Interop.RuntimeInfo.ProcessCpuUsage[] Usages; /// - /// The constructor of ProcessCpuUsage class. + /// The constructor of ProcessCpuUsage class of the given list of process. It internally call Update() on constructing an instance. /// /// 4 /// List of unique process ids. @@ -47,13 +47,13 @@ public ProcessCpuUsage(IEnumerable pid) } /// - /// The number of usage entries. + /// The number of processes being tracked by the instance. /// /// 4 public int Count { get; internal set; } /// - /// Gets the amount of time this process has been scheduled in user mode. + /// Gets the amount of time this process has been scheduled in user mode. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -71,7 +71,7 @@ public uint GetUTime(int pid) } /// - /// Gets the amount of time this process has been scheduled in kernel mode. + /// Gets the amount of time this process has been scheduled in kernel mode. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -89,7 +89,7 @@ public uint GetSTime(int pid) } /// - /// Update the process CPU usage to the latest. + /// Update CPU usage of the given processes to the latest. /// /// 4 /// List of unique process ids. diff --git a/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs b/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs index 0c4a2a393fe..8b1bbeee02f 100755 --- a/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs +++ b/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs @@ -36,7 +36,7 @@ public class ProcessMemoryUsage private int[] Gems; /// - /// The constructor of ProcessMemoryInformation class. + /// The constructor of ProcessMemoryInformation class of the given list of process. It internally call Update() on constructing an instance. /// /// 4 /// List of unique process ids. @@ -51,13 +51,13 @@ public ProcessMemoryUsage(IEnumerable pid) } /// - /// The number of usage entries. + /// The number of processes being tracked by the instance. /// /// 4 public int Count => Pids.Length; /// - /// Gets the virtual memory size of a process. + /// Gets the virtual memory size of the given process. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -75,7 +75,7 @@ public int GetVsz(int pid) } /// - /// Gets the resident set size of a process. + /// Gets the resident set size of the given process. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -93,7 +93,7 @@ public int GetRss(int pid) } /// - /// Gets the proportional set size of a process. + /// Gets the proportional set size of the given process. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -111,7 +111,7 @@ public int GetPss(int pid) } /// - /// Gets the size not modified and mapped by other processes of a process. + /// Gets the memory size of the given process that is not modified and mapped by other processes. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -129,7 +129,7 @@ public int GetSharedClean(int pid) } /// - /// Gets the size modified and mapped by other processes of a process. + /// Gets the memory size of the given process that is modified and mapped by other processes. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -147,7 +147,7 @@ public int GetSharedDirty(int pid) } /// - /// Gets the size not modified and available only to that process of a process. + /// Gets the memory size of the given process that is not modified and available only to it. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -165,7 +165,7 @@ public int GetPrivateClean(int pid) } /// - /// Gets the size modified and available only to that process of a process. + /// Gets the memory size of the given process that is modified and available only to it. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The process id. @@ -183,7 +183,7 @@ public int GetPrivateDirty(int pid) } /// - /// Gets the GPU memory size of a process. + /// Gets the GPU memory size of the given process. To get the latest value, it is recommended to call Update() before it. /// /// The process id. /// The GPU memory size is using (KiB). @@ -208,7 +208,7 @@ public int GetGPU(int pid) } /// - /// Gets the resident set size in graphic execution manager of a process. + /// Gets the resident set size in graphic execution manager of a process. To get the latest value, it is recommended to call Update() before it. /// /// The process id. /// The resident set size is using (KiB). @@ -233,7 +233,7 @@ public int GetGemRss(int pid) } /// - /// Gets the SWAP memory size of a process. + /// Gets the SWAP memory size of the given process. To get the latest value, it is recommended to call Update() before it. /// /// The process id. /// The SWAP memory size is using (KiB). diff --git a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs index a248275ee4e..76eee812d08 100755 --- a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs +++ b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs @@ -20,7 +20,7 @@ namespace Tizen.System { /// - /// The class for system CPU usage. + /// The class for CPU usage information of the system. /// /// 4 public class SystemCpuUsage @@ -30,7 +30,7 @@ public class SystemCpuUsage private int[] MaxFrequencies; /// - /// The constructor of SystemCpuUsage class. + /// The constructor of SystemCpuUsage class. It internally call Update() on constructing an instance. /// /// 4 /// Thrown when an I/O error occurs while reading from the system. @@ -41,7 +41,7 @@ public SystemCpuUsage() } /// - /// Running time of un-niced user processes (Percent). + /// Running time of un-niced user processes (Percent). To get the latest value, it is recommended to call Update() before it. /// /// 4 public double User @@ -53,7 +53,7 @@ public double User } /// - /// Running time of kernel processes (Percent). + /// Running time of kernel processes (Percent). To get the latest value, it is recommended to call Update() before it. /// /// 4 public double System @@ -65,7 +65,7 @@ public double System } /// - /// Running time of niced user processes (Percent). + /// Running time of niced user processes (Percent). To get the latest value, it is recommended to call Update() before it. /// /// 4 public double Nice @@ -77,7 +77,7 @@ public double Nice } /// - /// Time waiting for I/O completion (Percent). + /// Time waiting for I/O completion (Percent). To get the latest value, it is recommended to call Update() before it. /// /// 4 public double IoWait @@ -95,7 +95,7 @@ public double IoWait public int ProcessorCount { get; internal set; } /// - /// Gets the current frequency of the processor. + /// Gets the current frequency of the processor. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The index (from 0) of the CPU core that you want to know the frequency of. @@ -113,7 +113,7 @@ public int GetCurrentFrequency(int coreId) } /// - /// Gets the max frequency of the processor. + /// Gets the max frequency of the processor. To get the latest value, it is recommended to call Update() before it. /// /// 4 /// The index (from 0) of CPU core that you want to know the frequency of. @@ -131,7 +131,7 @@ public int GetMaxFrequency(int coreId) } /// - /// Update the system CPU usage to the latest. + /// Update the system CPU usage information to the latest. /// /// 4 /// Thrown when an I/O error occurs while reading from the system. diff --git a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs index 4819afa8109..e0c7e715a97 100755 --- a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs +++ b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs @@ -19,7 +19,7 @@ namespace Tizen.System { /// - /// The class for system memory information. + /// The class for memory usage information of the system. /// /// 4 public class SystemMemoryUsage @@ -27,7 +27,7 @@ public class SystemMemoryUsage private Interop.RuntimeInfo.MemoryInfo Info; /// - /// The constructor of MemoryInformation class. + /// The constructor of MemoryInformation class. It internally call Update() on constructing an instance. /// /// 4 /// Thrown when an I/O error occurs while reading from the system. @@ -37,7 +37,7 @@ public SystemMemoryUsage() } /// - /// Total memory (KiB). + /// Total memory (KiB). To get the latest value, it is recommended to call Update() before it. /// /// 4 public int Total @@ -49,7 +49,7 @@ public int Total } /// - /// Used memory (KiB). + /// Used memory (KiB). To get the latest value, it is recommended to call Update() before it. /// /// 4 public int Used @@ -61,7 +61,7 @@ public int Used } /// - /// Free memory (KiB). + /// Free memory (KiB). To get the latest value, it is recommended to call Update() before it. /// /// 4 public int Free @@ -73,7 +73,7 @@ public int Free } /// - /// Cache memory (KiB). + /// Cache memory (KiB). To get the latest value, it is recommended to call Update() before it. /// /// 4 public int Cache @@ -85,7 +85,7 @@ public int Cache } /// - /// Swap memory (KiB). + /// Swap memory (KiB). To get the latest value, it is recommended to call Update() before it. /// /// 4 public int Swap