[System.Information] Elaborate API description

Signed-off-by: Youngjae Cho <[email protected]>
Samsung · Sep 27, 2024 · c380105 · c380105
1 parent 645db63
commit c380105
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 35 deletions.
diff --git a/src/Tizen.System.Information/Common/Information.cs b/src/Tizen.System.Information/Common/Information.cs
@@ -124,7 +124,7 @@ private static bool TryGetSystemInfoValue<T>(string key, out T value)
 #pragma warning restore CS0618 // Type or member is obsolete
 
         /// <summary>
-        /// Gets the value of the feature.
+        /// Gets the value of the feature. It accepts both system and runtime feature key.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <typeparam name="T">The type of <paramref name="value"/>.</typeparam>

diff --git a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs
@@ -23,7 +23,7 @@
 namespace Tizen.System
 {
     /// <summary>
-    /// The class for CPU usage per process.
+    /// The class for CPU usage per given list of process.
     /// </summary>
     /// <since_tizen> 3 </since_tizen>
     public class ProcessCpuUsage
@@ -32,7 +32,7 @@ public class ProcessCpuUsage
         private Interop.RuntimeInfo.ProcessCpuUsage[] Usages;
 
         /// <summary>
-        /// The constructor of ProcessCpuUsage class.
+        /// The constructor of ProcessCpuUsage class of the given list of process. It internally call Update() on constructing an instance.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">List of unique process ids.</param>
@@ -47,13 +47,13 @@ public ProcessCpuUsage(IEnumerable<int> pid)
         }
 
         /// <summary>
-        /// The number of usage entries.
+        /// The number of processes being tracked by the instance.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Count { get; internal set; }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -71,7 +71,7 @@ public uint GetUTime(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -89,7 +89,7 @@ public uint GetSTime(int pid)
         }
 
         /// <summary>
-        /// Update the process CPU usage to the latest.
+        /// Update CPU usage of the given processes to the latest.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">List of unique process ids.</param>

diff --git 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;
 
         /// <summary>
-        /// The constructor of ProcessMemoryInformation class.
+        /// The constructor of ProcessMemoryInformation class of the given list of process. It internally call Update() on constructing an instance.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">List of unique process ids.</param>
@@ -51,13 +51,13 @@ public ProcessMemoryUsage(IEnumerable<int> pid)
         }
 
         /// <summary>
-        /// The number of usage entries.
+        /// The number of processes being tracked by the instance.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Count => Pids.Length;
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -75,7 +75,7 @@ public int GetVsz(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -93,7 +93,7 @@ public int GetRss(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -111,7 +111,7 @@ public int GetPss(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -129,7 +129,7 @@ public int GetSharedClean(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -147,7 +147,7 @@ public int GetSharedDirty(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -165,7 +165,7 @@ public int GetPrivateClean(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="pid">The process id.</param>
@@ -183,7 +183,7 @@ public int GetPrivateDirty(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="pid">The process id.</param>
         /// <returns>The GPU memory size <paramref name="pid"/> is using (KiB).</returns>
@@ -208,7 +208,7 @@ public int GetGPU(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="pid">The process id.</param>
         /// <returns>The resident set size <paramref name="pid"/> is using (KiB).</returns>
@@ -233,7 +233,7 @@ public int GetGemRss(int pid)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="pid">The process id.</param>
         /// <returns>The SWAP memory size <paramref name="pid"/> is using (KiB).</returns>

diff --git a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs
@@ -20,7 +20,7 @@
 namespace Tizen.System
 {
     /// <summary>
-    /// The class for system CPU usage.
+    /// The class for CPU usage information of the system.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public class SystemCpuUsage
@@ -30,7 +30,7 @@ public class SystemCpuUsage
         private int[] MaxFrequencies;
 
         /// <summary>
-        /// The constructor of SystemCpuUsage class.
+        /// The constructor of SystemCpuUsage class. It internally call Update() on constructing an instance.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <exception cref="IOException">Thrown when an I/O error occurs while reading from the system.</exception>
@@ -41,7 +41,7 @@ public SystemCpuUsage()
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public double User
@@ -53,7 +53,7 @@ public double User
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public double System
@@ -65,7 +65,7 @@ public double System
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public double Nice
@@ -77,7 +77,7 @@ public double Nice
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public double IoWait
@@ -95,7 +95,7 @@ public double IoWait
         public int ProcessorCount { get; internal set; }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="coreId">The index (from 0) of the CPU core that you want to know the frequency of.</param>
@@ -113,7 +113,7 @@ public int GetCurrentFrequency(int coreId)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <param name="coreId">The index (from 0) of CPU core that you want to know the frequency of.</param>
@@ -131,7 +131,7 @@ public int GetMaxFrequency(int coreId)
         }
 
         /// <summary>
-        /// Update the system CPU usage to the latest.
+        /// Update the system CPU usage information to the latest.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <exception cref="IOException">Thrown when an I/O error occurs while reading from the system.</exception>

diff --git a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs
@@ -19,15 +19,15 @@
 namespace Tizen.System
 {
     /// <summary>
-    /// The class for system memory information.
+    /// The class for memory usage information of the system.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
     public class SystemMemoryUsage
     {
         private Interop.RuntimeInfo.MemoryInfo Info;
 
         /// <summary>
-        /// The constructor of MemoryInformation class.
+        /// The constructor of MemoryInformation class. It internally call Update() on constructing an instance.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         /// <exception cref="IOException">Thrown when an I/O error occurs while reading from the system.</exception>
@@ -37,7 +37,7 @@ public SystemMemoryUsage()
         }
 
         /// <summary>
-        /// Total memory (KiB).
+        /// Total memory (KiB). To get the latest value, it is recommended to call Update() before it.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Total
@@ -49,7 +49,7 @@ public int Total
         }
 
         /// <summary>
-        /// Used memory (KiB).
+        /// Used memory (KiB). To get the latest value, it is recommended to call Update() before it.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Used
@@ -61,7 +61,7 @@ public int Used
         }
 
         /// <summary>
-        /// Free memory (KiB).
+        /// Free memory (KiB). To get the latest value, it is recommended to call Update() before it.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Free
@@ -73,7 +73,7 @@ public int Free
         }
 
         /// <summary>
-        /// Cache memory (KiB).
+        /// Cache memory (KiB). To get the latest value, it is recommended to call Update() before it.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Cache
@@ -85,7 +85,7 @@ public int Cache
         }
 
         /// <summary>
-        /// Swap memory (KiB).
+        /// Swap memory (KiB). To get the latest value, it is recommended to call Update() before it.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public int Swap