Imported Upstream version 0.3upstream/0.3

1 files changed, 47 insertions, 14 deletions

diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLGatherKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLGatherKernel.h
index a51441aca..7e35a80b0 100644
--- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLGatherKernel.h
+++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLGatherKernel.h
@@ -14,52 +14,85 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/**
+ * @file      CLGatherKernel.h
+ * @ingroup   COM_AI_RUNTIME
+ * @brief     This file defines CLGatherKernel class
+ */
+
 #ifndef __ARM_COMPUTE_CLGATHERKERNEL_H__
 #define __ARM_COMPUTE_CLGATHERKERNEL_H__
 
 #include "arm_compute/core/CL/ICLKernel.h"
-#include "arm_compute/core/Types.h"
 
 namespace arm_compute
 {
 class ICLTensor;
 
-/** Interface for the gather kernel.
- *
+/**
+ * @brief Class to define an interface for the gather kernel.
  */
 class CLGatherKernel : public ICLKernel
 {
 public:
-  /** Default constructor.*/
+  /**
+   * @brief Construct CLGatherKernel object
+   * */
   CLGatherKernel();
-  /** Prevent instances of this class from being copied (As this class contains pointers). */
+
+  /**
+   * @brief Prevent instances of this class from being copied (As this class contains pointers).
+   */
   CLGatherKernel(const CLGatherKernel &) = delete;
-  /** Prevent instances of this class from being copied (As this class contains pointers). */
+
+  /**
+   * @brief Prevent instances of this class from being copied (As this class contains pointers).
+   */
   CLGatherKernel &operator=(const CLGatherKernel &) = delete;
-  /** Allow instances of this class to be moved */
+
+  /**
+   * @brief Construct CLGatherKernel object by using default move constructor
+   * @param[in] CLGatherKernel object to move
+   */
   CLGatherKernel(CLGatherKernel &&) = default;
-  /** Allow instances of this class to be moved */
+
+  /**
+   * @brief Move assignment operator
+   * @param[in] CLGatherKernel object to move
+   */
   CLGatherKernel &operator=(CLGatherKernel &&) = default;
-  /** Initialise the kernel's input, output and border mode.
-   *
+
+  /**
+   * @brief Initialise the kernel's input, output and border mode.
    * @param[in]  input1          An input tensor. Data types supported: U8/S32/F32.
    * @param[in]  input2          An input tensor. Data types supported: S32.
    * @param[out] output          The output tensor, Data types supported: same as @p input1.
+   * @return N/A
    */
   void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output);
-  /** Static function to check if given info will lead to a valid configuration of @ref
+
+  /**
+   * @brief Static function to check if given info will lead to a valid configuration of @ref
    * CLGatherKernel
-   *
    * @param[in]  input1          An input tensor. Data types supported: U8/S32/F32.
    * @param[in]  input2          An input tensor. Data types supported: S32.
    * @param[out] output          The output tensor, Data types supported: same as @p input1.
-   *
    * @return a status
    */
   static Status validate(const ITensorInfo *input1, const ITensorInfo *input2,
                          const ITensorInfo *output);
 
-  // Inherited methods overridden:
+  /**
+   * @brief Enqueue the OpenCL kernel to process the given window on the passed OpenCL command
+   *        queue.
+   * @note  The queue is *not* flushed by this method, and therefore the kernel will not have
+   *        been executed by the time this method returns.
+   * @param[in] window      Region on which to execute the kernel. (Must be a valid region of
+   *                        the window returned by window()).
+   * @param[in,out] queue   Command queue on which to enqueue the kernel.@return N/A
+   * @return N/A
+   */
   void run(const Window &window, cl::CommandQueue &queue) override;
 
 private: