From: Bowon Ryu <bowon.ryu@samsung.com>
Date: Fri, 8 Oct 2021 04:57:36 +0000 (+0900)
Subject: [NUI] Add more description for selection APIs
X-Git-Tag: submit/tizen_6.5/20220614.151059~1^2~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=163d8156dc99b571242d87dcf63e772e4a91bb21;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[NUI] Add more description for selection APIs

Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>
---

diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
index 2f0d70a..6873541 100755
--- a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
+++ b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
@@ -1329,8 +1329,11 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// The Selected Text property (read-only).
+        /// The portion of the text that has been selected by the user.
         /// </summary>
+        /// <remarks>
+        /// Empty string when nothing is selected.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public string SelectedText
         {
@@ -1383,6 +1386,9 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The start index for selection.
         /// </summary>
+        /// <remarks>
+        /// When there is no selection, the index is current cursor position.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public int SelectedTextStart
         {
@@ -1397,6 +1403,9 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The end index for selection.
         /// </summary>
+        /// <remarks>
+        /// When there is no selection, the index is current cursor position.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public int SelectedTextEnd
         {
@@ -1960,10 +1969,13 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Select text from start to end index. <br />
-        /// The index is valid when 0 or positive. <br />
+        /// The index is valid when 0 or positive.
         /// </summary>
         /// <param name="start">The start index for selection.</param>
         /// <param name="end">The end index for selection.</param>
+        /// <remarks>
+        /// If the end index exceeds the maximum value, it is set to the length of the text.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public void SelectText(int start, int end)
         {
@@ -1977,7 +1989,8 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// Clear selection of the text.
+        /// Clear selection of the text. <br />
+        /// Valid when selection is activate.
         /// </summary>
         /// <since_tizen> 9 </since_tizen>
         public void SelectNone()
diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextField.cs b/src/Tizen.NUI/src/public/BaseComponents/TextField.cs
index f37730f..1d4d1ae 100755
--- a/src/Tizen.NUI/src/public/BaseComponents/TextField.cs
+++ b/src/Tizen.NUI/src/public/BaseComponents/TextField.cs
@@ -1581,8 +1581,11 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// The Selected Text property.
+        /// The portion of the text that has been selected by the user.
         /// </summary>
+        /// <remarks>
+        /// Empty string when nothing is selected.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public string SelectedText
         {
@@ -1597,6 +1600,9 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The start index for selection.
         /// </summary>
+        /// <remarks>
+        /// When there is no selection, the index is current cursor position.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public int SelectedTextStart
         {
@@ -1611,6 +1617,9 @@ namespace Tizen.NUI.BaseComponents
         /// <summary>
         /// The end index for selection.
         /// </summary>
+        /// <remarks>
+        /// When there is no selection, the index is current cursor position.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public int SelectedTextEnd
         {
@@ -2046,10 +2055,13 @@ namespace Tizen.NUI.BaseComponents
 
         /// <summary>
         /// Select text from start to end index. <br />
-        /// The index is valid when 0 or positive. <br />
+        /// The index is valid when 0 or positive.
         /// </summary>
         /// <param name="start">The start index for selection.</param>
         /// <param name="end">The end index for selection.</param>
+        /// <remarks>
+        /// If the end index exceeds the maximum value, it is set to the length of the text.
+        /// </remarks>
         /// <since_tizen> 9 </since_tizen>
         public void SelectText(int start, int end)
         {
@@ -2063,7 +2075,8 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// Clear selection of the text.
+        /// Clear selection of the text. <br />
+        /// Valid when selection is activate.
         /// </summary>
         /// <since_tizen> 9 </since_tizen>
         public void SelectNone()