[NUI] Add descriptions of Accessibility Interfaces

[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Accessibility / IAtspiSelection.cs

diff --git a/src/Tizen.NUI/src/public/Accessibility/IAtspiSelection.cs b/src/Tizen.NUI/src/public/Accessibility/IAtspiSelection.cs
index 2e57407..38f1a66 100644 (file)
--- a/src/Tizen.NUI/src/public/Accessibility/IAtspiSelection.cs
+++ b/src/Tizen.NUI/src/public/Accessibility/IAtspiSelection.cs
@@ -1,5 +1,5 @@
 /*
- * Copyright(c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright(c) 2023 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,30 +21,73 @@ using Tizen.NUI.BaseComponents;
 
 namespace Tizen.NUI.Accessibility
 {
+    /// <summary>
+    /// Interface representing objects which can store a set of selected items.
+    /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public interface IAtspiSelection
     {
+        /// <summary>
+        /// Gets the number of selected children.
+        /// </summary>
+        /// <returns> The number of selected children (zero if none) </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         int AccessibilityGetSelectedChildrenCount();
 
+        /// <summary>
+        /// Gets a specific selected child.
+        /// </summary>
+        /// <remarks>
+        /// <c>selectedChildIndex</c> refers to the list of selected children, not the list of all children.
+        /// </remarks>
+        /// <param name="selectedChildIndex"> The index of the selected child </param>
+        /// <returns> The selected child or nullptr if index is invalid </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         View AccessibilityGetSelectedChild(int selectedChildIndex);
 
+        /// <summary>
+        /// Selects a child.
+        /// </summary>
+        /// <param name="childIndex"> The index of the child </param>
+        /// <returns> True on success, false otherwise </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         bool AccessibilitySelectChild(int childIndex);
 
+        /// <summary>
+        /// Deselects a selected child.
+        /// </summary>
+        /// <param name="selectedChildIndex"> The index of the selected child </param>
+        /// <returns> True on success, false otherwise </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         bool AccessibilityDeselectSelectedChild(int selectedChildIndex);
 
+        /// <summary>
+        /// Checks whether a child is selected.
+        /// </summary>
+        /// <param name="childIndex"> The index of the child </param>
+        /// <returns>< True if given child is selected, false otherwise /returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         bool AccessibilityIsChildSelected(int childIndex);
 
+        /// <summary>
+        /// Selects all children.
+        /// </summary>
+        /// <returns> True on success, false otherwise </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         bool AccessibilitySelectAll();
 
+        /// <summary>
+        /// Deselects all children.
+        /// </summary>
+        /// <returns> True on success, false otherwise </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         bool AccessibilityClearSelection();
 
+        /// <summary>
+        /// Deselects a child.
+        /// </summary>
+        /// <param name="childIndex"> The index of the child. </param>
+        /// <returns> True on success, false otherwise </returns>
         [EditorBrowsable(EditorBrowsableState.Never)]
         bool AccessibilityDeselectChild(int childIndex);
     }