From: Hyunho Kang <hhstark.kang@samsung.com>
Date: Tue, 18 Jun 2019 00:27:04 +0000 (+0900)
Subject: [WatchfaceComplication] Fix ambiguous doxygen sentences (#855)
X-Git-Tag: submit/tizen/20190618.101741~1^2~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=84d44be3f1752fbe3a5811d58a1f6726b062fc74;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[WatchfaceComplication] Fix ambiguous doxygen sentences (#855)

Signed-off-by: hyunho <hhstark.kang@samsung.com>
---

diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Complication.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Complication.cs
index 27f00d676..eb7be0f47 100644
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Complication.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Complication.cs
@@ -22,7 +22,7 @@ using System.Linq;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the Complication class for the watch application which using watchface complication.
+    /// Represents the complication for a watch application.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public abstract class Complication : IEditable, IDisposable
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProvider.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProvider.cs
index 86ff96c95..ba9b070f4 100644
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProvider.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProvider.cs
@@ -22,7 +22,7 @@ using static Interop.WatchfaceComplication;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the ComplicationProvider class for the complication provider service application.
+    /// Represents the complication provider for a service application.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public abstract class ComplicationProvider : IDisposable
@@ -33,7 +33,7 @@ namespace Tizen.Applications.WatchfaceComplication
         private readonly UpdateRequestedCallback _updatedCallback;
 
         /// <summary>
-        /// Initializes the ComplicationProvider class.
+        /// Initializes a new instance of the ComplicationProvider class.
         /// </summary>
         /// <param name="providerId">The id of the complication provider.</param>
         /// <privilege>http://tizen.org/privilege/datasharing</privilege>
@@ -101,9 +101,9 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Overrides this method to handle the behavior when the complication data update request event comes from watchface complication.
+        /// Overrides this method to handle the behavior when the event for requesting the update of complication data comes from watchface complication.
         /// </summary>
-        /// <param name="reqestAppId">The application ID of application which sent update request.</param>
+        /// <param name="reqestAppId">The ID of application which sent update request.</param>
         /// <param name="type">The requested type.</param>
         /// <param name="contextData">The complication's context which is set by complication setup application.</param>
         /// <returns>The requested ComplicationData</returns>
@@ -127,7 +127,7 @@ namespace Tizen.Applications.WatchfaceComplication
         /// <summary>
         /// Gets the received event type.
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <exception cref="ArgumentException">Thrown when the invalid parameter is passed.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
@@ -156,9 +156,9 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Gets the received event target provider ID.
+        /// Gets the provider ID of appcontrol that raises the event.
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
@@ -183,9 +183,9 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Gets the received event target complication type.
+        /// Gets the complication type of the received appcontrol.
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
@@ -210,9 +210,9 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Gets the received event target complication context.
+        /// Gets the complication context of appcontrol that raises the event.
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
@@ -242,7 +242,7 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Releases the unmanaged resources used by the ComplicationProvider class specifying whether to perform a normal dispose operation.
+        /// Releases the unmanaged resources used by the ComplicationProvider instance specifying whether to perform a normal dispose operation.
         /// </summary>
         /// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
         /// <since_tizen> 3 </since_tizen>
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProviderSetup.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProviderSetup.cs
index 95cb240b6..2a1b7764b 100644
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProviderSetup.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ComplicationProviderSetup.cs
@@ -21,15 +21,15 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the ComplicationProviderSetup class for the complication provider setup application.
+    /// Represents the complication setup for a setup application.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public static class ComplicationProviderSetup
     {
         /// <summary>
-        /// Gets the received appctrl containing inforamtion about edit.
+        /// Gets the received appcontrol containing information about edit.
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
@@ -59,7 +59,7 @@ namespace Tizen.Applications.WatchfaceComplication
         /// <summary>
         /// Replies the setup context to the editor
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <param name="context">The context created by complication setup app.</param>
         /// <privilege>http://tizen.org/privilege/datasharing</privilege>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
@@ -92,7 +92,7 @@ namespace Tizen.Applications.WatchfaceComplication
         /// <summary>
         /// Gets complication's setup context.
         /// </summary>
-        /// <param name="recvAppCtrl">The appcontrol received event args.</param>
+        /// <param name="recvAppCtrl">The received appcontrol.</param>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/DesignElement.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/DesignElement.cs
index 2cc26e05c..1daaa5a46 100755
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/DesignElement.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/DesignElement.cs
@@ -21,7 +21,7 @@ using System.Linq;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the DesignElement class for the watch application.
+    /// Represents the design element for a watch application.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public abstract class DesignElement : IEditable
@@ -34,10 +34,10 @@ namespace Tizen.Applications.WatchfaceComplication
         private int _editableId;
 
         /// <summary>
-        /// Initializes the DesignElement class.
+        /// Initializes a new instance of the DesignElement class.
         /// </summary>
         /// <param name="candidates">The candidates list.</param>
-        /// <param name="currentDataIndex">The currently selected data index of candidate list.</param>
+        /// <param name="currentDataIndex">The index of selected data among candidate list.</param>
         /// <param name="editableName">The design element name.</param>
         /// <exception cref="ArgumentException">Thrown when e is invalid.</exception>
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
@@ -174,7 +174,7 @@ namespace Tizen.Applications.WatchfaceComplication
         /// <summary>
         /// Gets the editable's currently selected data index of candidate list.
         /// </summary>
-        /// <returns>The currently selected data index of candidate list.</returns>
+        /// <returns>The index of selected data among candidate list.</returns>
         /// <since_tizen> 6 </since_tizen>
         int IEditable.GetCurrentDataIndex()
         {
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/EditablesContainer.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/EditablesContainer.cs
index 336d9271a..7a6c984bd 100644
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/EditablesContainer.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/EditablesContainer.cs
@@ -20,7 +20,7 @@ using System.Collections.Generic;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the EditablesContainer class for the watch application.
+    /// Represents the editables container for a watch application.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public abstract class EditablesContainer : IDisposable
@@ -162,10 +162,10 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Checks the editable with editableId is already exists in edit list.
+        /// Checks whether editableId already exists in edit list.
         /// </summary>
         /// <param name="editableId">The target editable Id.</param>
-        /// <returns>true if the editable is already exists in edit list, otherwise false</returns>
+        /// <returns>true if the editable already exists in edit list, otherwise false</returns>
         /// <since_tizen> 6 </since_tizen>
         public bool IsExist(int editableId)
         {
@@ -282,7 +282,7 @@ namespace Tizen.Applications.WatchfaceComplication
         /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the watchface complication is not supported.</exception>
         /// <remarks>
-        /// This API loads editable's last current data which is updated by editor application.
+        /// This method loads the last editable data which is updated by editor application.
         /// </remarks>
         /// <param name="editableId">The id of the editable.</param>
         /// <example>
@@ -324,7 +324,7 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Releases the unmanaged resources used by the EditablesContainer class specifying whether to perform a normal dispose operation.
+        /// Releases the unmanaged resources used by the EditablesContainer class specifying whether or not to perform a normal dispose operation.
         /// </summary>
         /// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
         /// <since_tizen> 3 </since_tizen>
@@ -338,7 +338,7 @@ namespace Tizen.Applications.WatchfaceComplication
         }
 
         /// <summary>
-        /// Releases all resources used by the EditablesContainer class.
+        /// Releases all resources used by the EditablesContainer instance.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public void Dispose()
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Highlight.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Highlight.cs
index c82279e6a..7b1d6006b 100755
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Highlight.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/Highlight.cs
@@ -21,7 +21,7 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the Highlight class for the editable.
+    /// Represents the highlight data for an editable.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class Highlight
@@ -34,7 +34,7 @@ namespace Tizen.Applications.WatchfaceComplication
         private ShapeType _type;
 
         /// <summary>
-        /// Initializes the Highlight class.
+        /// Initializes a new instance of the Highlight class.
         /// </summary>
         /// <param name="type">The highlight shape type.</param>
         /// <param name="x">The highlight geometry x.</param>
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/IconData.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/IconData.cs
index 88fa87277..c28284685 100755
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/IconData.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/IconData.cs
@@ -5,7 +5,7 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the IconData class for the Icon type complication.
+    /// Represents the icon data for a complication.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class IconData : ComplicationData
@@ -21,7 +21,7 @@ namespace Tizen.Applications.WatchfaceComplication
         ///     protected override ComplicationData OnDataUpdateRequested(string reqestAppId, ComplicationTypes type, Bundle contextData)
         ///     {
         ///         if (type == ComplicationTypes.Icon)
-        ///         {                
+        ///         {
         ///             return new IconData("Icon", "extra");
         ///         }
         ///         else if (type == ComplicationTypes.LongText)
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ImageData.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ImageData.cs
index fe14f6cdc..19496d9a1 100644
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ImageData.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ImageData.cs
@@ -21,7 +21,7 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the ImageData class for the Image type complication.
+    /// Represents the image data for a complication.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class ImageData : ComplicationData
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/LongTextData.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/LongTextData.cs
index cd46d52ef..10a9b4dc2 100755
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/LongTextData.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/LongTextData.cs
@@ -21,7 +21,7 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the LongTextData class for the LongText type complication.
+    /// Represents the long text data for a complication.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class LongTextData : ComplicationData
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/RangedValueData.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/RangedValueData.cs
index 2b446a393..ce9a60227 100644
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/RangedValueData.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/RangedValueData.cs
@@ -21,7 +21,7 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the RangedValueData class for the RangedValue type complication.
+    /// Represents the ranged value data for a complication.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class RangedValueData : ComplicationData
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ShortTextData.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ShortTextData.cs
index 1d3494603..1e69e65c2 100755
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ShortTextData.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ShortTextData.cs
@@ -21,13 +21,13 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the ShortTextData class for the ShortText type complication.
+    /// Represents the short text data for a complication.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class ShortTextData : ComplicationData
     {
         /// <summary>
-        /// Initializes the ShortTextData class.
+        /// Initializes a new instance of the ShortTextData class.
         /// </summary>
         /// <param name="shortText">The short text.</param>
         /// <param name="iconPath">The icon path.</param>
diff --git a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/TimeData.cs b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/TimeData.cs
index 0c1cbff3b..c7776047e 100755
--- a/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/TimeData.cs
+++ b/src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/TimeData.cs
@@ -21,7 +21,7 @@ using System.Text;
 namespace Tizen.Applications.WatchfaceComplication
 {
     /// <summary>
-    /// Represents the TimeData class for the Time type complication.
+    /// Represents the time data for a complication.
     /// </summary>
     /// <since_tizen> 6 </since_tizen>
     public class TimeData : ComplicationData