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)
{