From 6c5c9b1272a3f097e6ebbe59558391935f56f733 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Tue, 1 Aug 2017 20:17:33 +0530 Subject: [PATCH] Review widget-application API cs files Change-Id: I1d53b4be21c0b6504469383f94f1e34c9212c25c --- .../Tizen.Applications/WidgetApplication.cs | 16 +++--- .../Tizen.Applications/WidgetBase.cs | 64 +++++++++++----------- 2 files changed, 40 insertions(+), 40 deletions(-) diff --git a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs index 501c1eb..ba8edc1 100755 --- a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs +++ b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs @@ -26,9 +26,9 @@ namespace Tizen.Applications public class WidgetApplication : CoreApplication { /// - /// Initializes WidgetApplication class with Type and application id. + /// Initializes the WidgetApplication class with the type and application ID. /// - /// map structure for derived class type and widget id + /// Map structure for the derived class type and widget ID. public WidgetApplication(IDictionary typeInfo) : base(new WidgetCoreBackend()) { WidgetCoreBackend core = Backend as WidgetCoreBackend; @@ -37,10 +37,10 @@ namespace Tizen.Applications } /// - /// Initializes WidgetApplication class with Type. + /// Initializes the WidgetApplication class with the type. /// - /// Widget id will be replaced as application id - /// derived class type + /// Widget ID will be replaced as the application ID. + /// Derived class type. public WidgetApplication(Type type) : base(new WidgetCoreBackend()) { WidgetCoreBackend core = Backend as WidgetCoreBackend; @@ -49,9 +49,9 @@ namespace Tizen.Applications } /// - /// Gets all instances of the widget associated with the type + /// Gets all instances of the widget associated with the type. /// - /// Class type for the widget + /// Class type for the widget. public IEnumerable GetInstances(Type type) { WidgetCoreBackend core = Backend as WidgetCoreBackend; @@ -73,7 +73,7 @@ namespace Tizen.Applications /// /// Runs the widget application's main loop. /// - /// Arguments from commandline. + /// Arguments from the commandline. public override void Run(string[] args) { base.Run(args); diff --git a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs index ef6c333..7d79369 100755 --- a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs +++ b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs @@ -20,7 +20,7 @@ using System; namespace Tizen.Applications { /// - /// Abstract class for widget instances + /// The abstract class for widget instances. /// public abstract class WidgetBase { @@ -31,12 +31,12 @@ namespace Tizen.Applications /// /// Window object for this widget instance. - /// It wii be created after OnCreate method is invoked. + /// It will be created after OnCreate method is invoked. /// protected Widget Window; /// - /// Delete type + /// Delete type. /// public enum WidgetDestroyType { @@ -46,25 +46,25 @@ namespace Tizen.Applications Permanent = 0, /// - /// Widget is deleted because of other reasons. (e.g. widget process is terminated temporarily by the system) + /// Widget is deleted because of other reasons. (For e.g., widget process is terminated temporarily by the system) /// Temporary } /// - /// Constructor + /// Constructor. /// public WidgetBase() { } /// - /// Sets the content info to the widget. + /// Sets the content information to the widget. /// - /// The data set to save - /// Thrown when failed because of invalid argument - /// Thrown when API is not supported in this device - /// Thrown in case of unrecoverable error + /// The data set to save. + /// Thrown when failed because of an invalid argument. + /// Thrown when the API is not supported in this device. + /// Thrown in case of an unrecoverable error. public void SetContent(Bundle info) { Interop.Widget.ErrorCode err = Interop.Widget.SetContent(Handle, info.SafeBundleHandle); @@ -92,10 +92,10 @@ namespace Tizen.Applications /// /// Sends the title to the widget. /// - /// When an accessibility mode is turned on, this string will be read - /// Thrown when failed because of invalid argument - /// Thrown when API is not supported in this device - /// Thrown in case of unrecoverable error + /// When an accessibility mode is turned on, this string will be read. + /// Thrown when failed because of an invalid argument. + /// Thrown when the API is not supported in this device. + /// Thrown in case of an unrecoverable error. public void SetTitle(string title) { Interop.Widget.ErrorCode err = Interop.Widget.SetTitle(Handle, title); @@ -120,10 +120,10 @@ namespace Tizen.Applications } /// - /// Finishes context for the widget instance. + /// Finishes the context for the widget instance. /// - /// Thrown when API is not supported in this device - /// Thrown in case of unrecoverable error + /// Thrown when the API is not supported in this device. + /// Thrown in case of an unrecoverable error. public void Exit() { Interop.Widget.ErrorCode err = Interop.Widget.TerminateContext(Handle); @@ -151,11 +151,11 @@ namespace Tizen.Applications } /// - /// Overrides this method if want to handle behavior when the widget instance is started. + /// Overrides this method if want to handle the behavior when the widget instance is started. /// - /// The data set for the previous status - /// The pixel value for widget width - /// The pixel value for widget height + /// The data set for the previous status. + /// The pixel value for the widget width. + /// The pixel value for the widget height. public virtual void OnCreate(Bundle content, int w, int h) { IntPtr win; @@ -169,42 +169,42 @@ namespace Tizen.Applications } /// - /// Overrides this method if want to handle behavior when the widget instance is destroyed. + /// Overrides this method if want to handle the behavior when the widget instance is destroyed. /// - /// The reason for destruction - /// The data set to save + /// The reason for destruction. + /// The data set to save. public virtual void OnDestroy(WidgetDestroyType reason, Bundle content) { } /// - /// Overrides this method if want to handle behavior when the widget instance is paused. + /// Overrides this method if want to handle the behavior when the widget instance is paused. /// public virtual void OnPause() { } /// - /// Overrides this method if want to handle behavior when the widget instance is resumed. + /// Overrides this method if want to handle the behavior when the widget instance is resumed. /// public virtual void OnResume() { } /// - /// Overrides this method if want to handle behavior when the widget instance is resized. + /// Overrides this method if want to handle the behavior when the widget instance is resized. /// - /// Widget width - /// Widget height + /// Widget width. + /// Widget height. public virtual void OnResize(int w, int h) { } /// - /// Overrides this method if want to handle behavior when the widget instance should be updated. + /// Overrides this method if want to handle the behavior when the widget instance is updated. /// - /// The data set for updating this widget. It will be provided by requester. - /// Although the widget is paused, if it is TRUE, the widget can be updated + /// The data set for updating this widget will be provided by the requester. + /// Although the widget is paused, if it is true, the widget can be updated. public virtual void OnUpdate(Bundle content, bool isForce) { } -- 2.7.4