From c4966c135939da7facba2d13a06d0959e729a913 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Wed, 26 Jul 2017 11:32:39 +0530 Subject: [PATCH] Review INFORMATION API files PS2: Edited as per comments PS3: Recover deleted files PS5: Restore unchanged files Change-Id: I1b0c93277e414e0421212135678d3e6f00f96df0 --- .../RuntimeInfo/CpuUsage.cs | 16 +-- .../RuntimeInfo/Enumerations.cs | 34 +++--- .../RuntimeInfo/MemoryInformation.cs | 26 ++--- .../RuntimeInfo/RuntimeInfoErrorFactory.cs | 0 .../RuntimeInfo/RuntimeInformation.cs | 114 ++++++++++----------- .../RuntimeKeyStatusChangedEventArgs.cs | 2 +- .../SystemInfo/SystemInfo.cs | 62 +++++------ 7 files changed, 127 insertions(+), 127 deletions(-) mode change 100755 => 100644 src/Tizen.System.Information/RuntimeInfo/RuntimeInfoErrorFactory.cs diff --git a/src/Tizen.System.Information/RuntimeInfo/CpuUsage.cs b/src/Tizen.System.Information/RuntimeInfo/CpuUsage.cs index 813036c..35ceb90 100755 --- a/src/Tizen.System.Information/RuntimeInfo/CpuUsage.cs +++ b/src/Tizen.System.Information/RuntimeInfo/CpuUsage.cs @@ -24,7 +24,7 @@ using System.ComponentModel; namespace Tizen.System { /// - /// Structure for CPU usage. + /// The structure for CPU usage. /// public class CpuUsage { @@ -37,25 +37,25 @@ namespace Tizen.System User = usage.User; } /// - /// Time running un-niced user processes (Percent) + /// Running time of un-niced user processes (Percent). /// public double User { get; internal set; } /// - /// Time running kernel processes (Percent) + /// Running time of kernel processes (Percent). /// public double System { get; internal set; } /// - /// Time running niced user processes (Percent) + /// Running time of niced user processes (Percent). /// public double Nice { get; internal set; } /// - /// Time waiting for I/O completion (Percent) + /// Time waiting for I/O completion (Percent). /// public double IoWait { get; internal set; } } /// - /// Structure for CPU usage per processes + /// The structure for CPU usage per process. /// public class ProcessCpuUsage { @@ -66,11 +66,11 @@ namespace Tizen.System STime = usage.STime; } /// - /// Amount of time that this process has been scheduled in user mode (clock ticks) + /// The amount of time this process has been scheduled in user mode (clock ticks). /// public uint UTime { get; internal set; } /// - /// Amount of time that this process has been scheduled in kernel mode (clock ticks) + /// The amount of time this process has been scheduled in kernel mode (clock ticks). /// public uint STime { get; internal set; } } diff --git a/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs b/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs index c35afeb..8b2fcf0 100755 --- a/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs +++ b/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System { /// - /// Enumeration for keys for runtime information + /// Enumeration for the runtime information key. /// public enum RuntimeInformationKey { @@ -41,7 +41,7 @@ namespace Tizen.System /// UsbTethering = 5, /// - /// Indicates Whether the packet data through 3G network is enabled. + /// Indicates whether packet data through 3G network is enabled. /// PacketData = 9, /// @@ -62,7 +62,7 @@ namespace Tizen.System /// Gps = 18, /// - /// Indicates the battery is currently charging. + /// Indicates whether the battery is currently charging. /// BatteryIsCharging = 19, /// @@ -70,12 +70,12 @@ namespace Tizen.System /// TvOut = 20, /// - /// Indicates the change in audio jack connector type. + /// Indicates change in the audio jack connector type. /// /// AudioJackConnector = 21, /// - /// Indicates whether charger is connected. + /// Indicates whether the charger is connected. /// Charger = 24, /// @@ -85,58 +85,58 @@ namespace Tizen.System } /// - /// Enumeration for Wi-Fi status + /// Enumeration for the Wi-Fi status. /// public enum WifiStatus { /// - /// Wi-Fi is disabled. + /// The Wi-Fi is disabled. /// Disabled, /// - /// Wi-Fi is enabled and network connection is not established. + /// The Wi-Fi is enabled and the network connection is not established. /// Unconnected, /// - /// Network connection is established in Wi-Fi network. + /// The network connection is established in a Wi-Fi network. /// Connected } /// - /// Enumeration for GPS status. + /// Enumeration for the GPS status. /// public enum GpsStatus { /// - /// GPS is disabled. + /// The GPS is disabled. /// Disabled, /// - /// GPS is searching for satellites. + /// The GPS is searching for satellites. /// Searching, /// - /// GPS connection is established. + /// The GPS connection is established. /// Connected } /// - /// Enumeration for type of audio jack connected. + /// Enumeration for the type of audio jack connected. /// public enum AudioJackConnectionType { /// - /// Audio jack is not connected + /// The audio jack is not connected. /// Unconnected, /// - /// 3-conductor wire is connected. + /// The 3-conductor wire is connected. /// ThreeWireConnected, /// - /// 4-conductor wire is connected. + /// The 4-conductor wire is connected. /// FourWireConnected } diff --git a/src/Tizen.System.Information/RuntimeInfo/MemoryInformation.cs b/src/Tizen.System.Information/RuntimeInfo/MemoryInformation.cs index 64d6713..fa38d06 100755 --- a/src/Tizen.System.Information/RuntimeInfo/MemoryInformation.cs +++ b/src/Tizen.System.Information/RuntimeInfo/MemoryInformation.cs @@ -38,29 +38,29 @@ namespace Tizen.System Swap = info.Swap; } /// - /// Total memory (KiB) + /// Total memory (KiB). /// public int Total { get; internal set; } /// - /// Used memory (KiB) + /// Used memory (KiB). /// public int Used { get; internal set; } /// - /// Free memory (KiB) + /// Free memory (KiB). /// public int Free { get; internal set; } /// - /// Cache memory (KiB) + /// Cache memory (KiB). /// public int Cache { get; internal set; } /// - /// Swap memory (KiB) + /// Swap memory (KiB). /// public int Swap { get; internal set; } } /// - /// Memory information per processes + /// Memory information per process. /// public class ProcessMemoryInformation { @@ -76,31 +76,31 @@ namespace Tizen.System Vsz = info.Vsz; } /// - /// Virtual memory size (KiB) + /// Virtual memory size (KiB). /// public int Vsz { get; internal set; } /// - /// Resident set size (KiB) + /// Resident set size (KiB). /// public int Rss { get; internal set; } /// - /// Proportional set size (KiB) + /// Proportional set size (KiB). /// public int Pss { get; internal set; } /// - /// Not modified and mapped by other processes (KiB) + /// Not modified and mapped by other processes (KiB). /// public int SharedClean { get; internal set; } /// - /// Modified and mapped by other processes (KiB) + /// Modified and mapped by other processes (KiB). /// public int SharedDirty { get; internal set; } /// - /// Not modified and available only to that process (KiB) + /// Not modified and available only to that process (KiB). /// public int PrivateClean { get; internal set; } /// - /// Modified and available only to that process (KiB) + /// Modified and available only to that process (KiB). /// public int PrivateDirty { get; internal set; } } diff --git a/src/Tizen.System.Information/RuntimeInfo/RuntimeInfoErrorFactory.cs b/src/Tizen.System.Information/RuntimeInfo/RuntimeInfoErrorFactory.cs old mode 100755 new mode 100644 diff --git a/src/Tizen.System.Information/RuntimeInfo/RuntimeInformation.cs b/src/Tizen.System.Information/RuntimeInfo/RuntimeInformation.cs index 8477462..7611d0f 100755 --- a/src/Tizen.System.Information/RuntimeInfo/RuntimeInformation.cs +++ b/src/Tizen.System.Information/RuntimeInfo/RuntimeInformation.cs @@ -25,7 +25,7 @@ using System.ComponentModel; namespace Tizen.System { /// - /// The RuntimeInformation provides functions to obtain runtime information of various system preferences. + /// The RuntimeInformation provides functions to obtain the runtime information of various system preferences. /// public static class RuntimeInformation { @@ -166,7 +166,7 @@ namespace Tizen.System internal static int is_TV_product = -1; [EditorBrowsable(EditorBrowsableState.Never)] - /// This function is for TV product. It will be removed + /// This function is for a TV product. It will be removed. internal static RuntimeInformationKey ConvertKeyIfTvProduct(RuntimeInformationKey key) { bool is_key_existed = false; @@ -236,13 +236,13 @@ namespace Tizen.System } /// - /// Validates the data type of the status represented by Runtime Key. + /// Validates the data type of the status represented by the runtime key. /// Note that this is a generic method. /// - /// 3 + /// 3 /// The generic type to validate. - /// The runtime information key for which the status type is validated - /// true if the data type matches. + /// The runtime information key for which the status type is validated. + /// True if the data type matches. /// Thrown when the is invalid. public static bool Is(RuntimeInformationKey key) { @@ -256,15 +256,15 @@ namespace Tizen.System } /// - /// Gets the status of Runtime Key. + /// Gets the status of runtime key. /// Note that this is a generic method. /// - /// 3 + /// 3 /// The generic type to return. - /// The runtime information key for which the current should be read - /// The current status of the given key. + /// The runtime information key for which the current should be read. + /// The current status of the given key.. /// Thrown when the is invalid. - /// Thrown when I/O error is occurred while reading from system. + /// Thrown when I/O error occurs while reading from the system. /// Thrown when the feature related is not supported. public static T GetStatus(RuntimeInformationKey key) { @@ -272,11 +272,11 @@ namespace Tizen.System } /// - /// Gets system memory information + /// Gets the system memory information. /// - /// 3 + /// 3 /// The system memory information structure. - /// Thrown when I/O error is occurred while reading from system. + /// Thrown when I/O error occurs while reading from the system. public static SystemMemoryInformation GetSystemMemoryInformation() { Interop.RuntimeInfo.MemoryInfo info = new Interop.RuntimeInfo.MemoryInfo(); @@ -291,16 +291,16 @@ namespace Tizen.System } /// - /// Gets memory information per processes + /// Gets the memory information per process. /// - /// 3 - /// List of unique process ids - /// List of memory information per processes + /// 3 + /// List of unique process ids. + /// List of memory information per process. /// http://tizen.org/privilege/systemmonitor /// Thrown when the is empty. - /// Thrown when I/O error is occurred while reading from system or requesting to resource management daemon. + /// Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. /// Thrown when the memory is not enough to allocate. - /// Thrown when caller doesn't have a privilege to use this method. + /// Thrown when the caller does not have privilege to use this method. public static IDictionary GetProcessMemoryInformation(IEnumerable pid) { int[] processArray = pid.ToArray(); @@ -325,11 +325,11 @@ namespace Tizen.System } /// - /// Gets system CPU usage time + /// Gets the system CPU usage time. /// - /// 3 + /// 3 /// The system CPU usage time structure. - /// Thrown when I/O error is occurred while reading from system. + /// Thrown when an I/O error occurs while reading from the system. public static CpuUsage GetCpuUsage() { Interop.RuntimeInfo.CpuUsage usage = new Interop.RuntimeInfo.CpuUsage(); @@ -343,16 +343,16 @@ namespace Tizen.System } /// - /// Gets the CPU usage time per process + /// Gets the CPU usage time per process. /// - /// 3 - /// List of unique process ids - /// List of CPU usage information per processes + /// 3 + /// List of unique process ids. + /// List of CPU usage information per process. /// http://tizen.org/privilege/systemmonitor /// Thrown when the is empty. - /// Thrown when I/O error is occurred while reading from system or requesting to resource management daemon. + /// Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. /// Thrown when the memory is not enough to allocate. - /// Thrown when caller doesn't have a privilege to use this method. + /// Thrown when the caller does not have privilege to use this method. public static IDictionary GetProcessCpuUsage(IEnumerable pid) { int[] processArray = pid.ToArray(); @@ -377,10 +377,10 @@ namespace Tizen.System } /// - /// Gets the number of processors + /// Gets the number of processors. /// - /// The number of processors - /// Thrown when I/O error is occurred while reading from system. + /// The number of processors. + /// Thrown when an I/O error occurs while reading from system. public static int ProcessorCount { get @@ -398,14 +398,14 @@ namespace Tizen.System } /// - /// Gets the current frequency of processor + /// Gets the current frequency of the processor. /// - /// 3 - /// The index (from 0) of CPU core that you want to know the frequency - /// The current frequency(MHz) of processor + /// 3 + /// The index (from 0) of the CPU core that you want to know the frequency of. + /// The current frequency(MHz) of processor. /// Thrown when the is invalid. - /// Thrown when I/O error is occurred while reading from system. - /// Thrown when this system doesn't store CPU current frequency. + /// Thrown when an I/O error occurs while reading from system. + /// Thrown when this system does not store the current CPU frequency. public static int GetProcessorCurrentFrequency(int coreId) { int frequency; @@ -419,14 +419,14 @@ namespace Tizen.System } /// - /// Gets the max frequency of processor + /// Gets the max frequency of the processor. /// - /// 3 - /// The index (from 0) of CPU core that you want to know the frequency - /// The max frequency(MHz) of processor + /// 3 + /// The index (from 0) of CPU core that you want to know the frequency of. + /// The max frequency(MHz) of processor. /// Thrown when the is invalid. - /// Thrown when I/O error is occurred while reading from system. - /// Thrown when this system doesn't store CPU max frequency. + /// Thrown when an I/O error occurs while reading from system. + /// Thrown when this system does not store the max CPU frequency. public static int GetProcessorMaxFrequency(int coreId) { int frequency; @@ -440,7 +440,7 @@ namespace Tizen.System } /// - /// (event) BluetoothEnabled is raised when system preference for bluetooth is changed. + /// (event) BluetoothEnabled is raised when the system preference for Bluetooth is changed. /// public static event EventHandler BluetoothEnabled { @@ -472,7 +472,7 @@ namespace Tizen.System } } /// - /// (event) WifiHotspotEnabled is raised when system preference for Wi-Fi is changed. + /// (event) WifiHotspotEnabled is raised when the system preference for Wi-Fi is changed. /// public static event EventHandler WifiHotspotEnabled { @@ -504,7 +504,7 @@ namespace Tizen.System } } /// - /// (event) BluetoothTetheringEnabled is raised when system preference for bluetooth tethering is changed. + /// (event) BluetoothTetheringEnabled is raised when the system preference for bluetooth tethering is changed. /// public static event EventHandler BluetoothTetheringEnabled { @@ -536,7 +536,7 @@ namespace Tizen.System } } /// - /// (event) UsbTetheringEnabled is raised when system preference for USB tethering is changed. + /// (event) UsbTetheringEnabled is raised when the system preference for USB tethering is changed. /// public static event EventHandler UsbTetheringEnabled { @@ -568,7 +568,7 @@ namespace Tizen.System } } /// - /// (event) PacketDataEnabled is raised when system preference for package data through 3G network is changed. + /// (event) PacketDataEnabled is raised when the system preference for package data through 3G network is changed. /// public static event EventHandler PacketDataEnabled { @@ -600,7 +600,7 @@ namespace Tizen.System } } /// - /// (event) DataRoamingEnabled is raised when system preference for data roaming is changed. + /// (event) DataRoamingEnabled is raised when the system preference for data roaming is changed. /// public static event EventHandler DataRoamingEnabled { @@ -632,7 +632,7 @@ namespace Tizen.System } } /// - /// (event) VibrationEnabled is raised when system preference for vibration is changed. + /// (event) VibrationEnabled is raised when the system preference for vibration is changed. /// public static event EventHandler VibrationEnabled { @@ -664,7 +664,7 @@ namespace Tizen.System } } /// - /// (event) AudioJackConnected is raised when audio jack is connected/disconnected. + /// (event) AudioJackConnected is raised when the audio jack is connected/disconnected. /// public static event EventHandler AudioJackConnected { @@ -696,7 +696,7 @@ namespace Tizen.System } } /// - /// (event) GpsStatusChanged is raised when status of GPS is changed. + /// (event) GpsStatusChanged is raised when the status of GPS is changed. /// public static event EventHandler GpsStatusChanged { @@ -728,7 +728,7 @@ namespace Tizen.System } } /// - /// (event) BatteryIsCharging is raised battery is currently charging. + /// (event) BatteryIsCharging is raised when the battery is currently charging. /// public static event EventHandler BatteryIsCharging { @@ -792,7 +792,7 @@ namespace Tizen.System } } /// - /// (event) AudioJackConnectorChanged is raised when audio jack connection changes. + /// (event) AudioJackConnectorChanged is raised when the audio jack connection changes. /// public static event EventHandler AudioJackConnectorChanged { @@ -824,7 +824,7 @@ namespace Tizen.System } } /// - /// (event) ChargerConnected is raised when charger is connected/disconnected. + /// (event) ChargerConnected is raised when the charger is connected/disconnected. /// public static event EventHandler ChargerConnected { @@ -856,7 +856,7 @@ namespace Tizen.System } } /// - /// (event) AutoRotationEnabled is raised when system preference for auto rotation is changed. + /// (event) AutoRotationEnabled is raised when the system preference for auto rotation is changed. /// public static event EventHandler AutoRotationEnabled { diff --git a/src/Tizen.System.Information/RuntimeInfo/RuntimeKeyStatusChangedEventArgs.cs b/src/Tizen.System.Information/RuntimeInfo/RuntimeKeyStatusChangedEventArgs.cs index 0e1c3aa..c145c93 100755 --- a/src/Tizen.System.Information/RuntimeInfo/RuntimeKeyStatusChangedEventArgs.cs +++ b/src/Tizen.System.Information/RuntimeInfo/RuntimeKeyStatusChangedEventArgs.cs @@ -23,7 +23,7 @@ using System.Threading.Tasks; namespace Tizen.System { /// - /// RuntimeInfoChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners + /// RuntimeInfoChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners. /// public class RuntimeKeyStatusChangedEventArgs : EventArgs { diff --git a/src/Tizen.System.Information/SystemInfo/SystemInfo.cs b/src/Tizen.System.Information/SystemInfo/SystemInfo.cs index 61dbef9..b551c1b 100755 --- a/src/Tizen.System.Information/SystemInfo/SystemInfo.cs +++ b/src/Tizen.System.Information/SystemInfo/SystemInfo.cs @@ -20,7 +20,7 @@ using System.ComponentModel; namespace Tizen.System { /// - /// System Information class. This class has methods which can be used to obtain device information + /// System Information class. This class has methods which can be used to obtain device information. /// public static class SystemInfo { @@ -47,12 +47,12 @@ namespace Tizen.System } /// - /// Checks if type of value for given feature is T + /// Checks if the type of value for the given feature is T. /// - /// 3 - /// Type of value for feature key - /// The name of the feature - /// true if type of value for given feature is T, false otherwise + /// 3 + /// Type of value for the feature key. + /// The name of the feature. + /// True if type of value for the given feature is T, otherwise false. public static bool Is(string key) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -77,11 +77,11 @@ namespace Tizen.System } /// - /// Checks if given key is valid feature + /// Checks if the given key is a valid feature. /// - /// 3 - /// The name of the feature - /// true of key is valid, false otherwise + /// 3 + /// The name of the feature. + /// True if the key is valid, otherwise false. public static bool IsValidKey(string key) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -91,11 +91,11 @@ namespace Tizen.System /// /// Gets the value of the feature. /// - /// 3 - /// Type of key value - /// The name of the feature - /// The value of the given feature - /// return true on success otherwise false + /// 3 + /// Type of key value. + /// The name of the feature. + /// The value of the given feature. + /// Returns true on success, otherwise false. public static bool TryGetValue(string key, out T value) { bool res = false; @@ -133,10 +133,10 @@ namespace Tizen.System /// /// Gets the bool value of the feature. /// - /// 3 - /// The name of the feature - /// The value of the given feature - /// return true on success otherwise false + /// 3 + /// The name of the feature. + /// The value of the given feature. + /// Returns true on success, otherwise false. public static bool TryGetValue(string key, out bool value) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -167,10 +167,10 @@ namespace Tizen.System /// /// Gets the int value of the feature. /// - /// 3 - /// The name of the feature - /// The value of the given feature - /// return true on success otherwise false + /// 3 + /// The name of the feature. + /// The value of the given feature. + /// Returns true on success, otherwise false. public static bool TryGetValue(string key, out int value) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -202,10 +202,10 @@ namespace Tizen.System /// /// Gets the double value of the feature. /// - /// 3 - /// The name of the feature - /// The value of the given feature - /// return true on success otherwise false + /// 3 + /// The name of the feature. + /// The value of the given feature. + /// Returns true on success, otherwise false. public static bool TryGetValue(string key, out double value) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -237,10 +237,10 @@ namespace Tizen.System /// /// Gets the string value of the feature. /// - /// 3 - /// The name of the feature - /// The value of the given feature - /// return true on success otherwise false + /// 3 + /// The name of the feature. + /// The value of the given feature. + /// Returns true on success, otherwise false. public static bool TryGetValue(string key, out string value) { Interop.SystemInfo.SystemInfoValueType valueType; -- 2.7.4