From 536dc38bba6ab9a6b002d7b6630512d3f28836d8 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Tue, 1 Aug 2017 20:27:01 +0530 Subject: [PATCH] Review system API cs files PS1: Edited files as per comments Change-Id: I9db3100b911950632ae1a46360e870a38a165467 --- src/Tizen.System/Device/Battery.cs | 30 ++++++++-------- src/Tizen.System/Device/DeviceEventArgs.cs | 18 +++++----- src/Tizen.System/Device/Display.cs | 36 +++++++++---------- src/Tizen.System/Device/Haptic.cs | 36 +++++++++---------- src/Tizen.System/Device/IR.cs | 22 ++++++------ src/Tizen.System/Device/Led.cs | 58 +++++++++++++++--------------- src/Tizen.System/Device/Power.cs | 16 ++++----- 7 files changed, 108 insertions(+), 108 deletions(-) diff --git a/src/Tizen.System/Device/Battery.cs b/src/Tizen.System/Device/Battery.cs index e622284..27d5d5d 100755 --- a/src/Tizen.System/Device/Battery.cs +++ b/src/Tizen.System/Device/Battery.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.System { /// - /// Enumeration for the Battery level. + /// Enumeration for the battery levels. /// /// 3 public enum BatteryLevelStatus @@ -34,9 +34,9 @@ namespace Tizen.System Empty = 0, /// /// The battery charge is at a critical state. - /// You may have to stop using multimedia features, + /// You may have to stop using the multimedia features, /// because they are not guaranteed to work correctly - /// at this battery status. + /// with this battery status. /// /// 3 Critical, @@ -58,13 +58,13 @@ namespace Tizen.System } /// - /// The Battery class provides the Properties and Events for device battery. + /// The Battery class provides the properties and events for the device battery. /// /// /// The Battery API provides the way to get the current battery capacity value (Percent), - /// battery state and charging state. It also provides Events for an application + /// the battery state, and the charging state. It also provides the events for an application /// to receive the battery status change events from the device. - /// To receive the battery event, application should register with respective EventHandler. + /// To receive the battery event, the application should register with the respective EventHandler. /// /// /// Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging); @@ -77,7 +77,7 @@ namespace Tizen.System /// Gets the battery charge percentage. /// /// 3 - /// It returns an integer value from 0 to 100 that indicates remaining + /// It returns an integer value from 0 to 100 that indicates the remaining /// battery charge as a percentage of the maximum level. public static int Percent { @@ -93,7 +93,7 @@ namespace Tizen.System } } /// - /// Gets the current Battery level. + /// Gets the current battery level. /// /// 3 public static BatteryLevelStatus Level @@ -129,11 +129,11 @@ namespace Tizen.System private static EventHandler s_capacityChanged; /// - /// CapacityChanged is triggered when the battery charge percentage is changed + /// CapacityChanged is triggered when the battery charge percentage is changed. /// /// 3 /// - /// A BatteryCapacityChangedEventArgs object that contains changed battery capacity (Percent) + /// BatteryCapacityChangedEventArgs is an object that contains the changed battery capacity (Percent). /// /// public static async Task BatteryEventHandler() /// { @@ -175,11 +175,11 @@ namespace Tizen.System private static event EventHandler s_levelChanged; /// - /// LevelChanged is triggered when the battery level is changed + /// LevelChanged is triggered when the battery level is changed. /// /// 3 /// - /// A BatteryLevelChangedEventArgs object that contains changed battery level + /// BatteryLevelChangedEventArgs is an object that contains the changed battery level. /// /// public static async Task BatteryEventHandler() /// { @@ -220,12 +220,12 @@ namespace Tizen.System private static event EventHandler s_chargingStateChanged; /// - /// ChargingStatusChanged is triggered when the Battery charging status is changed. - /// This event is triggered when Charger is connected/Disconnected. + /// ChargingStatusChanged is triggered when the battery charging status is changed. + /// This event is triggered when the charger is connected/disconnected. /// /// 3 /// - /// A BatteryChargingStateChangedEventArgs object that contains changed battery charging state + /// BatteryChargingStateChangedEventArgs is an object that contains the changed battery charging state. /// /// public static async Task BatteryEventHandler() /// { diff --git a/src/Tizen.System/Device/DeviceEventArgs.cs b/src/Tizen.System/Device/DeviceEventArgs.cs index 829e8de..53a75bb 100644 --- a/src/Tizen.System/Device/DeviceEventArgs.cs +++ b/src/Tizen.System/Device/DeviceEventArgs.cs @@ -19,60 +19,60 @@ using System; namespace Tizen.System { /// - /// BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for BatteryPercentChanged event from Battery class. + /// BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class. /// public class BatteryPercentChangedEventArgs : EventArgs { internal BatteryPercentChangedEventArgs(){} /// /// The current capacity of the battery. - /// Capacity is an integer value from 0 to 100, that indicates remaining battery charge as a percentage of the maximum level. + /// Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level. /// /// 3 public int Percent { get; internal set; } } /// - /// BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for BatteryLevelChanged event from Battery class. + /// BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class. /// public class BatteryLevelChangedEventArgs : EventArgs { internal BatteryLevelChangedEventArgs(){} /// - /// Level indicates the Current battery level status which is of type BatteryLevelStatus. + /// The level indicates the current battery level status which is a type of the BatteryLevelStatus. /// /// 3 public BatteryLevelStatus Level { get; internal set; } } /// - /// BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for BatteryChargingStateChanged event from Battery class. + /// BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class. /// public class BatteryChargingStateChangedEventArgs : EventArgs { internal BatteryChargingStateChangedEventArgs() {} /// - /// The charging state of the battery. Charging is of type boolean which indicates true/false based on currrent charging status. + /// The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status. /// /// 3 public bool IsCharging { get; internal set; } } /// - /// DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for DisplayStateChanged event from Display class. + /// DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class. /// public class DisplayStateChangedEventArgs : EventArgs { internal DisplayStateChangedEventArgs() {} /// - /// State indicates the current display state of the device which is an enum of type DisplayState. + /// The state indicates the current display state of the device which is an enumeration of the type DisplayState. /// /// 3 public DisplayState State { get; internal set; } } /// - /// LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for LedBrightnessChanged event from Led class. + /// LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class. /// public class LedBrightnessChangedEventArgs : EventArgs { diff --git a/src/Tizen.System/Device/Display.cs b/src/Tizen.System/Device/Display.cs index 4588001..4ee57c0 100644 --- a/src/Tizen.System/Device/Display.cs +++ b/src/Tizen.System/Device/Display.cs @@ -19,37 +19,37 @@ using System.Collections.Generic; namespace Tizen.System { /// - /// Enumeration for the available Display states. + /// Enumeration for the available display states. /// An application cannot put the device into the power off state or the suspend state. /// /// 3 public enum DisplayState { /// - /// Normal state + /// Normal state. /// /// 3 Normal = 0, /// - /// Screen dim state + /// Screen dim state. /// /// 3 Dim, /// - /// Screen off state + /// Screen off state. /// /// 3 Off } /// - /// The Display class provides Properties and Events to control the display status and brightness. + /// The Display class provides the properties and events to control the display status and brightness. /// /// - /// The Display API provides the way to get the current Display brightness value, - /// display state and toal number of available displayes. - /// It also provides Events for an application to receive the Display state change events from the device. - /// To receive the Display event, application should register with assocated EventHandler. + /// The Display API provides the way to get the current display brightness value, + /// the display state, and the total number of available displays. + /// It also provides the events for an application to receive the display state change events from the device. + /// To receive the display event, the application should register with an associated EventHandler. /// /// /// http://tizen.org/privilege/display @@ -86,8 +86,8 @@ namespace Tizen.System } } /// - /// Get all the avaialble Displays. - /// The Display at index zero is always assigned to the main display. + /// Gets all the available displays. + /// The display at the index zero is always assigned to the main display. /// /// 3 public static IReadOnlyList Displays @@ -112,7 +112,7 @@ namespace Tizen.System } /// - /// The maximum brightness value that can be set for the specific Display. + /// The maximum brightness value that can be set for the specific display. /// /// 3 /// @@ -134,14 +134,14 @@ namespace Tizen.System } /// - /// The display brightness valu of the Display. + /// The brightness value of the display. /// /// - /// Brightness value should be less than are equal to MaxBrightness value. + /// The brightness value should be less than or equal to the MaxBrightness value. /// /// 3 - /// When the invalid parameter value is set. - /// If the privilege is not set. + /// When an invalid parameter value is set. + /// If the privilege is not set. /// /// Display display = Display.Displays[0]; /// Console.WriteLine("Display current Brightness is: {0}", display.Brightness); @@ -188,11 +188,11 @@ namespace Tizen.System private static event EventHandler s_stateChanged; /// - /// StateChanged is raised when the state of the display is changed + /// StateChanged is raised when the state of the display is changed. /// /// 3 /// - /// An DisplayStateChangedEventArgs object that contains the changed state + /// DisplayStateChangedEventArgs is an object that contains the changed state. /// /// public static async Task DisplayEventHandler() /// { diff --git a/src/Tizen.System/Device/Haptic.cs b/src/Tizen.System/Device/Haptic.cs index b451f33..c8543e6 100644 --- a/src/Tizen.System/Device/Haptic.cs +++ b/src/Tizen.System/Device/Haptic.cs @@ -19,12 +19,12 @@ using System.Collections.Generic; namespace Tizen.System { /// - /// The Vibrator class provides properties and methods to control a vibrator. + /// The Vibrator class provides the properties and methods to control a vibrator. /// /// - /// The Vibrator API provides the way to access the Vibrators in the device. + /// The Vibrator API provides the way to access the vibrators in the device. /// It allows the management of the device's vibrator parameters, such as the vibration count and level. - /// It provides methods to Vibrate and Stop the vibration. + /// It provides the methods to vibrate and stop the vibration. /// /// /// http://tizen.org/privilege/haptic @@ -60,7 +60,7 @@ namespace Tizen.System Dispose(false); } /// - /// Get the number of avaialble vibrators. + /// Gets the number of the available vibrators. /// /// 3 public static int NumberOfVibrators @@ -77,7 +77,7 @@ namespace Tizen.System } } /// - /// Get all the avaialble vibrators. + /// Gets all the available vibrators. /// /// 3 public static IReadOnlyList Vibrators @@ -109,12 +109,12 @@ namespace Tizen.System /// This function can be used to start monotonous vibration for the specified time. /// /// 3 - /// The play duration in milliseconds - /// The amount of the intensity variation (0 ~ 100) - /// When the invalid parameter value is set. - /// If the privilege is not set. - /// In case of any system error. - /// In case of device does not support this behavior. + /// The play duration in milliseconds. + /// The amount of the intensity variation (0 ~ 100). + /// When an invalid parameter value is set. + /// If the privilege is not set. + /// In case of any system error. + /// In case the device does not support this behavior. /// /// Vibrator vibrator = Vibrator.Vibrators[0]; /// try @@ -146,14 +146,14 @@ namespace Tizen.System } } /// - /// Stops all vibration effects which are being played. - /// This function can be used to stop all effects started by Vibrate(). + /// Stops all the vibration effects which are being played. + /// This function can be used to stop all the effects started by Vibrate(). /// /// 3 - /// In case of invalid vibrator instance is used. - /// If the privilege is not set. - /// In case of any system error. - /// In case of device does not support this behavior. + /// In case an invalid vibrator instance is used. + /// If the privilege is not set. + /// In case of any system error. + /// In case the device does not support this behavior. /// /// Vibrator vibrator = Vibrator.Vibrators[0]; /// try @@ -177,7 +177,7 @@ namespace Tizen.System } /// /// Dispose API for closing the internal resources. - /// This function can be used to stop all effects started by Vibrate(). + /// This function can be used to stop all the effects started by Vibrate(). /// /// 3 public void Dispose() diff --git a/src/Tizen.System/Device/IR.cs b/src/Tizen.System/Device/IR.cs index c2631bf..5a41b09 100644 --- a/src/Tizen.System/Device/IR.cs +++ b/src/Tizen.System/Device/IR.cs @@ -21,19 +21,19 @@ using System.Linq; namespace Tizen.System { /// - /// The IR API provides functions to control a IR transmitter. - /// The IR API provides the way to get the information whether IR is available and transmit IR command. + /// The IR API provides the functions to control the IR transmitter. + /// The IR API provides the way to get the information if IR is available and then transmit the IR command. /// /// /// http://tizen.org/privilege/use_ir /// /// - /// Console.WriteLine("IR availablity for this device is: {0}", IR.IsAvailable); + /// Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable); /// public static class IR { /// - /// Gets the information whether IR module is available. + /// Gets the information whether the IR module is available. /// /// 3 public static bool IsAvailable @@ -51,19 +51,19 @@ namespace Tizen.System } /// - /// Transmits IR command. + /// Transmits the IR command. /// /// 3 /// - /// Carrier frequency to transmit IR command (Hertz). + /// The carrier frequency to transmit the IR command (Hertz). /// /// - /// IR command list of type interger. + /// The IR command list of type integer. /// - /// When the invalid parameter value is set. - /// If the privilege is not set. - /// In case of any system error. - /// In case of device does not support this behavior. + /// When an invalid parameter value is set. + /// If the privilege is not set. + /// In case of any system error. + /// In case the device does not support this behavior. /// /// try /// { diff --git a/src/Tizen.System/Device/Led.cs b/src/Tizen.System/Device/Led.cs index fbf2fa1..e61118d 100644 --- a/src/Tizen.System/Device/Led.cs +++ b/src/Tizen.System/Device/Led.cs @@ -21,15 +21,15 @@ using Tizen.Common; namespace Tizen.System { /// - /// The Led class provides properties and methods to control the attached led device. + /// The LED class provides the properties and methods to control the attached LED device. /// /// - /// The Led API provides the way to control the attached LED device such as the camera flash and service LED.It supports to turn on the camera flash and set the pattern to the service LED which is located to the front of a device. - /// Related Features + /// The LED API provides the way to control the attached LED device, such as the camera flash and service LED. It supports to turn on the camera flash and set the pattern to the service LED which is located at the front of the device. + /// Related features: /// http://tizen.org/feature/led /// http://tizen.org/feature/camera.back.flash - /// It is recommended to design feature related codes in your application for reliability. - /// You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application. + /// It is recommended to design the feature related codes in your application for reliability. + /// You can check if a device supports the related features for this API by using system information, thereby controlling the procedure of your application. /// /// /// http://tizen.org/privilege/led @@ -41,11 +41,11 @@ namespace Tizen.System public static class Led { /// - /// Gets the max brightness value of a LED that is located next to the camera. + /// Gets the maximum brightness value of the LED that is located next to the camera. /// 3 - /// When the invalid parameter value is set. - /// If the privilege is not set. - /// In case of device does not support this behavior. + /// When an invalid parameter value is set. + /// If the privilege is not set. + /// In case the device does not support this behavior. /// public static int MaxBrightness { @@ -64,15 +64,15 @@ namespace Tizen.System private static readonly object s_lock = new object(); /// - /// Gets the brightness value of a LED that is located next to the camera. + /// Gets the brightness value of the LED that is located next to the camera. /// - /// The brightness value range of LED is 0 to Tizen.System.Led.MaxBrightness value. - /// Changing the brightness value will invoke the registered EventHandler for led BrightnessChanged (If any). + /// The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value. + /// Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any). /// /// 3 - /// When the invalid parameter value is set. - /// If the privilege is not set. - /// In case of device does not support this behavior. + /// When an invalid parameter value is set. + /// If the privilege is not set. + /// In case the device does not support this behavior. /// /// Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); /// Tizen.System.Led.Brightness = 50; @@ -102,19 +102,19 @@ namespace Tizen.System } /// - /// Plays the LED that is located to the front of a device. + /// Plays the LED that is located at the front of the device. /// /// 3 - /// Turn on time in milliseconds - /// Turn off time in milliseconds + /// Turn on time in milliseconds. + /// Turn off time in milliseconds. /// /// The Color value - /// The first byte means opaque and the other 3 bytes are RGB values. + /// The first byte means opaque and the other 3 bytes are the RGB values. /// - /// When the invalid parameter value is set. - /// If the privilege is not set. - /// In case of any system error. - /// In case of device does not support this behavior. + /// When an invalid parameter value is set. + /// If the privilege is not set. + /// In case of any system error. + /// In case the device does not support this behavior. /// /// try /// { @@ -135,12 +135,12 @@ namespace Tizen.System } /// - /// Stops the LED that is located to the front of a device. + /// Stops the LED that is located at the front of the device. /// /// 3 - /// If the privilege is not set. - /// In case of any system error. - /// In case of device does not support this behavior. + /// If the privilege is not set. + /// In case of any system error. + /// In case the device does not support this behavior. /// /// try /// { @@ -165,11 +165,11 @@ namespace Tizen.System private static EventHandler s_brightnessChanged; /// - /// StateChanged is raised when the LED state is changed + /// StateChanged is raised when the LED state is changed. /// /// 3 /// The source of the event. - /// An LedBrightnessChangedEventArgs object that contains the changed brightness. + /// LedBrightnessChangedEventArgs is an object that contains the changed brightness. public static event EventHandler BrightnessChanged { add diff --git a/src/Tizen.System/Device/Power.cs b/src/Tizen.System/Device/Power.cs index 50c7dcc..bc0c589 100644 --- a/src/Tizen.System/Device/Power.cs +++ b/src/Tizen.System/Device/Power.cs @@ -23,7 +23,7 @@ namespace Tizen.System /// /// /// The Power API provides the way to control the power service. - /// It can be made to hold the specific state to avoid CPU state internally. + /// It can be made to hold the specific state to avoid the CPU state internally. /// /// /// http://tizen.org/privilege/display @@ -39,12 +39,12 @@ namespace Tizen.System /// /// 3 /// - /// The positive number in milliseconds or 0 for permanent lock - /// So you must release the permanent lock of power state with ReleaseCpuLock() if timeout_ms is zero. + /// The positive number in milliseconds or 0 for the permanent lock. + /// So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero. /// - /// When the invalid parameter value is set. - /// If the privilege is not set. - /// In case of any system error. + /// When an invalid parameter value is set. + /// If the privilege is not set. + /// In case of any system error. /// /// Tizen.System.Power.RequestCpuLock(2000); /// @@ -61,8 +61,8 @@ namespace Tizen.System /// Releases the CPU lock state. /// /// 3 - /// If the privilege is not set. - /// In case of any system error. + /// If the privilege is not set. + /// In case of any system error. /// /// Tizen.System.Power.ReleaseCpuLock(); /// -- 2.7.4