Add more description for selection APIs
authorBowon Ryu <bowon.ryu@samsung.com>
Fri, 8 Oct 2021 04:57:36 +0000 (13:57 +0900)
committerhuiyu <35286162+huiyueun@users.noreply.github.com>
Mon, 29 Nov 2021 08:55:55 +0000 (17:55 +0900)
Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>
src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
src/Tizen.NUI/src/public/BaseComponents/TextField.cs

index 37986b8..7b3e7bb 100755 (executable)
@@ -1348,8 +1348,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
         {
@@ -1402,6 +1405,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
         {
@@ -1416,6 +1422,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
         {
@@ -2049,10 +2058,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)
         {
@@ -2066,7 +2078,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()
index df0162d..df0067c 100755 (executable)
@@ -1598,8 +1598,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
         {
@@ -1614,6 +1617,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
         {
@@ -1628,6 +1634,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
         {
@@ -2109,10 +2118,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)
         {
@@ -2126,7 +2138,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()