From aa79405dd93e44ca7e8af5f3baf3e076399d0136 Mon Sep 17 00:00:00 2001 From: Viet-Hoa Do Date: Mon, 23 May 2022 16:47:42 +0100 Subject: Fix doxygen typos Change-Id: Ia54918091e985e21641610ca7652aead7c0dd20a Signed-off-by: Viet-Hoa Do Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/7621 Tested-by: Arm Jenkins Reviewed-by: Pablo Marquez Tello --- arm_compute/core/CL/CLTypes.h | 4 ++-- arm_compute/core/CPP/ICPPKernel.h | 4 ++-- docs/contributor_guide/contribution_guidelines.dox | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/arm_compute/core/CL/CLTypes.h b/arm_compute/core/CL/CLTypes.h index ede8d0a9e4..86335dae67 100644 --- a/arm_compute/core/CL/CLTypes.h +++ b/arm_compute/core/CL/CLTypes.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2021 Arm Limited. + * Copyright (c) 2017-2022 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -81,7 +81,7 @@ enum CLKernelType UNKNOWN, /**< Unknown CL kernel type */ DEPTHWISE, /**< Depthwise CL kernel type */ DIRECT, /**< Direct Convolution CL kernel type */ - ELEMENTWISE, /**< Elementeise CL kernel type */ + ELEMENTWISE, /**< Elementwise CL kernel type */ GEMM, /**< GEMM CL kernel type */ POOL, /**< Pool CL kernel type */ WINOGRAD /**< Winograd CL kernel type */ diff --git a/arm_compute/core/CPP/ICPPKernel.h b/arm_compute/core/CPP/ICPPKernel.h index 4697316379..00a10555e3 100644 --- a/arm_compute/core/CPP/ICPPKernel.h +++ b/arm_compute/core/CPP/ICPPKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016-2021 Arm Limited. + * Copyright (c) 2016-2022 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -95,7 +95,7 @@ public: * @param[in] platform The CPU platform used to create the context. * @param[in] thread_count Number of threads in the execution. * - * @return[out] mws Minimum workload size for requsted configuration. + * @return Minimum workload size for requested configuration. */ virtual size_t get_mws(const CPUInfo &platform, size_t thread_count) const { diff --git a/docs/contributor_guide/contribution_guidelines.dox b/docs/contributor_guide/contribution_guidelines.dox index 02d8495fc5..f26a709897 100644 --- a/docs/contributor_guide/contribution_guidelines.dox +++ b/docs/contributor_guide/contribution_guidelines.dox @@ -272,7 +272,7 @@ auto d = vdup_n_u8(0); // NO: It's not obvious what type this function returns. - No '*' in front of argument names - [in], [out] or [in,out] *in front* of arguments - - Skip a line between the description and params and between params and @return (If there is a return) + - Skip a line between the description and params and between params and \@return (If there is a return) - Align params names and params descriptions (Using spaces), and with a single space between the widest column and the next one. - Use an upper case at the beginning of the description -- cgit v1.2.1