From d247e802c417d804e2fae6534a8167ec225f9b68 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Shubham=20Gupta/SNAP=20/SRI-Bangalore/Engineer/=EC=82=BC?= =?utf8?q?=EC=84=B1=EC=A0=84=EC=9E=90?= Date: Mon, 17 Dec 2018 07:09:46 +0530 Subject: [PATCH] Realignment of doxygen comments in various CL Host files (#4052) In order to have uniformity and similarity to ACL and NeuralNetworks.h's style of doxygen comments, this patch realigns the comments. Signed-off-by: shubham --- .../core/CL/kernels/CLBinaryLogicalOpKernel.h | 10 +++++----- .../core/CL/kernels/CLComparisonOpKernel.h | 10 +++++----- .../arm_compute/core/CL/kernels/CLEqualKernel.h | 10 +++++----- .../arm_compute/core/CL/kernels/CLNotEqualKernel.h | 19 ++++++++++--------- .../arm_compute/core/CL/kernels/CLPReLUKernel.h | 10 +++++----- .../runtime/CL/functions/CLBinaryLogicalOp.h | 1 - .../arm_compute/runtime/CL/functions/CLComparisonOp.h | 1 - .../arm_compute/runtime/CL/functions/CLEqual.h | 1 - .../arm_compute/runtime/CL/functions/CLNotEqual.h | 1 - .../arm_compute/runtime/CL/functions/CLPReLU.h | 1 - .../runtime/CL/functions/CLSquaredDifference.h | 1 - 11 files changed, 30 insertions(+), 35 deletions(-) diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLBinaryLogicalOpKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLBinaryLogicalOpKernel.h index 4c43b66..f3869a8 100644 --- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLBinaryLogicalOpKernel.h +++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLBinaryLogicalOpKernel.h @@ -39,11 +39,11 @@ public: /** Allow instances of this class to be moved */ CLBinaryLogicalOpKernel &operator=(CLBinaryLogicalOpKernel &&) = default; /** Initialize the kernel's input, output. - * - * @param[in] input1 Source tensor1. - * @param[in] input2 Source tensor2. - * @param[out] output Output tensor. - */ + * + * @param[in] input1 Source tensor1. + * @param[in] input2 Source tensor2. + * @param[out] output Output tensor. + */ void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, LogicalOperation op); diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLComparisonOpKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLComparisonOpKernel.h index 71a4cc3..f5f4559 100644 --- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLComparisonOpKernel.h +++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLComparisonOpKernel.h @@ -39,11 +39,11 @@ public: /** Allow instances of this class to be moved */ CLComparisonOpKernel &operator=(CLComparisonOpKernel &&) = default; /** Initialize the kernel's input, output. - * - * @param[in] input1 Source tensor1. - * @param[in] input2 Source tensor2. - * @param[out] output Output tensor. - */ + * + * @param[in] input1 Source tensor1. + * @param[in] input2 Source tensor2. + * @param[out] output Output tensor. + */ void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, const ComparisonOperation &op); diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLEqualKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLEqualKernel.h index 847beec..f6b6623 100644 --- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLEqualKernel.h +++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLEqualKernel.h @@ -38,11 +38,11 @@ public: /** Allow instances of this class to be moved */ CLEqualKernel &operator=(CLEqualKernel &&) = default; /** Initialize the kernel's input, output. - * - * @param[in] input1 Source tensor1. - * @param[in] input2 Source tensor2. - * @param[out] output Output tensor. - */ + * + * @param[in] input1 Source tensor1. + * @param[in] input2 Source tensor2. + * @param[out] output Output tensor. + */ void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output); // Inherited methods overridden: diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLNotEqualKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLNotEqualKernel.h index 20a7a07..383dee8 100644 --- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLNotEqualKernel.h +++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLNotEqualKernel.h @@ -38,15 +38,16 @@ public: /** Allow instances of this class to be moved */ CLNotEqualKernel &operator=(CLNotEqualKernel &&) = default; /** Initialize the kernel's input, output. - * - * @param[in] input1 Source tensor 1. - Data types supported: U8/S8/U16/S16/U32/S32/F16/F32 - * @param[in] input2 Source tensor 2. - Data types supported: U8/S8/U16/S16/U32/S32/F16/F32 - * @param[out] output Output tensor. - A boolean tensor indicating the truth value of non-equality of input tensors. - Data types supported: U8. - */ + * + * @param[in] input1 Source tensor 1. + Data types supported: U8/S8/U16/S16/U32/S32/F16/F32 + * @param[in] input2 Source tensor 2. + Data types supported: U8/S8/U16/S16/U32/S32/F16/F32 + * @param[out] output Output tensor. + A boolean tensor indicating the truth value of non-equality of input + tensors. + Data types supported: U8. + */ void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output); // Inherited methods overridden: diff --git a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLPReLUKernel.h b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLPReLUKernel.h index 21d966b..eff1b8b 100644 --- a/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLPReLUKernel.h +++ b/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLPReLUKernel.h @@ -38,11 +38,11 @@ public: /** Allow instances of this class to be moved */ CLPReLUKernel &operator=(CLPReLUKernel &&) = default; /** Initialize the kernel's input, output. - * - * @param[in] input Source tensor1. - * @param[in] alpha Source tensor2. - * @param[out] output Output tensor. - */ + * + * @param[in] input Source tensor1. + * @param[in] alpha Source tensor2. + * @param[out] output Output tensor. + */ void configure(const ICLTensor *input, const ICLTensor *alpha, ICLTensor *output); // Inherited methods overridden: diff --git a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLBinaryLogicalOp.h b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLBinaryLogicalOp.h index dc84b9c..c9a89dd 100644 --- a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLBinaryLogicalOp.h +++ b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLBinaryLogicalOp.h @@ -32,7 +32,6 @@ public: * @param[in] input1 Source tensor1. Data types supported: U8, QASYMM8. * @param[in] input2 Source tensor2. Data types supported: U8 QASYMM8. * @param[out] output Output tensor. Data types supported: U8, QASYMM8. - * */ void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, LogicalOperation op); }; diff --git a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLComparisonOp.h b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLComparisonOp.h index 1df7064..1b0d70e 100644 --- a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLComparisonOp.h +++ b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLComparisonOp.h @@ -34,7 +34,6 @@ public: * @param[in] input2 Source tensor2. Data types supported: * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32. * @param[out] output Output tensor. Data types supported: Same as @p input. - * */ void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, const ComparisonOperation &op); diff --git a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLEqual.h b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLEqual.h index 047fb80..1f772d1 100644 --- a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLEqual.h +++ b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLEqual.h @@ -33,7 +33,6 @@ public: * @param[in] input2 Source tensor2. Data types supported: * U8/S8/QS8/QASYMM8/U16/S16/QS16/F16/U32/S32/F32. * @param[out] output Output tensor. Data types supported: Same as @p input. - * */ void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output); }; diff --git a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLNotEqual.h b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLNotEqual.h index 4086505..019db54 100644 --- a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLNotEqual.h +++ b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLNotEqual.h @@ -34,7 +34,6 @@ public: * U8/S8/U16/S16/U32/S32/F16/F32. * @param[out] output Output tensor. Data types supported: * Data types supported: U8. - * */ void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output); }; diff --git a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLPReLU.h b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLPReLU.h index ef59fd7..622a61b 100644 --- a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLPReLU.h +++ b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLPReLU.h @@ -33,7 +33,6 @@ public: * @param[in] alpha. Data types supported: * QASYMM8/F16/F32. * @param[out] output Output tensor. Data types supported: Same as @p input. - * */ void configure(ICLTensor *input, ICLTensor *alpha, ICLTensor *output); }; diff --git a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLSquaredDifference.h b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLSquaredDifference.h index 05a01a3..92cee07 100644 --- a/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLSquaredDifference.h +++ b/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLSquaredDifference.h @@ -33,7 +33,6 @@ public: * @param[in] input2 Source tensor2. Data types supported: * U8/S8/QS8/QASYMM8/U16/S16/QS16/F16/U32/S32/F32. * @param[out] output Output tensor. Data types supported: Same as @p input. - * */ void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output); }; -- 2.7.4