namespace Tizen.Sensor
{
/// <summary>
- /// UncalibratedMagnetometer Sensor Class. Used for registering callbacks for uncalibrated magnetometer and getting uncalibrated magnetometer data
+ /// The UncalibratedMagnetometer sensor class is used for registering callbacks for the uncalibrated magnetometer and getting the uncalibrated magnetometer data.
/// </summary>
public sealed class UncalibratedMagnetometer : Sensor
{
/// Gets the BiasX component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> X bias </value>
+ /// <value> The X bias. </value>
public float BiasX { get; private set; } = 0;
/// <summary>
/// Gets the BiasY component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Y bias </value>
+ /// <value> The Y bias. </value>
public float BiasY { get; private set; } = 0;
/// <summary>
/// Gets the BiasZ component of the uncalibrated magnetometer data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> Z bias </value>
+ /// <value> The Z bias. </value>
public float BiasZ { get; private set; } = 0;
/// <summary>
- /// Returns true or false based on whether uncalibrated magnetometer sensor is supported by device.
+ /// Returns true or false based on whether the uncalibrated magnetometer 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 uncalibrated magnetometer sensors available on the device.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value> The count of uncalibrated magnetometer sensors </value>
+ /// <value> The count of uncalibrated magnetometer sensors. </value>
public static int Count
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/sensor.magnetometer.uncalibrated</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 uncalibrated magnetometer sensor in case of multiple sensors
+ /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors.
/// </param>
public UncalibratedMagnetometer(uint index = 0) : base(index)
{
}
/// <summary>
- /// Event Handler for storing the callback functions for event corresponding to change in uncalibrated magnetometer sensor data.
+ /// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated magnetometer sensor data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<UncalibratedMagnetometerDataUpdatedEventArgs> DataUpdated;
/// <summary>
- /// Event handler for accuracy changed events.
+ /// An event handler for accuracy changed events.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged