namespace Tizen.Sensor
{
/// <summary>
- /// ProximitySensor Class. Used for registering callbacks for proximity sensor and getting proximity data
+ /// The ProximitySensor class is used for registering callbacks for the proximity sensor and getting the proximity data.
/// </summary>
public sealed class ProximitySensor : Sensor
{
/// Gets the proximity state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Proximity state </value>
+ /// <value> The proximity state. </value>
public ProximitySensorState Proximity { get; private set; } = ProximitySensorState.Unknown;
/// <summary>
- /// Returns true or false based on whether proximity sensor is supported by device.
+ /// Returns true or false based on whether the proximity sensor is supported by the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
+ /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
public static bool IsSupported
{
get
/// Returns the number of proximity sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of proximity sensors </value>
+ /// <value> The count of proximity sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.proximity</feature>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.exception>
/// <param name='index'>
- /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors.
/// </param>
public ProximitySensor(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in proximity sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the proximity sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>