From: Editor Lionbridge <TizenEditor.SEL@lionbridge.com>
Date: Tue, 1 Aug 2017 15:01:20 +0000 (+0530)
Subject: Review widget-viewer API cs files
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Ftizen;p=platform%2Fcore%2Fcsapi%2Fwidget-viewer.git

Review widget-viewer API cs files

Change-Id: Idefa7e04b9f17b305e84b77fcfe2034cbd59bd69
---

diff --git a/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs b/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs
index 44cad3b..f20e8bb 100755
--- a/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs
+++ b/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs
@@ -21,12 +21,12 @@ using System.Runtime.InteropServices;
 namespace Tizen.Applications
 {
     /// <summary>
-    /// Represents proxy class for widget application.
+    /// Represents the proxy class for the widget application.
     /// </summary>
     public class RemoteView
     {
         /// <summary>
-        /// Event types to send.
+        /// The event types to send.
         /// </summary>
         public enum Event
         {
@@ -36,19 +36,19 @@ namespace Tizen.Applications
             FeedMouseUp,
 
             /// <summary>
-            /// Type for cancelling click event procedure.
+            /// Type for canceling the click event procedure.
             /// </summary>
             CancelClick
         }
 
         /// <summary>
-        /// Layout object including preview image, overlay text, loading text and remote screen image.
+        /// Layout object including preview image, overlay text, loading text, and remote screen image.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
         public Layout Layout { get; internal set; }
 
         /// <summary>
-        /// Widget ID.
+        /// The widget ID.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
         public string Id
@@ -62,7 +62,7 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Update period.
+        /// The update period.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
         public double Period
@@ -74,10 +74,10 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Contents of widget.
+        /// Contents of the widget.
         /// </summary>
         /// <remarks>
-        /// This string can be used for creating contents of widget again after rebooting a device or it can be recovered from crash(abnormal status).
+        /// This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status).
         /// </remarks>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
         public string Content
@@ -133,24 +133,24 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Pauses all connected widget applications.
+        /// Pauses all the connected widget applications.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public static void PauseAll()
         {
             CheckException(Interop.WidgetViewerEvas.NotifyPausedStatusOfViewer());
         }
 
         /// <summary>
-        /// Resumes all connected widget applications.
+        /// Resumes all the connected widget applications.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device<./exception>
         public static void ResumeAll()
         {
             CheckException(Interop.WidgetViewerEvas.NotifyResumedStatusOfViewer());
@@ -160,9 +160,9 @@ namespace Tizen.Applications
         /// Pauses the widget application which is connected on this proxy.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public void Pause()
         {
             CheckException(Interop.WidgetViewerEvas.PauseWidget(Layout));
@@ -172,20 +172,20 @@ namespace Tizen.Applications
         /// Resumes the widget application which is connected on this proxy.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public void Resume()
         {
             CheckException(Interop.WidgetViewerEvas.ResumeWidget(Layout));
         }
 
         /// <summary>
-        /// Sends event to the widget application which is connected on this proxy.
+        /// Sends the event to the widget application which is connected on this proxy.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public void SendEvent(Event ev)
         {
             switch (ev)
diff --git a/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs b/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs
index 989c797..0820a5e 100755
--- a/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs
+++ b/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs
@@ -20,7 +20,7 @@ using System;
 namespace Tizen.Applications
 {
     /// <summary>
-    /// Represents a factory class for making RemoveView objects.
+    /// Represents a factory class for making the RemoteView objects.
     /// </summary>
     public static class RemoteViewFactory
     {
@@ -33,9 +33,9 @@ namespace Tizen.Applications
         /// All the remote views will be located in the specified window object.
         /// </param>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public static void Init(EvasObject win)
         {
             if (_ready)
@@ -45,20 +45,20 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Creates RemoteView object.
+        /// Creates a RemoteView object.
         /// </summary>
-        /// <param name="parent">Parent object</param>
-        /// <param name="widgetId">Widget ID</param>
-        /// <param name="content">Contents that will be given to the widget instance</param>
-        /// <param name="period">Update period</param>
-        /// <param name="previewImage">True if you want to show preview image</param>
-        /// <param name="overlayText">True if you want to show overlay text</param>
-        /// <param name="loadingMessage">True if you want to show loading message</param>
+        /// <param name="parent">Parent object.</param>
+        /// <param name="widgetId">Widget ID.</param>
+        /// <param name="content">Contents that will be given to the widget instance.</param>
+        /// <param name="period">Update period.</param>
+        /// <param name="previewImage">True if you want to show the preview image.</param>
+        /// <param name="overlayText">True if you want to show the overlay text.</param>
+        /// <param name="loadingMessage">True if you want to show the loading message.</param>
         /// <returns>RemoteView object.</returns>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public static RemoteView Create(EvasObject parent, string widgetId, string content, double period,
             bool previewImage = true, bool overlayText = true, bool loadingMessage = true)
         {
@@ -83,12 +83,12 @@ namespace Tizen.Applications
         }
 
         /// <summary>
-        /// Finalizes RemoteViewFactory.
+        /// Finalizes the RemoteViewFactory.
         /// </summary>
         /// <privilege>http://tizen.org/privilege/widget.viewer</privilege>
-        /// <exception cref="InvalidOperationException">Thrown when this operation failed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when this operation was denied</exception>
-        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device</exception>
+        /// <exception cref="InvalidOperationException">Thrown when this operation failed.</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when this operation is denied.</exception>
+        /// <exception cref="NotSupportedException">Thrown when this operation is not supported for this device.</exception>
         public static void Shutdown()
         {
             if (!_ready)