diff --git a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs index 16805c4b013..f0b6ebfb90a 100755 --- a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs +++ b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentInfo.cs @@ -20,7 +20,8 @@ namespace Tizen.Applications.ComponentBased { /// - /// This class provides methods and properties to get information of the component. + /// Provides methods and properties to retrieve information about a component in a Tizen application. + /// This class encapsulates details such as component ID, application ID, and other attributes. /// /// 6 public class ComponentInfo : IDisposable @@ -41,13 +42,13 @@ internal ComponentInfo(IntPtr infoHandle) } /// - /// A constructor of ComponentInfo that takes the component ID. + /// Initializes a new instance of the class with the specified component ID. /// - /// Component ID. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied.> + /// The ID of the component. + /// Thrown when the component ID is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied. /// http://tizen.org/privilege/packagemanager.info /// 6 public ComponentInfo(string componentId) @@ -63,7 +64,7 @@ public ComponentInfo(string componentId) } /// - /// Destructor of the class. + /// Finalizes an instance of the class. /// ~ComponentInfo() { @@ -71,7 +72,7 @@ public ComponentInfo(string componentId) } /// - /// Gets the component ID. + /// Gets the ID of the component. /// /// 6 public string ComponentId @@ -94,7 +95,7 @@ public string ComponentId } /// - /// Gets the application ID of the component. + /// Gets the application ID associated with the component. /// /// 6 public string ApplicationId @@ -132,7 +133,7 @@ public ComponentType ComponentType } /// - /// Checks whether the icon of the component should be displayed or not. + /// Checks whether the icon of the component should be displayed. /// /// 6 public bool IsIconDisplayed @@ -151,7 +152,7 @@ public bool IsIconDisplayed } /// - /// Checks whether the component should be managed by task-manager or not. + /// Checks whether the component is managed by the task manager. /// /// 6 public bool IsManagedByTaskManager @@ -170,7 +171,7 @@ public bool IsManagedByTaskManager } /// - /// Gets the absolute path of the icon image. + /// Gets the absolute path of the component's icon image. /// /// 6 public string IconPath @@ -207,11 +208,11 @@ public string Label } /// - /// Gets the localized label of the component for the given locale. + /// Gets the localized label of the component for a specified locale. /// - /// Locale. - /// The format of locale is language and country code. (available value: "[2-letter lowercase language code (ISO 639-1)]-[2-letter lowercase country code (ISO 3166-alpha-2)]") - /// The localized label. + /// The locale in the format of language and country code (e.g., "en-US"). + /// Available values are in the format "[2-letter lowercase language code (ISO 639-1)]-[2-letter lowercase country code (ISO 3166-alpha-2)]". + /// The localized label corresponding to the specified locale. /// 6 public string GetLocalizedLabel(string locale) { @@ -226,7 +227,7 @@ public string GetLocalizedLabel(string locale) } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases all resources used by the class. /// /// 6 public void Dispose() @@ -236,7 +237,7 @@ public void Dispose() } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases resources used by the class. /// /// Disposing /// 6 diff --git a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs index 4824e6f4e4b..890c8080fc0 100755 --- a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs +++ b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentManager.cs @@ -29,15 +29,18 @@ namespace Tizen.Applications.ComponentBased public static class ComponentManager { private const string LogTag = "Tizen.Applications"; - + /// - /// Gets the information of the installed components asynchronously. + /// Asynchronously retrieves a list of installed components. /// - /// The installed component info list. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// + /// A task that represents the asynchronous operation. + /// The task result contains an of the installed component information. + /// + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to access the component information. /// http://tizen.org/privilege/packagemanager.info /// 6 public static async Task> GetInstalledComponentsAsync() @@ -74,13 +77,16 @@ public static async Task> GetInstalledComponentsAsync } /// - /// Gets the information of the running components asynchronously. + /// Asynchronously retrieves a list of currently running components. /// - /// The component running context list. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// + /// A task that represents the asynchronous operation. + /// The task result contains an of the running components. + /// + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to access the running components. /// http://tizen.org/privilege/packagemanager.info /// 6 public static async Task> GetRunningComponentsAsync() @@ -117,14 +123,16 @@ public static async Task> GetRunningCompone } /// - /// Checks whether the component is running or not. + /// Checks if a specified component is currently running. /// - /// Component ID. - /// Returns true if the component is running, otherwise false. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// The unique identifier of the component. + /// + /// True if the component is running; otherwise, false. + /// + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to access the component status. /// http://tizen.org/privilege/packagemanager.info /// 6 public static bool IsRunning(string componentId) @@ -139,17 +147,17 @@ public static bool IsRunning(string componentId) } /// - /// Terminates the component if it is running in the background. + /// Requests to terminate a specified component that is running in the background. /// - /// Component ID - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// The context of the running component to terminate. + /// Thrown when an invalid argument is provided. + /// Thrown when the component does not exist or if a system error occurs. + /// Thrown when the system runs out of memory. + /// Thrown when permission is denied to terminate the component. /// http://tizen.org/privilege/appmanager.kill.bgapp /// - /// This function returns after it just sends a request for terminating a background component. - /// Platform will decide if the target component could be terminated or not according to the state of the target component. + /// This method sends a request to terminate a background component. + /// The platform determines if the target component can be terminated based on its current state. /// /// 6 public static void TerminateBackgroundComponent(ComponentRunningContext context) diff --git a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs index 4932922087c..0c366ec1c6e 100755 --- a/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs +++ b/src/Tizen.Applications.ComponentBased.ComponentManager/Tizen.Applications/ComponentRunningContext.cs @@ -23,7 +23,8 @@ namespace Tizen.Applications.ComponentBased { /// - /// This class provides methods and properties to get information of the running component. + /// Represents the context of a running component, providing methods and properties + /// to retrieve information about the component's state and behavior. /// /// 6 public class ComponentRunningContext : IDisposable @@ -39,13 +40,14 @@ internal ComponentRunningContext(IntPtr contextHandle) } /// - /// A constructor of ComponentRunningContext that takes the component ID. + /// Initializes a new instance of the class + /// with a specified component ID, retrieving the context handle associated with it. /// - /// Component ID. - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the "component not exist" error or the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// The ID of the component. + /// Thrown when the component ID is invalid. + /// Thrown when the component does not exist or a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to access the component. /// http://tizen.org/privilege/packagemanager.info /// 6 public ComponentRunningContext(string componentId) @@ -61,7 +63,7 @@ public ComponentRunningContext(string componentId) } /// - /// Destructor of the class. + /// Finalizes an instance of the class. /// ~ComponentRunningContext() { @@ -69,7 +71,7 @@ public ComponentRunningContext(string componentId) } /// - /// Enumeration for the component state. + /// Represents the possible states of a component. /// /// 6 public enum ComponentState @@ -108,6 +110,7 @@ public enum ComponentState /// /// Gets the ID of the component. /// + /// The component ID as a string. /// 6 public string ComponentId { @@ -129,7 +132,7 @@ public string ComponentId } /// - /// Gets the application ID of the component. + /// Gets the application ID associated with the component. /// /// 6 public string ApplicationId @@ -146,7 +149,7 @@ public string ApplicationId return appId; } } - + /// /// Gets the instance ID of the component. /// @@ -167,7 +170,7 @@ public string InstanceId } /// - /// Gets the state of the component. + /// Gets the current state of the component. /// /// 6 public ComponentState State @@ -186,8 +189,9 @@ public ComponentState State } /// - /// Checks whether the component is terminated or not. + /// Checks whether the component has been terminated. /// + /// true if the component is terminated; otherwise, false. /// 6 public bool IsTerminated { @@ -205,8 +209,9 @@ public bool IsTerminated } /// - /// Checks whether the component is running as sub component of the group. + /// Checks whether the component is running as a sub-component of a group. /// + /// true if the component is a sub-component; otherwise, false. /// 6 public bool IsSubComponent { @@ -224,12 +229,12 @@ public bool IsSubComponent } /// - /// Resumes the running component. + /// Resumes the execution of the running component. /// - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// Thrown when the argument is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to resume the component. /// http://tizen.org/privilege/appmanager.launch /// 6 public void Resume() @@ -237,17 +242,17 @@ public void Resume() Interop.ComponentManager.ErrorCode err = Interop.ComponentManager.ComponentManagerResumeComponent(_contextHandle); if (err != Interop.ComponentManager.ErrorCode.None) { - throw ComponentManager.ComponentManagerErrorFactory.GetException(err, "Failed to Send the resume request."); + throw ComponentManager.ComponentManagerErrorFactory.GetException(err, "Failed to send the resume request."); } } /// - /// Pauses the running component. + /// Pauses the execution of the running component. /// - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// Thrown when the argument is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to pause the component. /// http://tizen.org/privilege/appmanager.launch /// 6 [EditorBrowsable(EditorBrowsableState.Never)] @@ -261,12 +266,12 @@ public void Pause() } /// - /// Terminates the running component. + /// Terminates the execution of the running component. /// - /// Thrown when failed because of an invalid argument. - /// Thrown when failed because of the system error. - /// Thrown when failed because of out of memory. - /// Thrown when failed because of permission denied. + /// Thrown when the argument is invalid. + /// Thrown when a system error occurs. + /// Thrown when memory allocation fails. + /// Thrown when permission is denied to terminate the component. /// http://tizen.org/privilege/appmanager.launch /// 6 [EditorBrowsable(EditorBrowsableState.Never)] @@ -280,7 +285,7 @@ public void Terminate() } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases all resources used by the class. /// /// 6 public void Dispose() @@ -290,9 +295,9 @@ public void Dispose() } /// - /// Releases all resources used by the ComponentInfo class. + /// Releases all resources used by the class. /// - /// Disposing + /// true to release managed resources; otherwise, false. /// 6 private void Dispose(bool disposing) {