diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs
index 1940a3ff776..52b9ecbdce3 100755
--- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs
+++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/BaseComponent.cs
@@ -21,11 +21,11 @@
namespace Tizen.Applications.ComponentBased.Common
{
///
- /// This is a base-component class.
- /// It provides common functions of FrameComponent and ServiceComponent.
+ /// Represents the base class for components, providing common functionalities for both FrameComponent and ServiceComponent.
///
///
- /// This class cannot be registered by ComponentBased applications.
+ /// This class cannot be registered directly by ComponentBased applications.
+ /// It serves as a base class to be inherited by other components.
///
/// 6
public abstract class BaseComponent
@@ -75,26 +75,26 @@ public abstract class BaseComponent
public event EventHandler TimeZoneChanged;
///
- /// A component instance ID.
+ /// Gets the unique instance ID of the component.
/// It will be created after OnCreate method is invoked.
///
/// 6
public string Id { get; private set; }
///
- /// A component ID
+ /// Gets the ID of the component.
///
/// 6
public string ComponentId { get; private set; }
///
- /// Parent object
+ /// Gets the parent application object to which the component belongs.
///
/// 6
public ComponentBasedApplication Parent { get; private set; }
///
- /// Finish current component
+ /// Finishes the current component.
///
/// 6
public void Finish()
@@ -128,18 +128,18 @@ internal void Bind(IntPtr handle, string compId, string instanceId, ComponentBas
}
///
- /// Overrides this method if want to handle behavior to restore the previous status.
+ /// Override this method to handle restoring the previous state of the component.
///
- /// Contents. It can be used only in the callback. To use outside, make a copy.
+ /// A bundle containing the saved state of the component. It can only be used within the callback. To use it outside, create a copy.
/// 6
public virtual void OnRestoreContents(Bundle c)
{
}
///
- /// Overrides this method if want to handle behavior to save current status.
+ /// Override this method to handle saving the current state of the component.
///
- /// Contents. It can be used only in the callback. To use outside, make a copy.
+ /// A bundle containing the current state of the component. It can only be used within the callback. To use it outside, create a copy.
/// 6
public virtual void OnSaveContent(Bundle c)
{
@@ -181,17 +181,18 @@ internal void OnTimeZoneChangedCallback(string timeZone, string timeZoneId)
}
///
- /// Sends the launch request asynchronously.
+ /// Sends a launch request asynchronously.
///
///
- /// To use group mode, you must use this function instead of SendLaunchRequestAsync().
+ /// Use this method to send a launch request with group mode enabled.
+ /// If group mode is not required, you can use SendLaunchRequestAsync() instead.
///
- /// appcontrol object
- /// The callback function to be called when the reply is delivered.
- /// A task with the result of the launch request.
+ /// The AppControl object representing the request details.
+ /// The callback function to be invoked when the reply is received.
+ /// A task representing the result of the launch request.
/// Thrown when failed because of the argument is invalid.
- /// Thrown when fail to set component information to the AppControl.
- /// Thrown when the application to run is not found.
+ /// Thrown when there is a failure in setting the component information in the AppControl.
+ /// Thrown when the target application is not found.
/// Thrown when the launch request is rejected.
/// http://tizen.org/privilege/appmanager.launch
/// 6
diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs
index 8b6cf709f15..da36a7fad81 100755
--- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs
+++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ComponentBasedApplication.cs
@@ -20,8 +20,13 @@
namespace Tizen.Applications.ComponentBased.Common
{
///
- /// The class for supporting multi-components based application model.
+ /// Represents the base class for a multi-component based application.
+ /// This class allows the creation and management of multiple application components, such as Frame, Service, and Widget components.
///
+ ///
+ /// This abstract class provides the core structure for applications that consist of multiple components.
+ /// Each component has its own lifecycle, and the framework handles these lifecycles independently.
+ ///
/// 6
public abstract class ComponentBasedApplication : Application
{
@@ -30,12 +35,24 @@ public abstract class ComponentBasedApplication : Application
private Interop.CBApplication.CBAppLifecycleCallbacks _callbacks;
///
- /// Initializes the ComponentBasedApplicationBase class.
+ /// Initializes a new instance of the class with the specified component type information.
///
- /// The component type information.
- /// The key should be a class type of FrameComponent or SubComponent subclass.
- /// The value should be a component id which is declared in tizen-manifest.xml.
- ///
+ /// A dictionary where the key is the component class type (FrameComponent, ServiceComponent or WidgetComponent subclass),
+ /// and the value is the component ID defined in the tizen-manifest.xml file.
+ ///
+ /// This constructor sets up the necessary callbacks for the application lifecycle and registers the provided components.
+ ///
+ ///
+ ///
+ /// IDictionary<Type, string> components = new Dictionary<Type, string>()
+ /// {
+ /// { typeof(MyFrameComponent), "frameComponentId" },
+ /// { typeof(MyServiceComponent), "serviceComponentId" }
+ /// };
+ /// ComponentBasedApplication app = new MyApplication(components);
+ /// app.Run(args);
+ ///
+ ///
/// 6
public ComponentBasedApplication(IDictionary typeInfo)
{
@@ -53,11 +70,19 @@ public ComponentBasedApplication(IDictionary typeInfo)
}
///
- /// Registers a component.
+ /// Registers a component with the specified type and ID.
///
- /// Class type
- /// Component ID
- /// Thrown when component type is already added or not sub-class of FrameComponent or ServiceComponent
+ /// The type of the component to register. Must be a subclass of FrameComponent, ServiceComponent, or WidgetComponent.
+ /// The ID of the component, defined in the tizen-manifest.xml file.
+ /// Thrown when the component type is already registered or not sub-class of FrameComponent, ServiceComponent or WidgetComponent.
+ ///
+ /// This method ensures that only valid component types are registered. The component ID must be unique.
+ ///
+ ///
+ ///
+ /// app.RegisterComponent(typeof(MyFrameComponent), "frameComponentId");
+ ///
+ ///
/// 6
public void RegisterComponent(Type compType, string compId)
{
@@ -98,8 +123,13 @@ public void RegisterComponent(Type compType, string compId)
///
/// Runs the application's main loop.
///
- /// Arguments from commandline.
+ /// The arguments passed from the command line.
/// Thrown when component type is already added to the component.
+ ///
+ ///
+ /// app.Run(args);
+ ///
+ ///
/// 6
public override void Run(string[] args)
{
@@ -121,7 +151,7 @@ public override void Run(string[] args)
}
///
- /// Exits the main loop of the application.
+ /// Exits the application's main loop.
///
/// 6
public override void Exit()
@@ -166,31 +196,43 @@ private void OnFinishedNative(IntPtr data)
}
///
- /// This method will be called before running main-loop
+ /// Called before the main loop starts.
///
- ///
+ /// The arguments passed from the command line.
+ ///
+ /// Override this method to handle any initialization logic before the application enters the main event loop.
+ ///
/// 6
protected virtual void OnInit(string[] args)
{
}
///
- /// This method will be called after exiting main-loop
+ /// Called after the main loop exits.
///
+ ///
+ /// Override this method to handle any cleanup logic after the application has finished running.
+ ///
/// 6
protected virtual void OnFinished()
{
}
///
- /// This method will be called to start main-loop
+ /// Called to start the main loop of the application.
///
+ ///
+ /// This is an abstract method that must be implemented by derived classes to define the behavior when the application starts.
+ ///
/// 6
protected abstract void OnRun();
///
- /// This method will be called to exit main-loop
+ /// Called to exit the main loop of the application.
///
+ ///
+ /// Override this method to handle any logic needed before the application exits.
+ ///
/// 6
protected virtual void OnExit()
{
diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs
index d3b166492dd..5a378791aa5 100644
--- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs
+++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/FrameComponent.cs
@@ -19,15 +19,19 @@
namespace Tizen.Applications.ComponentBased.Common
{
///
- /// The class for showing UI module
+ /// Represents a base class for UI components in the component-based application model.
+ /// This class provides methods for handling the lifecycle and state of UI components.
///
/// 6
public abstract class FrameComponent : BaseComponent
{
///
- /// Gets the display status of a component.
+ /// Gets the current display status of the component.
///
- /// Thrown when component type is already added to the component.
+ ///
+ /// The current of the component.
+ ///
+ /// Thrown when the display status cannot be retrieved.
/// 6
public DisplayStatus DisplayStatus
{
@@ -43,31 +47,36 @@ public DisplayStatus DisplayStatus
}
///
- /// Overrides this method to handle behavior when the component is launched.
+ /// Called when the component is launched. Override this method to implement custom launch behavior.
///
- /// True if a service component is successfully created
+ ///
+ /// true if the service component is successfully created; otherwise, false.
+ ///
/// 6
public abstract bool OnCreate();
///
- /// Overrides this method to create window. It will be called before OnCreate method.
+ /// Called to create the window for the component. Override this method to provide a custom window.
+ /// This method will be called before method.
///
- /// Window object to use
+ ///
+ /// An object that represents the created window.
+ ///
/// 6
public abstract IWindowInfo CreateWindowInfo();
///
- /// Overrides this method if want to handle behavior when the component receives the appcontrol message.
+ /// Called when the component receives an app control message. Override this method to handle app control messages.
///
- /// appcontrol object
- /// True if it was restarted
+ /// The object containing the app control data.
+ /// true if the component was restarted; otherwise, false.
/// 6
public virtual void OnStart(AppControl appControl, bool restarted)
{
}
///
- /// Overrides this method if you want to handle the behavior when the component is resumed.
+ /// Called when the component is resumed. Override this method to handle resume behavior.
///
/// 6
public virtual void OnResume()
@@ -75,7 +84,7 @@ public virtual void OnResume()
}
///
- /// Overrides this method if you want to handle the behavior when the component is paused.
+ /// Called when the component is paused. Override this method to handle pause behavior.
///
/// 6
public virtual void OnPause()
@@ -83,7 +92,7 @@ public virtual void OnPause()
}
///
- /// Overrides this method if you want to handle the behavior when the component is stopped.
+ /// Called when the component is stopped. Override this method to handle stop behavior.
///
/// 6
public virtual void OnStop()
@@ -91,7 +100,7 @@ public virtual void OnStop()
}
///
- /// Overrides this method if want to handle behavior when the component is destroyed.
+ /// Called when the component is destroyed. Override this method to handle destruction behavior.
///
/// 6
public virtual void OnDestroy()
diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs
index 6dc04f2c3b5..3d95badcdc5 100755
--- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs
+++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/ServiceComponent.cs
@@ -19,29 +19,33 @@
namespace Tizen.Applications.ComponentBased.Common
{
///
- /// The class for showing service module
+ /// Represents a base class for service components in the component-based application model.
+ /// This class provides methods for handling the lifecycle and state of service components.
///
/// 6
public abstract class ServiceComponent : BaseComponent
{
///
- /// Overrides this method to handle behavior when the component is created.
+ /// Called when the service component is created. Override this method to implement custom creation behavior.
///
- /// True if a service component is successfully created
+ ///
+ /// true if the service component is successfully created; otherwise, false.
+ ///
+ /// 6
public abstract bool OnCreate();
///
- /// Overrides this method if want to handle behavior when the component receives the start command message.
+ /// Called when the service component receives a start command message. Override this method to handle start command behavior.
///
- /// appcontrol object
- /// True if it was restarted
+ /// The object containing the app control data.
+ /// true if the component was restarted; otherwise, false.
/// 6
public virtual void OnStartCommand(AppControl appControl, bool restarted)
{
}
///
- /// Overrides this method if want to handle behavior when the component is destroyed.
+ /// Called when the service component is destroyed. Override this method to handle destruction behavior.
///
/// 6
public virtual void OnDestroy()
@@ -49,3 +53,4 @@ public virtual void OnDestroy()
}
}
}
+
diff --git a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs
index 6f69360135a..a4e83f00b2f 100644
--- a/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs
+++ b/src/Tizen.Applications.ComponentBased/Tizen.Applications.ComponentBased.Common/WidgetComponent.cs
@@ -19,41 +19,47 @@
namespace Tizen.Applications.ComponentBased.Common
{
///
- /// The class for showing UI module
+ /// Represents a base class for widget components in the component-based application model.
+ /// This class provides methods for handling the lifecycle and state of widget components.
///
/// 9
public abstract class WidgetComponent : BaseComponent
{
-
///
- /// Override this method to handle behavior when the component is launched.
+ /// Called when the widget component is created. Override this method to implement custom creation behavior.
///
- /// The width of the widget component instance
- /// The height of the widget component instance
- /// True if a service component is successfully created
+ /// The width of the widget component instance.
+ /// The height of the widget component instance.
+ ///
+ /// true if the widget component is successfully created; otherwise, false.
+ ///
/// 9
public abstract bool OnCreate(int width, int height);
///
- /// Override this method to create window. It will be called before OnCreate method.
+ /// Called to create the window for the widget. This method will be called before the method.
///
- /// The width of the widget window
- /// The height of the widget window
- /// Window object to use
+ /// The width of the widget window.
+ /// The height of the widget window.
+ ///
+ /// An object representing the window to use.
+ ///
/// 9
public abstract IWindowProxy CreateWindowInfo(int width, int height);
///
- /// Overrid this method if want to handle behavior when the component is started.
+ /// Called when the widget component is started. Override this method to handle start behavior.
///
- /// True if it was restarted
+ ///
+ /// true if the component was restarted; otherwise, false.
+ ///
/// 9
public virtual void OnStart(bool restarted)
{
}
///
- /// Override this method if you want to handle the behavior when the component is resumed.
+ /// Called when the widget component is resumed. Override this method to handle resume behavior.
///
/// 9
public virtual void OnResume()
@@ -61,7 +67,7 @@ public virtual void OnResume()
}
///
- /// Override this method if you want to handle the behavior when the component is paused.
+ /// Called when the widget component is paused. Override this method to handle pause behavior.
///
/// 9
public virtual void OnPause()
@@ -69,7 +75,7 @@ public virtual void OnPause()
}
///
- /// Override this method if you want to handle the behavior when the component is stopped.
+ /// Called when the widget component is stopped. Override this method to handle stop behavior.
///
/// 9
public virtual void OnStop()
@@ -77,9 +83,11 @@ public virtual void OnStop()
}
///
- /// Override this method if want to handle behavior when the component is destroyed.
+ /// Called when the widget component is destroyed. Override this method to handle destruction behavior.
///
- /// True if the instance is permanent
+ ///
+ /// true if the instance is permanent; otherwise, false.
+ ///
/// 9
public virtual void OnDestroy(bool permanent)
{
diff --git a/src/Tizen.Core/Tizen.Core/Channel.cs b/src/Tizen.Core/Tizen.Core/Channel.cs
index 0079e83e7e7..e1727a642cf 100644
--- a/src/Tizen.Core/Tizen.Core/Channel.cs
+++ b/src/Tizen.Core/Tizen.Core/Channel.cs
@@ -21,28 +21,39 @@ namespace Tizen.Core
///
/// The class for managing communication channels between tasks of Tizen Core.
///
+ ///
+ /// Channels are essential in inter-task communications because they provide a reliable way to exchange messages and data.
+ /// By creating a channel, you can establish a connection between two tasks that need to communicate with each other.
+ /// Once created, both tasks can send and receive messages through the channel.
+ /// It's important to note that channels have a limited capacity, so make sure to handle message overflows appropriately.
+ /// Additionally, remember to close the channel once it's no longer needed to avoid resource leaks.
+ ///
/// 12
public class Channel : IDisposable
{
private bool _disposed = false;
///
- /// Constructor for creating a new channel with a sender and a receiver.
+ /// Creates a new channel with a sender and a receiver.
///
+ ///
+ /// This constructor initializes a new channel that enables communication between a sender and a receiver.
+ /// It throws exceptions if any errors occur during initialization due to insufficient memory or invalid operations.
+ ///
/// Thrown when out of memory.
/// Thrown when failed because of an invalid operation.
///
+ /// In the following code snippet, we attempt to initialize a new channel by calling the constructor.
+ /// However, if there is not enough memory available, an OutOfMemoryException is thrown. We handle this exception by displaying a message in the console.
///
- ///
/// try
/// {
- /// var channel = new Channel();
+ /// var channel = new Channel();
/// }
/// catch (OutOfMemoryException)
/// {
- /// Console.WriteLine("Exception occurs");
+ /// Console.WriteLine("Exception occurs");
/// }
- ///
///
///
/// 12
@@ -55,7 +66,7 @@ public Channel()
}
///
- /// Finalizer of the class Channel.
+ /// Finalizes an instance of the Channel class.
///
~Channel()
{
@@ -65,12 +76,21 @@ public Channel()
///
/// Gets the channel sender instance.
///
+ ///
+ /// This property provides access to the channel sender instance that can be used to send messages through the specified channel.
+ /// It ensures that only one sender instance per channel exists in order to avoid any conflicts during message transmission.
+ ///
/// 12
public ChannelSender Sender { get; private set; }
///
- /// Gets the channel receiver instance.
+ /// Gets the channel receiver instance.
///
+ ///
+ /// This property provides access to the channel receiver instance that handles incoming messages from other applications.
+ /// By utilizing this instance, you can subscribe to specific channels and receive notifications accordingly.
+ /// It is crucial to understand the concept of channels in order to effectively utilize this feature. For more details on channels, refer to the official documentation.
+ ///
/// 12
public ChannelReceiver Receiver { get; private set; }
diff --git a/src/Tizen.Core/Tizen.Core/ChannelObject.cs b/src/Tizen.Core/Tizen.Core/ChannelObject.cs
index a721c60018b..eff18ba1fb7 100644
--- a/src/Tizen.Core/Tizen.Core/ChannelObject.cs
+++ b/src/Tizen.Core/Tizen.Core/ChannelObject.cs
@@ -24,6 +24,11 @@ namespace Tizen.Core
///
/// Represents a channel object used for inter-task communication.
///
+ ///
+ /// A channel object provides a mechanism for tasks to communicate with each other in a process. It allows sending messages between tasks without any race conditions.
+ /// To create a channel object, call the static method 'Create'. Once created, you can send and receive messages through the channel by calling the respective methods on the channel object.
+ /// When you are done using the channel object, remember to dispose it properly to avoid resource leaks.
+ ///
/// 12
public class ChannelObject : IDisposable
{
@@ -40,6 +45,10 @@ public class ChannelObject : IDisposable
/// The data object.
/// Thrown when out of memory.
/// Thrown when failed because of an invalid operation.
+ ///
+ /// This constructor creates a new channel object with the specified ID and data. It throws an OutOfMemoryException if there isn't enough memory available to allocate the object.
+ /// Additionally, it may throw an InvalidOperationException if the operation fails due to an invalid condition.
+ ///
///
///
///
@@ -68,7 +77,7 @@ internal ChannelObject(IntPtr handle)
}
///
- /// Finalizer of the class ChannelObject.
+ /// Finalizes an instance of the ChannelObject class.
///
~ChannelObject()
{
@@ -135,7 +144,8 @@ public object Data
/// Gets the name of the sender task.
///
/// 12
- public string Sender {
+ public string Sender
+ {
get
{
Interop.LibTizenCore.TizenCoreChannel.ObjectGetSenderTaskName(_handle, out IntPtr taskName);
diff --git a/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs b/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs
index 4c5fdf13eb4..64bf33459ef 100644
--- a/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs
+++ b/src/Tizen.Core/Tizen.Core/ChannelReceivedEventArgs.cs
@@ -19,7 +19,7 @@
namespace Tizen.Core
{
///
- /// Arguments for the event raised when an object has been received through a channel.
+ /// Represents the arguments for the event raised when an object has been received through a channel.
///
/// 12
public class ChannelReceivedEventArgs : System.EventArgs
diff --git a/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs b/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs
index c1c62d435be..0c6ae5c6b1b 100644
--- a/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs
+++ b/src/Tizen.Core/Tizen.Core/ChannelReceiver.cs
@@ -35,7 +35,7 @@ internal ChannelReceiver(IntPtr handle)
}
///
- /// Finalizer of the class ChannelReceiver.
+ /// Finalizes an instance of the ChannelReceiver class.
///
~ChannelReceiver()
{
@@ -43,7 +43,7 @@ internal ChannelReceiver(IntPtr handle)
}
///
- /// Occurrs whenever the channel object is received in the main loop of the task.
+ /// Occurs whenever a channel object is received in the main loop of the task.
///
///
/// The registered event handler will be invoked when the channel receiver is added to the specific task.
@@ -53,8 +53,8 @@ internal ChannelReceiver(IntPtr handle)
///
/// var channel = new Channel();
/// var receiver = channel.Receiver;
- /// receiver.Received += (s, e) => {
- /// Console.WriteLine("OnChannelObjectReceived. Message = {}", (string)e.Data);
+ /// receiver.Received += (sender, args) => {
+ /// Console.WriteLine("OnChannelObjectReceived. Message = {0}", (string)args.Data);
/// };
///
///
@@ -63,19 +63,23 @@ internal ChannelReceiver(IntPtr handle)
public event EventHandler Received;
///
- /// Receives the channel object from the sender asynchronously.
+ /// Asynchronously receives the channel object from the sender.
///
/// The received channel object.
/// Thrown when out of memory.
- /// Thrown when failed because of an invalid operation.
+ /// Thrown when failed due to an invalid operation.
///
///
///
/// var channel = new Channel();
/// var task = TizenCore.Find("Test");
/// task.Send(async () => {
- /// var channelObject = await channel.Receiver.Receive();
- /// Console.WriteLine("Message = {}", (string)channelObject.Data);
+ /// try {
+ /// var channelObject = await channel.Receiver.Receive();
+ /// Console.WriteLine("Message = {}", (string)channelObject.Data);
+ /// } catch (Exception e) {
+ /// Console.Error.WriteLine("Failed to receive message: {0}", e.ToString());
+ /// }
/// });
///
///
diff --git a/src/Tizen.Core/Tizen.Core/ChannelSender.cs b/src/Tizen.Core/Tizen.Core/ChannelSender.cs
index ae170bac46d..1156d9ec49e 100644
--- a/src/Tizen.Core/Tizen.Core/ChannelSender.cs
+++ b/src/Tizen.Core/Tizen.Core/ChannelSender.cs
@@ -19,7 +19,7 @@
namespace Tizen.Core
{
///
- /// Represents the channel sender used for inter-task communication.
+ /// Represents the channel sender used for inter-task communication. It provides methods to send messages between tasks in order to facilitate task coordination.
///
/// 12
public class ChannelSender : IDisposable
@@ -32,7 +32,7 @@ internal ChannelSender(IntPtr handle)
}
///
- /// Finalizer of the class ChannelSender.
+ /// Finalizes an instance of the ChannelSender class.
///
~ChannelSender()
{
diff --git a/src/Tizen.Core/Tizen.Core/Event.cs b/src/Tizen.Core/Tizen.Core/Event.cs
index 21755d97df4..f705845e561 100644
--- a/src/Tizen.Core/Tizen.Core/Event.cs
+++ b/src/Tizen.Core/Tizen.Core/Event.cs
@@ -19,8 +19,13 @@
namespace Tizen.Core
{
///
- /// Represents the event using for broadcasting events.
+ /// Represents the event used for broadcasting events.
///
+ ///
+ /// This class provides functionality for managing events that are broadcasted across multiple components in an application.
+ /// It enables communication between different parts of the code without resorting to direct references or global variables.
+ /// By implementing the IDisposable interface, it ensures proper resource management and prevents memory leaks.
+ ///
/// 12
#pragma warning disable CA1716
public class Event : IDisposable
@@ -33,13 +38,16 @@ public class Event : IDisposable
///
/// Constructor for creating a new event instance.
///
+ ///
+ /// This constructor initializes a new event instance. It may throw exceptions if there are any issues during initialization such as running out of memory or performing an invalid operation.
+ ///
/// Thrown when out of memory.
/// Thrown when failed because of an invalid operation.
///
+ /// Here's an example showing how to create a new event instance:
///
- ///
+ /// Create a new event instance
/// var coreEvent = new Event();
- ///
///
///
/// 12
@@ -57,7 +65,7 @@ public Event()
}
///
- /// Finalizer of the class Event.
+ /// Finalizes an instance of the Event class.
///
~Event()
{
diff --git a/src/Tizen.Core/Tizen.Core/EventObject.cs b/src/Tizen.Core/Tizen.Core/EventObject.cs
index 9012bc9094a..22d2ff5af07 100644
--- a/src/Tizen.Core/Tizen.Core/EventObject.cs
+++ b/src/Tizen.Core/Tizen.Core/EventObject.cs
@@ -70,7 +70,7 @@ internal EventObject(IntPtr handle)
}
///
- /// Finalizer of the class EventObject.
+ /// Finalizes an instance of the EventObject class.
///
~EventObject()
{
diff --git a/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs b/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs
index fb561bbd686..93d91914d81 100644
--- a/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs
+++ b/src/Tizen.Core/Tizen.Core/EventReceivedEventArgs.cs
@@ -19,7 +19,7 @@
namespace Tizen.Core
{
///
- /// Arguments for the event raised when the event data is received.
+ /// Represents the arguments passed to the event handler when the event data is received.
///
/// 12
public class EventReceivedEventArgs : System.EventArgs
diff --git a/src/Tizen.Core/Tizen.Core/Task.cs b/src/Tizen.Core/Tizen.Core/Task.cs
index 4ca4cc81dd4..a6796b368fb 100644
--- a/src/Tizen.Core/Tizen.Core/Task.cs
+++ b/src/Tizen.Core/Tizen.Core/Task.cs
@@ -43,16 +43,16 @@ public class Task : IDisposable
private static int _id = 1;
///
- /// Initializes the Task class.
+ /// Initializes the Task class with the specified ID.
///
- /// The ID of the task.
+ /// The unique identifier for the task.
/// Thrown when the is invalid or a Task with that ID already exists.
/// Thrown when out of memory.
/// Thrown when failed because of an invalid operation.
///
- /// The constructor throws an exception when the id already exists.
- /// By default, the task creates a thread. However, if the is "main", a thread is not created.
- /// The 'main' task will be operated in the main thread.
+ /// The constructor throws an exception when the ID already exists.
+ /// By default, the task creates a separate thread. However, if the is set to "main", no separate thread is created.
+ /// In such case, the 'main' task will operate on the main application thread instead.
///
///
///
@@ -87,7 +87,6 @@ internal Task(IntPtr handle)
Dispose(false);
}
-
///
/// Posts an action to be executed later.
///
@@ -283,12 +282,14 @@ public void RemoveTimer(int id)
///
/// Adds a channel receiver to a main loop of the task.
///
- /// The channel receiver instance.
+ /// The channel receiver instance that needs to be added.
/// Thrown when the argument is null.
/// Thrown when the argument is invalid.
/// Thrown when failed because of an invalid operation.
/// Thrown when out of memory.
///
+ /// In the following code snippet, we create a channel, find or spawn a task named "ReceivingTask", and then add the channel receiver to the task's main loop by calling the 'AddChannelReceiver' method.
+ ///
///
///
/// var channel = new Channel();
@@ -514,7 +515,7 @@ public void RemoveEvent(Event coreEvent)
/// Emits the event object to all registered event handlers of the task.
/// It's similar to Event.Emit(), but EmitAllEvent() sends the event object to every event handler of the task while Event.Emit() sends the event object only to the target event's event handler.
///
- /// The event object instance.
+ /// The event object instance to be sent.
/// Thrown when the argument is null.
/// Thrown when the argument is invalid.
/// Thrown when failed because of an invalid operation.
@@ -675,11 +676,13 @@ public bool Running {
///
/// Thrown when failed because of an invalid operation.
///
+ /// Here's an example that demonstrates how to create a Core Task and run its main loop:
///
- ///
+ /// // Create a Core Task named "Runner"
/// var coreTask = new TCoreTask("Runner");
- /// coreTask.Run();
///
+ /// // Start the main loop of the task
+ /// coreTask.Run();
///
///
/// 12
diff --git a/src/Tizen.Log/Tizen/Log.cs b/src/Tizen.Log/Tizen/Log.cs
index 1e1c645c1c1..eddd5ecb799 100755
--- a/src/Tizen.Log/Tizen/Log.cs
+++ b/src/Tizen.Log/Tizen/Log.cs
@@ -157,7 +157,7 @@ public class Log
{
private static char[] sep = { '\\', '/' };
///
- /// Prints a log message with the VERBOSE priority.
+ /// Prints a regular log message with the VERBOSE priority.
///
/// 3
/// The tag name of the log message.
@@ -171,7 +171,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f
}
///
- /// Prints a log message with the DEBUG priority.
+ /// Prints a regular log message with the DEBUG priority.
///
/// 3
/// The tag name of the log message.
@@ -185,7 +185,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil
}
///
- /// Prints a log message with the INFO priority.
+ /// Prints a regular log message with the INFO priority.
///
/// 3
/// The tag name of the log message.
@@ -199,7 +199,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file
}
///
- /// Prints a log message with the WARNING priority.
+ /// Prints a regular log message with the WARNING priority.
///
/// 3
/// The tag name of the log message.
@@ -213,7 +213,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file
}
///
- /// Prints a log message with the ERROR priority.
+ /// Prints a regular log message with the ERROR priority.
///
/// 3
/// The tag name of the log message.
@@ -227,7 +227,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil
}
///
- /// Prints a log message with the FATAL priority.
+ /// Prints a regular log message with the FATAL priority.
///
/// 3
/// The tag name of the log message.
@@ -248,6 +248,7 @@ static unsafe void Print(Interop.Dlog.LogPriority priority, string tag, string m
///
/// Provides methods to print log messages to the Tizen logging system.
+ /// Sends "internal" logs, which end up in a different Dlog buffer than regular logs.
///
/// 3
[EditorBrowsable(EditorBrowsableState.Never)]
@@ -255,7 +256,7 @@ public class InternalLog
{
private static char[] sep = { '\\', '/' };
///
- /// Prints a log message with the VERBOSE priority.
+ /// Prints an internal log message with the VERBOSE priority.
///
/// 3
/// The tag name of the log message.
@@ -270,7 +271,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f
}
///
- /// Prints a log message with the DEBUG priority.
+ /// Prints an internal log message with the DEBUG priority.
///
/// 3
/// The tag name of the log message.
@@ -284,7 +285,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil
}
///
- /// Prints a log message with the INFO priority.
+ /// Prints an internal log message with the INFO priority.
///
/// 3
/// The tag name of the log message.
@@ -298,7 +299,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file
}
///
- /// Prints a log message with the WARNING priority.
+ /// Prints an internal log message with the WARNING priority.
///
/// 3
/// The tag name of the log message.
@@ -312,7 +313,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file
}
///
- /// Prints a log message with the ERROR priority.
+ /// Prints an internal log message with the ERROR priority.
///
/// 3
/// The tag name of the log message.
@@ -326,7 +327,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil
}
///
- /// Prints a log message with the FATAL priority.
+ /// Prints an internal log message with the FATAL priority.
///
/// 3
/// The tag name of the log message.
@@ -347,6 +348,7 @@ static unsafe void Print(Interop.Dlog.LogID log_id, Interop.Dlog.LogPriority pri
///
/// Provides methods to print log messages to the Tizen logging system.
+ /// Sends "secure" logs, which have extra safety not to appear on release builds.
///
/// 3
[EditorBrowsable(EditorBrowsableState.Never)]
@@ -354,7 +356,7 @@ public class SecureLog
{
private static char[] sep = { '\\', '/' };
///
- /// Prints a log message with the VERBOSE priority.
+ /// Prints a secure log message with the VERBOSE priority.
///
/// 3
/// The tag name of the log message.
@@ -369,7 +371,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f
}
///
- /// Prints a log message with the DEBUG priority.
+ /// Prints a secure log message with the DEBUG priority.
///
/// 3
/// The tag name of the log message.
@@ -383,7 +385,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil
}
///
- /// Prints a log message with the INFO priority.
+ /// Prints a secure log message with the INFO priority.
///
/// 3
/// The tag name of the log message.
@@ -397,7 +399,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file
}
///
- /// Prints a log message with the WARNING priority.
+ /// Prints a secure log message with the WARNING priority.
///
/// 3
/// The tag name of the log message.
@@ -411,7 +413,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file
}
///
- /// Prints a log message with the ERROR priority.
+ /// Prints a secure log message with the ERROR priority.
///
/// 3
/// The tag name of the log message.
@@ -425,7 +427,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil
}
///
- /// Prints a log message with the FATAL priority.
+ /// Prints a secure log message with the FATAL priority.
///
/// 3
/// The tag name of the log message.
diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs
index 9946fe8caad..206bf788be7 100644
--- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs
+++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetAssembly.cs
@@ -15,6 +15,7 @@
*/
using System;
+using System.ComponentModel;
using System.IO;
using System.Reflection;
using System.Runtime.Loader;
@@ -35,16 +36,21 @@ protected override Assembly Load(AssemblyName name)
}
}
- internal class NUIGadgetAssembly
+ ///
+ /// Represents a class that provides access to the methods and properties of the NUIGadgetAssembly.
+ ///
+ /// 10
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public class NUIGadgetAssembly
{
private static readonly object _assemblyLock = new object();
private readonly string _assemblyPath;
private WeakReference _assemblyRef;
private Assembly _assembly = null;
- public NUIGadgetAssembly(string assemblyPath) { _assemblyPath = assemblyPath; }
+ internal NUIGadgetAssembly(string assemblyPath) { _assemblyPath = assemblyPath; }
- public void Load()
+ internal void Load()
{
lock (_assemblyLock)
{
@@ -65,9 +71,9 @@ public void Load()
}
}
- public bool IsLoaded { get { return _assembly != null; } }
+ internal bool IsLoaded { get { return _assembly != null; } }
- public NUIGadget CreateInstance(string className)
+ internal NUIGadget CreateInstance(string className)
{
lock (_assemblyLock)
{
@@ -75,7 +81,13 @@ public NUIGadget CreateInstance(string className)
}
}
- public void Unload()
+ ///
+ /// Property indicating whether the weak reference to the gadget assembly is still alive.
+ ///
+ /// 12
+ public bool IsAlive { get { return _assemblyRef.IsAlive; } }
+
+ internal void Unload()
{
lock (_assemblyLock)
{
diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs
index 1b965a26396..c28aaa88a19 100755
--- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs
+++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetInfo.cs
@@ -87,7 +87,11 @@ public string ResourcePath
internal Assembly Assembly { get; set; }
- internal NUIGadgetAssembly NUIGadgetAssembly { get; set; }
+ ///
+ /// Gets the assembly of the gadget.
+ ///
+ /// 12
+ public NUIGadgetAssembly NUIGadgetAssembly { get; set; }
internal static NUIGadgetInfo CreateNUIGadgetInfo(string packageId)
{
diff --git a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs
index 990780fdadb..e7e277d33df 100755
--- a/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs
+++ b/src/Tizen.NUI.Gadget/Tizen.NUI/NUIGadgetManager.cs
@@ -214,7 +214,6 @@ private static void Unload(NUIGadgetInfo info)
if (info.NUIGadgetAssembly != null && info.NUIGadgetAssembly.IsLoaded)
{
info.NUIGadgetAssembly.Unload();
- info.NUIGadgetAssembly = null;
}
}
}
@@ -242,7 +241,7 @@ private static void Load(NUIGadgetInfo info, bool useDefaultContext)
}
else
{
- if (info.NUIGadgetAssembly == null)
+ if (info.NUIGadgetAssembly == null || !info.NUIGadgetAssembly.IsLoaded)
{
Log.Warn("NUIGadgetAssembly.Load(): " + info.ResourcePath + info.ExecutableFile + " ++");
info.NUIGadgetAssembly = new NUIGadgetAssembly(info.ResourcePath + info.ExecutableFile);
diff --git a/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs
index aafc00f15f0..a0a5260c963 100644
--- a/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/BatchSensor.cs
@@ -20,8 +20,13 @@
namespace Tizen.Sensor
{
///
- /// Abstract sensor for series of sensor data
+ /// Abstract class for sensor for series of sensor data.
+ /// Inherit the class 'Sensor' which is an abstract class.
///
+ ///
+ /// A class which inherits this abstract class should provide TData as an
+ /// class that inherits BatchData class.
+ ///
/// 8
public abstract class BatchSensor : Sensor where TData : Tizen.Sensor.BatchData
{
@@ -40,15 +45,23 @@ public BatchSensor(uint index = 0) : base(index) {
public IReadOnlyList Data { get; protected set; }
///
- /// Convert general batch data to specific batch data
+ /// Convert general batch data to specific batch data type "TData".
///
/// 8
/// List of converted specific batch data
protected abstract IReadOnlyList ConvertBatchData();
///
- /// Update the internal batch data using the latest events
+ /// Update the internal batch data using the latest events.
+ /// Call updateBatchEvents() which inherited from the Sensor class to
+ /// update batch data list which is managed by the Sensor class.
+ /// Then convert the updated batch data to the specific type by using
+ /// the method "ConvertBatchData" and assign it to the Data property.
///
+ ///
+ /// To use this method, you must override the ConvertBatchData method.
+ ///
+ ///
///
/// General batch data's raw pointer
///
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs
index d60f83ce087..13b66a04eb7 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs
@@ -26,28 +26,28 @@ public sealed class Accelerometer : Sensor
{
private static string AccelerometerKey = "http://tizen.org/feature/sensor.accelerometer";
///
- /// Gets the X component of the acceleration.
+ /// Get the X component value of acceleration from the accelerometer sensor.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of acceleration from the accelerometer sensor.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of acceleration from the accelerometer sensor.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether accelerometer sensor is supported by the device.
+ /// Return true or false based on whether accelerometer sensor is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -61,7 +61,7 @@ public static bool IsSupported
}
///
- /// Returns the number of accelerometer sensors available on the device.
+ /// Return the number of accelerometer sensors available by the system.
///
/// 3
/// The count of accelerometer sensors.
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs
index a7e297d8460..9de206fa290 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs
@@ -62,7 +62,7 @@ protected enum ActivityType
};
///
- /// Gets the activity accuracy of the activity detector.
+ /// Get the activity accuracy of the activity detector sensor.
///
/// 3
/// The activity accuracy.
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs
index c1d567eb140..3e20b74a6d9 100644
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/AutoRotationSensor.cs
@@ -30,22 +30,22 @@ public sealed class AutoRotationSensor : Sensor
private event EventHandler _accuracyChanged;
///
- /// Gets the value of the rotation state.
+ /// Get the degree of the rotation state of the sensor as enum type.
///
/// 7
- /// The rotation state.
+ /// The rotation state, .
public AutoRotationState Rotation { get; private set; } = AutoRotationState.Degree_0;
///
- /// Gets the accuracy of the auto-rotation data.
+ /// Get the accuracy of the auto-rotation data as enum type.
///
/// 7
- /// Accuracy
+ /// Accuracy,
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
///
- /// Returns true or false based on whether the auto-rotation sensor is supported by the device.
+ /// Return true or false based on whether the auto-rotation sensor is supported by the system.
///
/// 7
/// true if supported; otherwise false.
@@ -87,11 +87,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the auto-rotation sensor data.
///
/// 7
-
public event EventHandler DataUpdated;
///
- /// An event handler for accuracy changed events.
+ /// An event handler for the event of accuracy change.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 7
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs
index 8cdf9406149..837ff2476e9 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs
@@ -27,14 +27,14 @@ public sealed class FaceDownGestureDetector : Sensor
private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
///
- /// Gets the state of the face down gesture.
+ /// Get the state of the face down gesture as enum type.
///
/// 3
- /// The face down state.
+ /// The face down state, .
public DetectorState FaceDown { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the face down gesture detector is supported by the device.
+ /// Return true or false based on whether the face down gesture detector is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of face down gesture detectors available on the device.
+ /// Return the number of face down gesture detectors available on the system.
///
/// 3
/// The count of face down gesture detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.gesture_recognition
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors.
+ /// Index refers to a particular face down gesture detector in case of multiple sensors.
+ /// Default value is 0.
///
public FaceDownGestureDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs
index f3e4f233b2d..8682aa92893 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs
@@ -27,29 +27,30 @@ public sealed class GravitySensor : Sensor
private const string GravitySensorKey = "http://tizen.org/feature/sensor.gravity";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the X component of the gravity.
+ /// Get the X component value of the gravity sensor as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the gravity.
+ /// Get the Y component value of the gravity sensor as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the gravity.
+ /// Get the Z component value of the gravity sensor as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the gravity sensor is supported by the device.
+ /// Return true or false based on whether the gravity sensor is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -63,7 +64,7 @@ public static bool IsSupported
}
///
- /// Returns the number of gravity sensors available on the device.
+ /// Return the number of gravity sensors available on the system.
///
/// 3
/// The count of gravity sensors.
@@ -77,7 +78,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.gravity
@@ -85,7 +86,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors.
+ /// Index refers to a particular gravity sensor in case of multiple sensors.
+ /// Default value is 0.
///
public GravitySensor (uint index = 0) : base(index)
{
@@ -101,11 +103,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the gravity sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
///
- /// An event handler for accuracy changed events.
+ /// An event handler for the event of accuracy change.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs
index 4730feb9c86..414d23e39b8 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs
@@ -27,28 +27,28 @@ public sealed class Gyroscope : Sensor
private const string GyroscopeKey = "http://tizen.org/feature/sensor.gyroscope";
///
- /// Gets the X component of the acceleration.
+ /// Get the X component value of the acceleration as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of the acceleration as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of the acceleration as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the gyroscope sensor is supported by the device.
+ /// Return true or false based on whether the gyroscope sensor is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -62,7 +62,7 @@ public static bool IsSupported
}
///
- /// Returns the number of the gyroscope sensors available on the device.
+ /// Return the number of the gyroscope sensors available on the system.
///
/// 3
/// The count of the gyroscope sensors.
@@ -76,7 +76,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.gyroscope
@@ -84,7 +84,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors.
+ /// Index refers to a particular gyroscope sensor in case of multiple sensors.
+ /// Default value is 0.
///
public Gyroscope(uint index = 0) : base(index)
{
@@ -98,9 +99,10 @@ internal override SensorType GetSensorType()
///
/// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope sensor data.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs
index 21738e26d17..5b9e5b0cda2 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs
@@ -27,42 +27,42 @@ public sealed class GyroscopeRotationVectorSensor : Sensor
private const string GyroscopeRVKey = "http://tizen.org/feature/sensor.gyroscope_rotation_vector";
///
- /// Gets the X component of the gyroscope rotation vector.
+ /// Get the X component of the gyroscope rotation vector.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the gyroscope rotation vector.
+ /// Get the Y component of the gyroscope rotation vector.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the gyroscope rotation vector.
+ /// Get the Z component of the gyroscope rotation vector.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Gets the W component of the gyroscope rotation vector.
+ /// Get the W component of the gyroscope rotation vector.
///
/// 3
/// W
public float W { get; private set; } = float.MinValue;
///
- /// Gets the accuracy of the gyroscope rotation vector data.
+ /// Get the accuracy of the gyroscope rotation vector data.
///
/// 3
/// Accuracy
public SensorDataAccuracy Accuracy { get; private set; }
///
- /// Returns true or false based on whether the gyroscope rotation vector sensor is supported by the device.
+ /// Return true or false based on whether the gyroscope rotation vector sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -76,7 +76,7 @@ public static bool IsSupported
}
///
- /// Returns the number of the gyroscope rotation vector sensors available on the device.
+ /// Return the number of the gyroscope rotation vector sensors available on the system.
///
/// 3
/// The count of accelerometer rotation vector sensors.
@@ -90,7 +90,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.gyroscope_rotation_vector
@@ -98,7 +98,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors.
+ /// Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors.
+ /// Default value is 0.
///
public GyroscopeRotationVectorSensor(uint index = 0) : base(index)
{
@@ -114,7 +115,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the gyroscope rotation vector sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs
index b26ea9c9918..e312b773296 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs
@@ -27,14 +27,14 @@ public sealed class HeartRateMonitor : Sensor
private const string HRMKey = "http://tizen.org/feature/sensor.heart_rate_monitor";
///
- /// Gets the value of the heart rate monitor.
+ /// Get the value of the heart rate monitor as int type.
///
/// 3
/// The heart rate.
public int HeartRate { get; private set; } = int.MinValue;
///
- /// Returns true or false based on whether the heart rate monitor is supported by the device.
+ /// Return true or false based on whether the heart rate monitor is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of heart rate monitors available on the device.
+ /// Return the number of heart rate monitors available on the system.
///
/// 3
/// The count of heart rate monitors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/privilege/healthinfo
@@ -73,7 +73,8 @@ public static int Count
/// Thrown when the application has no privilege to use the sensor.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors.
+ /// Index refers to a particular heart rate monitor in case of multiple sensors.
+ /// Default value is 0.
///
public HeartRateMonitor(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
index a0cb24a617c..76882b89ca7 100644
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorBatch.cs
@@ -47,14 +47,14 @@ protected override IReadOnlyList ConvertBatchData()
}
///
- /// Gets the accuracy of the HeartRateMonitorBatch data.
+ /// Get the accuracy of the HeartRateMonitorBatch data as enum type.
///
/// 8
- /// Accuracy
+ /// Accuracy, .
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
///
- /// Returns true or false based on whether the HeartRateMonitorBatch sensor is supported by the device.
+ /// Return true or false based on whether the HeartRateMonitorBatch sensor is supported by the device.
///
/// 8
/// true if supported; otherwise false.
@@ -68,7 +68,7 @@ public static bool IsSupported
}
///
- /// Returns the number of HeartRateMonitorBatch sensors available on the device.
+ /// Return the number of HeartRateMonitorBatch sensors available on the system.
///
/// 8
/// The count of HeartRateMonitorBatch sensors.
@@ -83,7 +83,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 8
/// http://tizen.org/privilege/healthinfo
@@ -94,7 +94,8 @@ public static int Count
/// Thrown when the application has no privilege to use the sensor.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular HeartRateMonitorBatch in case of multiple sensors.
+ /// Index refers to a particular HeartRateMonitorBatch in case of multiple sensors.
+ /// Default value is 0.
///
public HeartRateMonitorBatch(uint index = 0) : base(index)
{
@@ -110,11 +111,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the HeartRateMonitorBatch data.
///
/// 8
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 8
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
index ad0e6d839ec..fcf78e2f6bc 100644
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitorLEDGreenBatch.cs
@@ -47,14 +47,14 @@ protected override IReadOnlyList ConvertBatch
}
///
- /// Gets the accuracy of the auto HeartRateMonitorLEDGreenBatch data.
+ /// Get the accuracy of the auto HeartRateMonitorLEDGreenBatch data as enum type.
///
/// 8
- /// Accuracy
+ /// Accuracy, .
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
///
- /// Returns true or false based on whether the HeartRateMonitorLEDGreenBatch sensor is supported by the device.
+ /// Return true or false based on whether the HeartRateMonitorLEDGreenBatch sensor is supported by the system.
///
/// 8
/// true if supported; otherwise false.
@@ -68,7 +68,7 @@ public static bool IsSupported
}
///
- /// Returns the number of HeartRateMonitorLEDGreenBatch sensors available on the device.
+ /// Return the number of HeartRateMonitorLEDGreenBatch sensors available on the system.
///
/// 8
/// The count of HeartRateMonitorLEDGreenBatch sensors.
@@ -83,7 +83,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 8
/// http://tizen.org/privilege/healthinfo
@@ -94,7 +94,8 @@ public static int Count
/// Thrown when the application has no privilege to use the sensor.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular HeartRateMonitorLEDGreenBatch sensor in case of multiple sensors.
+ /// Index refers to a particular HeartRateMonitorLEDGreenBatch sensor in case of multiple sensors.
+ /// Default value is 0.
///
public HeartRateMonitorLEDGreenBatch(uint index = 0) : base(index)
{
@@ -110,11 +111,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the HeartRateMonitorLEDGreenBatch sensor data.
///
/// 8
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 8
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs
index b18c7bbc703..aec54085ce3 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs
@@ -27,14 +27,14 @@ public sealed class HumiditySensor : Sensor
private const string HumiditySensorKey = "http://tizen.org/feature/sensor.humidity";
///
- /// Gets the value of the humidity sensor.
+ /// Get the value of the humidity sensor as float type.
///
/// 3
/// Humidity
public float Humidity { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the humidity sensor is supported by the device.
+ /// Return true or false based on whether the humidity sensor is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of humidity sensors available on the device.
+ /// Return the number of humidity sensors available on the system.
///
/// 3
/// The count of humidity sensors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.humidity
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors.
+ /// Index refers to a particular humidity sensor in case of multiple sensors.
+ /// Default value is 0.
///
public HumiditySensor(uint index = 0) : base(index)
{
@@ -86,7 +87,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the humidity sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs
index 389c47d5e96..3cec328a815 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs
@@ -27,14 +27,14 @@ public sealed class InVehicleActivityDetector : ActivityDetector
private const string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
///
- /// Gets the state of the in-vehicle activity detector.
+ /// Get the state of the in-vehicle activity detector as enum type.
///
/// 3
- /// The in-vehicle state.
+ /// The in-vehicle state, .
public DetectorState InVehicle { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the in-vehicle activity detector is supported by the device.
+ /// Return true or false based on whether the in-vehicle activity detector is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of in-vehicle activity detectors available on the device.
+ /// Return the number of in-vehicle activity detectors available on the system.
///
/// 3
/// The count of in-vehicle activity detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.activity_recognition
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular in-vehicle activity detector in case of multiple sensors.
+ /// Index refers to a particular in-vehicle activity detector in case of multiple sensors.
+ /// Default value is 0.
///
public InVehicleActivityDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs
index 9a11d2adce9..5177176f3f9 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs
@@ -27,14 +27,14 @@ public sealed class LightSensor : Sensor
private const string LightSensorKey = "http://tizen.org/feature/sensor.photometer";
///
- /// Gets the level of the light.
+ /// Get the light level of light sensor as float type.
///
/// 3
/// The light level.
public float Level { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the light sensor is supported by the device.
+ /// Return true or false based on whether the light sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of light sensors available on the device.
+ /// Return the number of light sensors available on the system.
///
/// 3
/// The count of light sensors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.photometer
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors.
+ /// Index refers to a particular light sensor in case of multiple sensors.
+ /// Default value is 0.
///
public LightSensor(uint index = 0) : base(index)
{
@@ -86,7 +87,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the light sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs
index 2a2d80cc086..ec2f658fb7e 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs
@@ -27,29 +27,30 @@ public sealed class LinearAccelerationSensor : Sensor
private const string LinearAccelerationSensorKey = "http://tizen.org/feature/sensor.linear_acceleration";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the X component of the linear acceleration.
+ /// Get the X component value of the linear acceleration.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the linear acceleration.
+ /// Get the Y component value of the linear acceleration.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the linear acceleration.
+ /// Get the Z component value of the linear acceleration.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the linear acceleration sensor is supported by the device.
+ /// Return true or false based on whether the linear acceleration sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -63,7 +64,7 @@ public static bool IsSupported
}
///
- /// Returns the number of linear acceleration sensors available on the device.
+ /// Return the number of linear acceleration sensors available on the system.
///
/// 3
/// The count of linear acceleration sensors.
@@ -77,7 +78,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.linear_acceleration
@@ -85,7 +86,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors.
+ /// Index refers to a particular linear acceleration sensor in case of multiple sensors.
+ /// Default value is 0.
///
public LinearAccelerationSensor(uint index = 0) : base(index)
{
@@ -101,11 +103,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the linear acceleration sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs
index 0e47cec0203..e23c092826a 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs
@@ -27,29 +27,30 @@ public sealed class Magnetometer : Sensor
private static string MagnetometerKey = "http://tizen.org/feature/sensor.magnetometer";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the X component of the magnetometer.
+ /// Get the X component value of the magnetometer as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the magnetometer.
+ /// Get the Y component value of the magnetometer as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the magnetometer.
+ /// Get the Z component value of the magnetometer as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether magnetometer is supported by the device.
+ /// Return true or false based on whether magnetometer is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -63,7 +64,7 @@ public static bool IsSupported
}
///
- /// Returns the number of magnetometers available on the device.
+ /// Return the number of magnetometers available on the system.
///
/// 3
/// The count of magnetometers.
@@ -77,7 +78,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.magnetometer
@@ -85,7 +86,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors.
+ /// Index refers to a particular magnetometer in case of multiple sensors.
+ /// Default value is 0.
///
public Magnetometer(uint index = 0) : base(index)
{
@@ -101,11 +103,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer data.
///
/// 3
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
index 8813bd21fee..3e9c70fec65 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs
@@ -27,43 +27,44 @@ public sealed class MagnetometerRotationVectorSensor : Sensor
private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the X component of the magnetometer rotation vector.
+ /// Get the X component value of the magnetometer rotation vector as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the magnetometer rotation vector.
+ /// Get the Y component value of the magnetometer rotation vector as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the magnetometer rotation vector.
+ /// Get the Z component value of the magnetometer rotation vector as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Gets the W component of the magnetometer rotation vector.
+ /// Get the W component value of the magnetometer rotation vector as float type.
///
/// 3
/// W
public float W { get; private set; } = float.MinValue;
///
- /// Gets the accuracy of the magnetometer rotation vector data.
+ /// Get the accuracy of the magnetometer rotation vector data as enum type.
///
/// 3
- /// Accuracy
+ /// Accuracy, .
public SensorDataAccuracy Accuracy { get; private set; }
///
- /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device.
+ /// Return true or false based on whether the magnetometer rotation vector sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -77,7 +78,7 @@ public static bool IsSupported
}
///
- /// Returns the number of magnetometer rotation vector sensors available on the device.
+ /// Return the number of magnetometer rotation vector sensors available on the system.
///
/// 3
/// The count of magnetometer rotation vector sensors.
@@ -91,7 +92,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.geomagnetic_rotation_vector
@@ -99,7 +100,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
+ /// Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
+ /// Default value is 0.
///
public MagnetometerRotationVectorSensor(uint index = 0) : base(index)
{
@@ -115,11 +117,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs
index 0a221a05ac6..988e6ebc05f 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs
@@ -27,29 +27,30 @@ public sealed class OrientationSensor : Sensor
private static string OrientationSensorKey = "http://tizen.org/feature/sensor.tiltmeter";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the azimuth component of the orientation.
+ /// Get the azimuth component value of the orientation as float type.
///
/// 3
/// Azimuth
public float Azimuth { get; private set; } = float.MinValue;
///
- /// Gets the pitch component of the orientation.
+ /// Get the pitch component value of the orientation as float type.
///
/// 3
/// Pitch
public float Pitch { get; private set; } = float.MinValue;
///
- /// Gets the roll component of the orientation.
+ /// Get the roll component value of the orientation as float type.
///
/// 3
/// Roll
public float Roll { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the orientation sensor is supported by the device.
+ /// Return true or false based on whether the orientation sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -63,7 +64,7 @@ public static bool IsSupported
}
///
- /// Returns the number of orientation sensors available on the device.
+ /// Return the number of orientation sensors available on the system.
///
/// 3
/// The count of orientation sensors.
@@ -77,7 +78,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.tiltmeter
@@ -85,7 +86,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors.
+ /// Index refers to a particular orientation sensor in case of multiple sensors.
+ /// Default value is 0.
///
public OrientationSensor(uint index = 0) : base(index)
{
@@ -101,11 +103,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the orientation sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs
index a6e81905607..0cc2764ee46 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs
@@ -27,63 +27,63 @@ public sealed class Pedometer : Sensor
private static string PedometerKey = "http://tizen.org/feature/sensor.pedometer";
///
- /// Gets the step count.
+ /// Get the step count from pedometer as unsigned integer type.
///
/// 3
/// The step count.
public uint StepCount { get; private set; } = 0;
///
- /// Gets the walking step count.
+ /// Get the walking step count from pedometer as unsigned integer type.
///
/// 3
/// The walk step count.
public uint WalkStepCount { get; private set; } = 0;
///
- /// Gets the running step count.
+ /// Get the running step count from pedometer as unsigned integer type.
///
/// 3
/// The run step count.
public uint RunStepCount { get; private set; } = 0;
///
- /// Gets the moving distance.
+ /// Get the moving distance from pedometer as float type.
///
/// 3
/// The moving distance.
public float MovingDistance { get; private set; } = 0;
///
- /// Gets the calorie burned.
+ /// Get the calorie burned from pedometer as float type.
///
/// 3
/// The calorie burned.
public float CalorieBurned { get; private set; } = 0;
///
- /// Gets the last speed.
+ /// Get the last speed from pedometer as float type.
///
/// 3
/// The last speed.
public float LastSpeed { get; private set; } = 0;
///
- /// Gets the last stepping frequency.
+ /// Get the last stepping frequency from pedometer as float type.
///
/// 3
/// The last stepping frequency.
public float LastSteppingFrequency { get; private set; } = 0;
///
- /// Gets the last step status.
+ /// Get the last step status from pedometer as enum type.
///
/// 3
- /// The last step status.
+ /// The last step status, .
public PedometerState LastStepStatus { get; private set; } = PedometerState.Unknown;
///
- /// Returns true or false based on whether the pedometer sensor is supported by the device.
+ /// Return true or false based on whether the pedometer sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -97,7 +97,7 @@ public static bool IsSupported
}
///
- /// Returns the number of pedometer sensors available on the device.
+ /// Return the number of pedometer sensors available on the system.
///
/// 3
/// The count of pedometer sensors.
@@ -111,7 +111,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/privilege/healthinfo
@@ -122,7 +122,8 @@ public static int Count
/// Thrown when the application has no privilege to use the sensor.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors.
+ /// Index refers to a particular pedometer sensor in case of multiple sensors.
+ /// Default value is 0.
///
public Pedometer(uint index = 0) : base(index)
{
@@ -138,7 +139,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the pedometer sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs
index e6c9b736ff5..20681dea02c 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs
@@ -27,14 +27,14 @@ public sealed class PickUpGestureDetector : Sensor
private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition";
///
- /// Gets the state of the pick up gesture.
+ /// Get the state of the pick up gesture as enum type.
///
/// 3
- /// The pick up state.
+ /// The pick up state, .
public DetectorState PickUp { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the pick up gesture detector is supported by the device.
+ /// Return true or false based on whether the pick up gesture detector is supported by the system.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of pick up gesture detectors available on the device.
+ /// Return the number of pick up gesture detectors available on the system.
///
/// 3
/// The count of pick up gesture detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.gesture_recognition
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular pick up gesture detector in case of multiple sensors.
+ /// Index refers to a particular pick up gesture detector in case of multiple sensors.
+ /// Default value is 0.
///
public PickUpGestureDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs
index 80a1838c4e1..5c4f3703647 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs
@@ -27,14 +27,14 @@ public sealed class PressureSensor : Sensor
private static string PressureSensorKey = "http://tizen.org/feature/sensor.barometer";
///
- /// Gets the value of the pressure sensor.
+ /// Get the pressure value from the pressure sensor as float type.
///
/// 3
/// Pressure
public float Pressure { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the pressure sensor is supported by the device.
+ /// Return true or false based on whether the pressure sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of pressure sensors available on the device.
+ /// Return the number of pressure sensors available on the system.
///
/// 3
/// The count of pressure sensors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.barometer
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors.
+ /// Index refers to a particular pressure sensor in case of multiple sensors.
+ /// Default value is 0.
///
public PressureSensor(uint index = 0) : base(index)
{
@@ -86,7 +87,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the pressure sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs
index e1e4aa36a63..c428a9fe500 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs
@@ -27,14 +27,14 @@ public sealed class ProximitySensor : Sensor
private static string ProximitySensorKey = "http://tizen.org/feature/sensor.proximity";
///
- /// Gets the proximity state.
+ /// Get the proximity state as enum type.
///
/// 3
- /// The proximity state.
+ /// The proximity state, .
public ProximitySensorState Proximity { get; private set; } = ProximitySensorState.Unknown;
///
- /// Returns true or false based on whether the proximity sensor is supported by the device.
+ /// Return true or false based on whether the proximity sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of proximity sensors available on the device.
+ /// Return the number of proximity sensors available on the system.
///
/// 3
/// The count of proximity sensors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.proximity
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors.
+ /// Index refers to a particular proximity sensor in case of multiple sensors.
+ /// Default value is 0.
///
public ProximitySensor(uint index = 0) : base(index)
{
@@ -86,7 +87,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the proximity sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs
index 209cc33c644..5a08af0f487 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs
@@ -27,43 +27,44 @@ public sealed class RotationVectorSensor : Sensor
private static string RotationVectorKey = "http://tizen.org/feature/sensor.rotation_vector";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the X component of the rotation vector.
+ /// Get the X component value of the rotation vector as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the rotation vector.
+ /// Get the Y component value of the rotation vector as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the rotation vector.
+ /// Get the Z component value of the rotation vector as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Gets the W component of the rotation vector.
+ /// Get the W component value of the rotation vector as float type.
///
/// 3
/// W
public float W { get; private set; } = float.MinValue;
///
- /// Gets the accuracy of the rotation vector data.
+ /// Get the accuracy value of the rotation vector data as enum type.
///
/// 3
- /// Accuracy
+ /// Accuracy, .
public SensorDataAccuracy Accuracy { get; private set; } = SensorDataAccuracy.Undefined;
///
- /// Returns true or false based on whether the rotation vector sensor is supported by the device.
+ /// Return true or false based on whether the rotation vector sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -77,7 +78,7 @@ public static bool IsSupported
}
///
- /// Returns the number of rotation vector sensors available on the device.
+ /// Return the number of rotation vector sensors available on the system.
///
/// 3
/// The count of rotation vector sensors.
@@ -91,7 +92,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.rotation_vector
@@ -99,7 +100,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors.
+ /// Index refers to a particular rotation vector sensor in case of multiple sensors.
+ /// Default value is 0.
///
public RotationVectorSensor(uint index = 0) : base(index)
{
@@ -115,11 +117,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the rotation vector sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs
index d42a2cb4b6f..b87f0c66881 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs
@@ -27,14 +27,14 @@ public sealed class RunningActivityDetector : ActivityDetector
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
///
- /// Gets the state of the running activity detector.
+ /// Get the state of the running activity detector as enum type.
///
/// 3
- /// The running state.
+ /// The running state, .
public DetectorState Running { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the running activity detector is supported by the device.
+ /// Return true or false based on whether the running activity detector is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of running activity detectors available on the device.
+ /// Return the number of running activity detectors available on the system.
///
/// 3
/// The count of running activity detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.activity_recognition
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular running activity detector in case of multiple sensors.
+ /// Index refers to a particular running activity detector in case of multiple sensors.
+ /// Default value is 0.
///
public RunningActivityDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs
index bdeb27eb17c..2bab4494575 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs
@@ -27,14 +27,14 @@ public sealed class SleepMonitor : Sensor
private static string SleepMonitorKey = "http://tizen.org/feature/sensor.sleep_monitor";
///
- /// Gets the value of the sleep state.
+ /// Get the value of the sleep state as enum type.
///
/// 3
- /// The sleep state.
+ /// The sleep state, .
public SleepMonitorState SleepState { get; private set; } = SleepMonitorState.Unknown;
///
- /// Returns true or false based on whether the sleep monitor is supported by the device.
+ /// Return true or false based on whether the sleep monitor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of sleep monitors available on the device.
+ /// Return the number of sleep monitors available on the system.
///
/// 3
/// The count of sleep monitors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/privilege/healthinfo
@@ -73,7 +73,8 @@ public static int Count
/// Thrown when the application has no privilege to use the sensor.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors.
+ /// Index refers to a particular sleep monitor in case of multiple sensors.
+ /// Default value is 0.
///
public SleepMonitor(uint index = 0) : base(index)
{
@@ -89,7 +90,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data.
///
/// 3
-
public event EventHandler DataUpdated;
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs
index d72306256b4..f85ab0b771e 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs
@@ -27,14 +27,14 @@ public sealed class StationaryActivityDetector : ActivityDetector
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
///
- /// Gets the state of the stationary activity detector.
+ /// Get the state of the stationary activity detector as enum type.
///
/// 3
- /// The stationary state.
+ /// The stationary state, .
public DetectorState Stationary { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the stationary activity detector is supported by the device.
+ /// Return true or false based on whether the stationary activity detector is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of stationary activity detectors available on the device.
+ /// Return the number of stationary activity detectors available on the system.
///
/// 3
/// The count of stationary activity detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.activity_recognition
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular stationary activity detector in case of multiple sensors.
+ /// Index refers to a particular stationary activity detector in case of multiple sensors.
+ /// Default value is 0.
///
public StationaryActivityDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs
index d9a1df9511d..efbf803569d 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs
@@ -27,14 +27,14 @@ public sealed class TemperatureSensor : Sensor
private static string TemperatureSensorKey = "http://tizen.org/feature/sensor.temperature";
///
- /// Gets the value of the temperature sensor.
+ /// Get the value of the temperature sensor as float type.
///
/// 3
/// Temperature (Celsius)
public float Temperature { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the temperature sensor is supported by the device.
+ /// Return true or false based on whether the temperature sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of temperature sensors available on the device.
+ /// Return the number of temperature sensors available on the system.
///
/// 3
/// The count of temperature sensors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.temperature
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors.
+ /// Index refers to a particular temperature sensor in case of multiple sensors.
+ /// Default value is 0.
///
public TemperatureSensor(uint index = 0) : base(index)
{
@@ -86,7 +87,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the temperature sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs
index 53bfb10dbd4..a027068b541 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs
@@ -27,14 +27,14 @@ public sealed class UltravioletSensor : Sensor
private static string UltravioletSensorKey = "http://tizen.org/feature/sensor.ultraviolet";
///
- /// Gets the value of the ultraviolet sensor.
+ /// Get the value of the ultraviolet sensor as float type.
///
/// 3
/// The ultraviolet index.
public float UltravioletIndex { get; private set; } = float.MinValue;
///
- /// Returns true or false based on whether the ultraviolet sensor is supported by the device.
+ /// Return true or false based on whether the ultraviolet sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of ultraviolet sensors available on the device.
+ /// Return the number of ultraviolet sensors available on the system.
///
/// 3
/// The count of ultraviolet sensors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.ultraviolet
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors.
+ /// Index refers to a particular ultraviolet sensor in case of multiple sensors.
+ /// Default value is 0.
///
public UltravioletSensor(uint index = 0) : base(index)
{
@@ -86,7 +87,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the ultraviolet sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs
index 33c9b126470..e5904bff5db 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs
@@ -27,49 +27,49 @@ public sealed class UncalibratedGyroscope : Sensor
private static string UncalibratedGyroscopeKey = "http://tizen.org/feature/sensor.gyroscope.uncalibrated";
///
- /// Gets the X component of the acceleration.
+ /// Get the X component value of the acceleration as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of the acceleration as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of the acceleration as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Gets the BiasX component of the uncalibrated gyroscope data.
+ /// Get the BiasX component value of the uncalibrated gyroscope data as float type.
///
/// 3
/// The X bias.
public float BiasX { get; private set; } = 0;
///
- /// Gets the BiasY component of the uncalibrated gyroscope data.
+ /// Get the BiasY component value of the uncalibrated gyroscope data as float type.
///
/// 3
/// The Y bias.
public float BiasY { get; private set; } = 0;
///
- /// Gets the BiasZ component of the uncalibrated gyroscope data.
+ /// Get the BiasZ component value of the uncalibrated gyroscope data as float type.
///
/// 3
/// The Z bias.
public float BiasZ { get; private set; } = 0;
///
- /// Returns true or false based on whether the uncalibrated gyroscope sensor is supported by the device.
+ /// Return true or false based on whether the uncalibrated gyroscope sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -83,7 +83,7 @@ public static bool IsSupported
}
///
- /// Returns the number of the uncalibrated gyroscope sensors available on the device.
+ /// Return the number of the uncalibrated gyroscope sensors available on the system.
///
/// 3
/// The count of the uncalibrated gyroscope sensors.
@@ -97,7 +97,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.gyroscope.uncalibrated
@@ -105,7 +105,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors.
+ /// Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors.
+ /// Default value is 0.
///
public UncalibratedGyroscope(uint index = 0) : base(index)
{
@@ -121,7 +122,6 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated gyroscope sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
private static int GetCount()
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs
index ee1927dcb51..8feee427692 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs
@@ -27,50 +27,51 @@ public sealed class UncalibratedMagnetometer : Sensor
private static string UncalibratedMagnetometerKey = "http://tizen.org/feature/sensor.magnetometer.uncalibrated";
private event EventHandler _accuracyChanged;
+
///
- /// Gets the X component of the acceleration.
+ /// Get the X component value of the acceleration as float type.
///
/// 3
/// X
public float X { get; private set; } = float.MinValue;
///
- /// Gets the Y component of the acceleration.
+ /// Get the Y component value of the acceleration as float type.
///
/// 3
/// Y
public float Y { get; private set; } = float.MinValue;
///
- /// Gets the Z component of the acceleration.
+ /// Get the Z component value of the acceleration as float type.
///
/// 3
/// Z
public float Z { get; private set; } = float.MinValue;
///
- /// Gets the BiasX component of the uncalibrated magnetometer data.
+ /// Get the BiasX component value of the uncalibrated magnetometer data as float type.
///
/// 3
/// The X bias.
public float BiasX { get; private set; } = 0;
///
- /// Gets the BiasY component of the uncalibrated magnetometer data.
+ /// Get the BiasY component value of the uncalibrated magnetometer data as float type.
///
/// 3
/// The Y bias.
public float BiasY { get; private set; } = 0;
///
- /// Gets the BiasZ component of the uncalibrated magnetometer data.
+ /// Get the BiasZ component value of the uncalibrated magnetometer data as float type.
///
/// 3
/// The Z bias.
public float BiasZ { get; private set; } = 0;
///
- /// Returns true or false based on whether the uncalibrated magnetometer sensor is supported by the device.
+ /// Return true or false based on whether the uncalibrated magnetometer sensor is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -84,7 +85,7 @@ public static bool IsSupported
}
///
- /// Returns the number of uncalibrated magnetometer sensors available on the device.
+ /// Return the number of uncalibrated magnetometer sensors available on the system.
///
/// 3
/// The count of uncalibrated magnetometer sensors.
@@ -98,7 +99,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.magnetometer.uncalibrated
@@ -106,7 +107,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors.
+ /// Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors.
+ /// Default value is 0.
///
public UncalibratedMagnetometer(uint index = 0) : base(index)
{
@@ -122,11 +124,12 @@ internal override SensorType GetSensorType()
/// An event handler for storing the callback functions for the event corresponding to the change in the uncalibrated magnetometer sensor data.
///
/// 3
-
public event EventHandler DataUpdated;
///
/// An event handler for accuracy changed events.
+ /// If an event is added, a new accuracy change callback is registered for this sensor.
+ /// If an event is removed, accuracy change callback is unregistered for this sensor.
///
/// 3
public event EventHandler AccuracyChanged
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs
index a7ecb6188a6..e969e544ed8 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs
@@ -27,14 +27,14 @@ public sealed class WalkingActivityDetector : ActivityDetector
private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition";
///
- /// Gets the state of the walking activity detector.
+ /// Get the state of the walking activity detector as enum type.
///
/// 3
- /// The walking state.
+ /// The walking state, .
public DetectorState Walking { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the walking activity detector is supported by the device.
+ /// Return true or false based on whether the walking activity detector is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of walking activity detectors available on the device.
+ /// Return the number of walking activity detectors available on the system.
///
/// 3
/// The count of walking activity detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.activity_recognition
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular walking activity detector in case of multiple sensors.
+ /// Index refers to a particular walking activity detector in case of multiple sensors.
+ /// Default value is 0.
///
public WalkingActivityDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs
index 1e4966ff6c7..bdbde3e0b87 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs
@@ -27,14 +27,14 @@ public sealed class WristUpGestureDetector : Sensor
private static string WristUpKey = "http://tizen.org/feature/sensor.wrist_up";
///
- /// Gets the state of the wrist up gesture.
+ /// Get the state of the wrist up gesture as enum type.
///
/// 3
- /// The wrist up state.
+ /// The wrist up state, .
public DetectorState WristUp { get; private set; } = DetectorState.Unknown;
///
- /// Returns true or false based on whether the wrist up gesture detector is supported by the device.
+ /// Return true or false based on whether the wrist up gesture detector is supported by the device.
///
/// 3
/// true if supported; otherwise false.
@@ -48,7 +48,7 @@ public static bool IsSupported
}
///
- /// Returns the number of wrist up gesture detectors available on the device.
+ /// Return the number of wrist up gesture detectors available on the system.
///
/// 3
/// The count of wrist up gesture detectors.
@@ -62,7 +62,7 @@ public static int Count
}
///
- /// Initializes a new instance of the class.
+ /// Initialize a new instance of the class.
///
/// 3
/// http://tizen.org/feature/sensor.wrist_up
@@ -70,7 +70,8 @@ public static int Count
/// Thrown when the sensor is not supported.
/// Thrown when the operation is invalid for the current state.
///
- /// Index. Default value for this is 0. Index refers to a particular wrist up gesture detector in case of multiple sensors.
+ /// Index refers to a particular wrist up gesture detector in case of multiple sensors.
+ /// Default value is 0.
///
public WristUpGestureDetector(uint index = 0) : base(index)
{
diff --git a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs
index 1812c7ccf53..602ef32bf32 100755
--- a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs
+++ b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs
@@ -52,13 +52,38 @@ public abstract class Sensor : IDisposable
///
- /// Read a sensor data synchronously.
+ /// Read sensor(which inherits this class) data synchronously.
///
internal abstract void ReadData();
+
+ ///
+ /// Get the type of a sensor which inherits this class.
+ ///
internal abstract SensorType GetSensorType();
+
+ ///
+ /// Start to listen the event of a sensor which inherits this class.
+ ///
internal abstract void EventListenStart();
+
+ ///
+ /// Stop to listen the event of a sensor which inherits this class.
+ ///
internal abstract void EventListenStop();
+ ///
+ /// Update the internal batch event list using the latest events.
+ ///
+ ///
+ /// It will be called for updating events about the sensor like
+ /// BatchSensor or Plugin classes which inherits this class.
+ ///
+ ///
+ /// General batch data's raw pointer
+ ///
+ ///
+ /// Number of general batch events
+ ///
internal void updateBatchEvents(IntPtr eventsPtr, uint events_count)
{
if (events_count >= 1)
@@ -73,6 +98,14 @@ internal void updateBatchEvents(IntPtr eventsPtr, uint events_count)
}
}
+ ///
+ /// Return the last element of Batched elements, which is the latest
+ /// sensor event.
+ ///
+ ///
+ /// If there is no event, default(Interop.SensorEventStruct) will be
+ /// returned.
+ ///
internal Interop.SensorEventStruct latestEvent()
{
if (BatchedEvents.Count > 0)
@@ -82,6 +115,9 @@ internal Interop.SensorEventStruct latestEvent()
return default(Interop.SensorEventStruct);
}
+ ///
+ /// Create the Sensor object to listen to the sensor events.
+ ///
internal Sensor(uint index)
{
SensorType type = GetSensorType();
@@ -94,7 +130,7 @@ internal Sensor(uint index)
}
///
- /// Destroy the Sensor object.
+ /// Destroy the Sensor object and release all resources.
///
~Sensor()
{
@@ -102,7 +138,7 @@ internal Sensor(uint index)
}
///
- /// Property: Gets the name of the sensor.
+ /// Property: Gets the name of the sensor as a string.
///
/// 3
/// The name of the sensor.
@@ -116,7 +152,7 @@ public string Name
}
///
- /// Property: Gets the vendor.
+ /// Property: Gets the vendor of the sensor as a string.
///
/// 3
/// The vendor name of the sensor.
@@ -158,7 +194,7 @@ public float MaxValue
}
///
- /// Property: Gets the resolution.
+ /// Property: Gets the resolution of the sensor as a float type.
///
/// 3
/// The resolution.
@@ -172,7 +208,7 @@ public float Resolution
}
///
- /// Property: Gets the minimum interval.
+ /// Property: Gets the minimum interval of the sensor.
///
/// 3
/// The minimum update interval.
@@ -186,7 +222,7 @@ public int MinInterval
}
///
- /// Property: Gets the FIFO count.
+ /// Property: Gets the FIFO count of the sensor as int type.
///
/// 3
/// The size of the hardware FIFO.
@@ -200,7 +236,7 @@ public int FifoCount
}
///
- /// Property: Gets the maximum batch count.
+ /// Property: Gets the maximum batch count of the sensor.
///
/// 3
/// The maximum batch count.
@@ -257,7 +293,8 @@ public uint MaxBatchLatency
}
///
- /// Sets the pause policy of the sensor.
+ /// Get the pause policy or set the pause policy of the sensor as the
+ /// set value.
///
/// 3
/// The pause policy.
@@ -280,6 +317,9 @@ public SensorPausePolicy PausePolicy
///
/// Gets or sets the time span.
+ /// Set value will be used as its 'Ticks' attribute.
+ /// Get will return the newly allocated TimeSpan object with the same
+ /// ticks as the sensor's timestamp.
///
/// 3
/// The time span.
@@ -298,7 +338,8 @@ public TimeSpan TimeSpan
}
///
- /// Gets or sets the timestamp.
+ /// Gets or sets the timestamp of a sensor which inherits the sensor
+ /// class.
///
/// 8
/// Timestamp.
@@ -317,10 +358,10 @@ public ulong Timestamp
}
///
- /// Indicates whether this sensor is sensing.
+ /// Indicate whether the sensor is sensing or not sensing.
///
/// 3
- /// true if this sensor is sensing; otherwise false.
+ /// true if the sensor is sensing; otherwise false.
public bool IsSensing
{
get
@@ -338,6 +379,12 @@ internal IntPtr ListenerHandle
}
}
+ ///
+ /// Check if the sensor type is supported or not by the system.
+ ///
+ /// The sensor type to check.
+ /// The key for the sensor type to check.
+ /// True if the sensor type is supported, otherwise false.
internal static bool CheckIfSupported(SensorType type, String key)
{
bool isSupported = false;
@@ -414,7 +461,7 @@ public void Stop()
}
///
- /// Destroy the current object.
+ /// Destroy the current object and release all the resources.
///
/// 3
public void Dispose()
@@ -453,6 +500,13 @@ internal void SetAttribute(SensorAttribute attribute, int option)
}
}
+ ///
+ /// Gets the handle list of the sensors of a given type and index.
+ ///
+ ///
+ /// A device may have more than one sensors of the given type.
+ /// In such case, the 'index'th sensor handle will be used.
+ ///
private void GetHandleList(SensorType type, uint index)
{
IntPtr list;
@@ -469,6 +523,10 @@ private void GetHandleList(SensorType type, uint index)
Interop.Libc.Free(list);
}
+ ///
+ /// Get the following sensor properties of the sensor:
+ /// name, vendor, minimum range, maximum range, resolution, minimum interval, fifo count, maximum batch count
+ ///
private void GetProperty()
{
int error = (int)SensorError.None;
@@ -530,6 +588,9 @@ private void GetProperty()
}
}
+ ///
+ /// Create a sensor listener and store a handle of the listener as an member variable.
+ ///
private void CreateListener()
{
int error = Interop.SensorListener.CreateListener(_sensorHandle, out _listenerHandle);
@@ -540,6 +601,9 @@ private void CreateListener()
}
}
+ ///
+ /// Change the interval between updates for the sensor with the value stored in member variable.
+ ///
private void SetInterval()
{
if (CheckListenerHandle())
@@ -556,6 +620,20 @@ private void SetInterval()
}
}
+ ///
+ /// Set the desired maximum batch latency of the sensor.
+ /// Sensors that support batching may allow applications to change their maximum batch latencies.
+ /// For example, if you set the latency as 10,000 ms, the sensor may store its data
+ /// up to 10,000 ms, before delivering the data through the HAL.
+ /// In case of non-batching sensors no error will be occured,
+ /// but nothing is affected by the input latency value.
+ ///
+ ///
+ /// Even if you set a batch latency, the sensor may not work as you intended,
+ /// as one sensor can be used by more than one listeners.
+ /// In addition, some batch sensors may already have fixed batching latency
+ /// or batching queue size, which cannot be altered by applications.
+ ///
private void SetMaxBatchLatency()
{
if (CheckListenerHandle())
@@ -569,6 +647,14 @@ private void SetMaxBatchLatency()
}
}
+ ///
+ /// Check if listener handle for the sensor is valid or not.
+ ///
+ ///
+ /// If listener handle is not valid, then it will throw ArgumentException.
+ ///
+ /// Thrown when the sensor listener handler is invalid.
+ /// true if listener handle is valid.
private bool CheckListenerHandle()
{
bool result = false;
@@ -584,6 +670,12 @@ private bool CheckListenerHandle()
return result;
}
+ ///
+ /// Check if sensor handle for the sensor is valid or not.
+ /// If sensor handle is not valid, then it will throw ArgumentException.
+ ///
+ /// Thrown when the sensor handler is invalid.
+ /// true if sensor handle is valid.
private bool CheckSensorHandle()
{
bool result = false;
@@ -599,6 +691,14 @@ private bool CheckSensorHandle()
return result;
}
+ ///
+ /// Destroy resources of a listener handle of the sensor.
+ /// Release all resources allocated for a listener handle.
+ ///
+ ///
+ /// If this function is called while the sensor is still running,
+ /// that is, then it is implicitly stopped.
+ ///
private void DestroyHandles()
{
Interop.SensorListener.DestroyListener(_listenerHandle);
diff --git a/src/Tizen.System.Information/Common/Information.cs b/src/Tizen.System.Information/Common/Information.cs
index 62a01aaea06..8ae73edfa6c 100644
--- a/src/Tizen.System.Information/Common/Information.cs
+++ b/src/Tizen.System.Information/Common/Information.cs
@@ -124,7 +124,7 @@ private static bool TryGetSystemInfoValue(string key, out T value)
#pragma warning restore CS0618 // Type or member is obsolete
///
- /// Gets the value of the feature.
+ /// Gets the value of the feature. It accepts both system and runtime feature key.
///
/// 4
/// The type of .
diff --git a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs
index f42fee9d2ae..53a387772d7 100755
--- a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs
+++ b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs
@@ -23,7 +23,7 @@
namespace Tizen.System
{
///
- /// The class for CPU usage per process.
+ /// The class for CPU usage per given list of process.
///
/// 3
public class ProcessCpuUsage
@@ -32,7 +32,7 @@ public class ProcessCpuUsage
private Interop.RuntimeInfo.ProcessCpuUsage[] Usages;
///
- /// The constructor of ProcessCpuUsage class.
+ /// The constructor of ProcessCpuUsage class of the given list of process. It internally call Update() on constructing an instance.
///
/// 4
/// List of unique process ids.
@@ -47,13 +47,13 @@ public ProcessCpuUsage(IEnumerable pid)
}
///
- /// The number of usage entries.
+ /// The number of processes being tracked by the instance.
///
/// 4
public int Count { get; internal set; }
///
- /// 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.
///
/// 4
/// The process id.
@@ -71,7 +71,7 @@ public uint GetUTime(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -89,7 +89,7 @@ public uint GetSTime(int pid)
}
///
- /// Update the process CPU usage to the latest.
+ /// Update CPU usage of the given processes to the latest.
///
/// 4
/// List of unique process ids.
diff --git a/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs b/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs
index 0c4a2a393fe..8b1bbeee02f 100755
--- 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;
///
- /// The constructor of ProcessMemoryInformation class.
+ /// The constructor of ProcessMemoryInformation class of the given list of process. It internally call Update() on constructing an instance.
///
/// 4
/// List of unique process ids.
@@ -51,13 +51,13 @@ public ProcessMemoryUsage(IEnumerable pid)
}
///
- /// The number of usage entries.
+ /// The number of processes being tracked by the instance.
///
/// 4
public int Count => Pids.Length;
///
- /// 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.
///
/// 4
/// The process id.
@@ -75,7 +75,7 @@ public int GetVsz(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -93,7 +93,7 @@ public int GetRss(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -111,7 +111,7 @@ public int GetPss(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -129,7 +129,7 @@ public int GetSharedClean(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -147,7 +147,7 @@ public int GetSharedDirty(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -165,7 +165,7 @@ public int GetPrivateClean(int pid)
}
///
- /// 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.
///
/// 4
/// The process id.
@@ -183,7 +183,7 @@ public int GetPrivateDirty(int pid)
}
///
- /// 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.
///
/// The process id.
/// The GPU memory size is using (KiB).
@@ -208,7 +208,7 @@ public int GetGPU(int pid)
}
///
- /// 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.
///
/// The process id.
/// The resident set size is using (KiB).
@@ -233,7 +233,7 @@ public int GetGemRss(int pid)
}
///
- /// 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.
///
/// The process id.
/// The SWAP memory size is using (KiB).
diff --git a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs
index a248275ee4e..76eee812d08 100755
--- a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs
+++ b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs
@@ -20,7 +20,7 @@
namespace Tizen.System
{
///
- /// The class for system CPU usage.
+ /// The class for CPU usage information of the system.
///
/// 4
public class SystemCpuUsage
@@ -30,7 +30,7 @@ public class SystemCpuUsage
private int[] MaxFrequencies;
///
- /// The constructor of SystemCpuUsage class.
+ /// The constructor of SystemCpuUsage class. It internally call Update() on constructing an instance.
///
/// 4
/// Thrown when an I/O error occurs while reading from the system.
@@ -41,7 +41,7 @@ public SystemCpuUsage()
}
///
- /// 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.
///
/// 4
public double User
@@ -53,7 +53,7 @@ public double User
}
///
- /// 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.
///
/// 4
public double System
@@ -65,7 +65,7 @@ public double System
}
///
- /// 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.
///
/// 4
public double Nice
@@ -77,7 +77,7 @@ public double Nice
}
///
- /// 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.
///
/// 4
public double IoWait
@@ -95,7 +95,7 @@ public double IoWait
public int ProcessorCount { get; internal set; }
///
- /// 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.
///
/// 4
/// The index (from 0) of the CPU core that you want to know the frequency of.
@@ -113,7 +113,7 @@ public int GetCurrentFrequency(int coreId)
}
///
- /// 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.
///
/// 4
/// The index (from 0) of CPU core that you want to know the frequency of.
@@ -131,7 +131,7 @@ public int GetMaxFrequency(int coreId)
}
///
- /// Update the system CPU usage to the latest.
+ /// Update the system CPU usage information to the latest.
///
/// 4
/// Thrown when an I/O error occurs while reading from the system.
diff --git a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs
index 4819afa8109..e0c7e715a97 100755
--- a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs
+++ b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs
@@ -19,7 +19,7 @@
namespace Tizen.System
{
///
- /// The class for system memory information.
+ /// The class for memory usage information of the system.
///
/// 4
public class SystemMemoryUsage
@@ -27,7 +27,7 @@ public class SystemMemoryUsage
private Interop.RuntimeInfo.MemoryInfo Info;
///
- /// The constructor of MemoryInformation class.
+ /// The constructor of MemoryInformation class. It internally call Update() on constructing an instance.
///
/// 4
/// Thrown when an I/O error occurs while reading from the system.
@@ -37,7 +37,7 @@ public SystemMemoryUsage()
}
///
- /// Total memory (KiB).
+ /// Total memory (KiB). To get the latest value, it is recommended to call Update() before it.
///
/// 4
public int Total
@@ -49,7 +49,7 @@ public int Total
}
///
- /// Used memory (KiB).
+ /// Used memory (KiB). To get the latest value, it is recommended to call Update() before it.
///
/// 4
public int Used
@@ -61,7 +61,7 @@ public int Used
}
///
- /// Free memory (KiB).
+ /// Free memory (KiB). To get the latest value, it is recommended to call Update() before it.
///
/// 4
public int Free
@@ -73,7 +73,7 @@ public int Free
}
///
- /// Cache memory (KiB).
+ /// Cache memory (KiB). To get the latest value, it is recommended to call Update() before it.
///
/// 4
public int Cache
@@ -85,7 +85,7 @@ public int Cache
}
///
- /// Swap memory (KiB).
+ /// Swap memory (KiB). To get the latest value, it is recommended to call Update() before it.
///
/// 4
public int Swap