aboutsummaryrefslogtreecommitdiff
path: root/arm_compute
diff options
context:
space:
mode:
authorramy.elgammal@arm.com <ramy.elgammal@arm.com>2023-06-16 20:45:48 +0100
committerRamy Elgammal <ramy.elgammal@arm.com>2023-06-23 11:43:38 +0000
commita2561f0ff2bdd3fd7d968a56a19c35a59804b992 (patch)
tree31598c3cd8a52f5ee57ada627b5425acb6fbad06 /arm_compute
parent90d15b985dbefd730941cbc79997baa0089dc4f3 (diff)
downloadComputeLibrary-a2561f0ff2bdd3fd7d968a56a19c35a59804b992.tar.gz
Fix doxygen warnings
Resolves: COMPMID-6312 Signed-off-by: ramy.elgammal@arm.com <ramy.elgammal@arm.com> Change-Id: I9f68ccd2edb8c4d03fec19e6b9c29609d4833342 Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/9806 Tested-by: Arm Jenkins <bsgcomp@arm.com> Reviewed-by: Gunes Bayir <gunes.bayir@arm.com> Comments-Addressed: Arm Jenkins <bsgcomp@arm.com> Benchmark: Arm Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'arm_compute')
-rw-r--r--arm_compute/core/CL/ICLArray.h4
-rw-r--r--arm_compute/core/CL/ICLTensor.h4
-rw-r--r--arm_compute/core/Types.h6
-rw-r--r--arm_compute/core/utils/quantization/AsymmHelpers.h2
-rw-r--r--arm_compute/runtime/CL/functions/CLConvertFullyConnectedWeights.h6
5 files changed, 6 insertions, 16 deletions
diff --git a/arm_compute/core/CL/ICLArray.h b/arm_compute/core/CL/ICLArray.h
index b900117724..57f842b6f9 100644
--- a/arm_compute/core/CL/ICLArray.h
+++ b/arm_compute/core/CL/ICLArray.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2016-2021 Arm Limited.
+ * Copyright (c) 2016-2021, 2023 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
@@ -66,8 +66,6 @@ public:
* @param[in] blocking If true, then the mapping will be ready to use by the time
* this method returns, else it is the caller's responsibility
* to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.
- *
- * @return The mapping address.
*/
void map(cl::CommandQueue &q, bool blocking = true)
{
diff --git a/arm_compute/core/CL/ICLTensor.h b/arm_compute/core/CL/ICLTensor.h
index fd05e64732..78d3757e59 100644
--- a/arm_compute/core/CL/ICLTensor.h
+++ b/arm_compute/core/CL/ICLTensor.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2016-2019 Arm Limited.
+ * Copyright (c) 2016-2019, 2023 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
@@ -71,8 +71,6 @@ public:
* @param[in] blocking If true, then the mapping will be ready to use by the time
* this method returns, else it is the caller's responsibility
* to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.
- *
- * @return The mapping address.
*/
void map(cl::CommandQueue &q, bool blocking = true);
/** Enqueue an unmap operation of the allocated and mapped buffer on the given queue.
diff --git a/arm_compute/core/Types.h b/arm_compute/core/Types.h
index 8c971d77da..d9c89f8779 100644
--- a/arm_compute/core/Types.h
+++ b/arm_compute/core/Types.h
@@ -697,7 +697,7 @@ public:
* @param[in] stride_y (Optional) Stride, in elements, across y. Defaults to 1.
* @param[in] pad_x (Optional) Padding, in elements, across x. Defaults to 0.
* @param[in] pad_y (Optional) Padding, in elements, across y. Defaults to 0.
- * @param[in] round (Optional) Dimensions rounding. Defaults to @ref FLOOR.
+ * @param[in] round (Optional) Dimensions rounding. Defaults to @ref DimensionRoundingType::FLOOR.
*/
PadStrideInfo(unsigned int stride_x = 1, unsigned int stride_y = 1,
unsigned int pad_x = 0, unsigned int pad_y = 0,
@@ -1356,7 +1356,7 @@ struct Pooling3dLayerInfo
* True will exclude padding while false will not (Used in AVG/L2 pooling to determine the pooling area).
* Defaults to false;
* @param[in] fp_mixed_precision (Optional) Use wider accumulators (32 bit instead of 16 for FP16) to improve accuracy.
- * @param[in] round_type (Optional) Dimensions rounding. Defaults to @ref FLOOR
+ * @param[in] round_type (Optional) Dimensions rounding. Defaults to @ref DimensionRoundingType::FLOOR
*/
explicit Pooling3dLayerInfo(PoolingType pool_type,
unsigned int pool_size,
@@ -1386,7 +1386,7 @@ struct Pooling3dLayerInfo
* True will exclude padding while false will not (Used in AVG/L2 pooling to determine the pooling area).
* Defaults to false;
* @param[in] fp_mixed_precision (Optional) Use wider accumulators (32 bit instead of 16 for FP16) to improve accuracy.
- * @param[in] round_type (Optional) Dimensions rounding. Defaults to @ref FLOOR
+ * @param[in] round_type (Optional) Dimensions rounding. Defaults to @ref DimensionRoundingType::FLOOR
*/
explicit Pooling3dLayerInfo(PoolingType pool_type,
Size3D pool_size,
diff --git a/arm_compute/core/utils/quantization/AsymmHelpers.h b/arm_compute/core/utils/quantization/AsymmHelpers.h
index a9041762f5..a15f3e5cde 100644
--- a/arm_compute/core/utils/quantization/AsymmHelpers.h
+++ b/arm_compute/core/utils/quantization/AsymmHelpers.h
@@ -92,8 +92,6 @@ std::pair<int, int> get_min_max_values_from_quantized_data_type(DataType data_ty
* @param[in] output Output tensor info.
* @param[out] output_multipliers_ptr Pointer to the buffer where to store per-channel multipliers.
* @param[out] output_shifts_ptr Pointer to the buffer where to store per-channel shifts.
- *
- * @return min and max values for the quantized data type
*/
void compute_quantized_multipliers_and_shifts(const ITensorInfo *input,
const ITensorInfo *weights,
diff --git a/arm_compute/runtime/CL/functions/CLConvertFullyConnectedWeights.h b/arm_compute/runtime/CL/functions/CLConvertFullyConnectedWeights.h
index 6c7d9e52e8..0a634b5482 100644
--- a/arm_compute/runtime/CL/functions/CLConvertFullyConnectedWeights.h
+++ b/arm_compute/runtime/CL/functions/CLConvertFullyConnectedWeights.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018-2021 Arm Limited.
+ * Copyright (c) 2018-2021, 2023 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
@@ -68,8 +68,6 @@ public:
* @param[out] output The converted weights tensor. Shape and Data Type: Same as @p input.
* @param[in] original_input_shape Shape of the original input tensor (the one entering fully connected layer).
* @param[in] data_layout The data layout the weights have been trained in.
- *
- * @return A status
*/
void configure(const ICLTensor *input, ICLTensor *output, const TensorShape &original_input_shape, DataLayout data_layout);
/** Initialize the function.
@@ -79,8 +77,6 @@ public:
* @param[out] output The converted weights tensor. Shape and Data Type: Same as @p input.
* @param[in] original_input_shape Shape of the original input tensor (the one entering fully connected layer).
* @param[in] data_layout The data layout the weights have been trained in.
- *
- * @return A status
*/
void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const TensorShape &original_input_shape, DataLayout data_layout);
/** Static function to check if given info will lead to a valid configuration of @ref CLConvertFullyConnectedWeights