diff options
author | Alex Gilday <alexander.gilday@arm.com> | 2018-03-21 13:54:09 +0000 |
---|---|---|
committer | Anthony Barbier <anthony.barbier@arm.com> | 2018-11-02 16:49:16 +0000 |
commit | c357c47be8a3f210f9eee9a05cc13f1051b036d3 (patch) | |
tree | a88ac857150da970a0862a3479b78c616d8aa1d3 /tests/NEON | |
parent | 724079d6fce3bf6a05cd6c7b4884b132b27e9e90 (diff) | |
download | ComputeLibrary-c357c47be8a3f210f9eee9a05cc13f1051b036d3.tar.gz |
COMPMID-1008: Fix Doxygen issues
Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723
Reviewed-by: Michalis Spyrou <michalis.spyrou@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'tests/NEON')
-rw-r--r-- | tests/NEON/Accessor.h | 19 | ||||
-rw-r--r-- | tests/NEON/ArrayAccessor.h | 8 | ||||
-rw-r--r-- | tests/NEON/Helper.h | 15 | ||||
-rw-r--r-- | tests/NEON/LutAccessor.h | 8 |
4 files changed, 40 insertions, 10 deletions
diff --git a/tests/NEON/Accessor.h b/tests/NEON/Accessor.h index e285f227de..60a94c20d4 100644 --- a/tests/NEON/Accessor.h +++ b/tests/NEON/Accessor.h @@ -41,11 +41,26 @@ public: */ Accessor(Tensor &tensor); + /** Prevent instances of this class from being copy constructed */ Accessor(const Accessor &) = delete; + /** Prevent instances of this class from being copied */ Accessor &operator=(const Accessor &) = delete; - Accessor(Accessor &&) = default; + /** Allow instances of this class to be move constructed */ + Accessor(Accessor &&) = default; + /** Allow instances of this class to be moved */ Accessor &operator=(Accessor &&) = default; + /** Get the tensor data. + * + * @return a constant pointer to the tensor data. + */ + const void *data() const; + /** Get the tensor data. + * + * @return a pointer to the tensor data. + */ + void *data(); + TensorShape shape() const override; size_t element_size() const override; size_t size() const override; @@ -59,8 +74,6 @@ public: QuantizationInfo quantization_info() const override; const void *operator()(const Coordinates &coord) const override; void *operator()(const Coordinates &coord) override; - const void *data() const; - void *data(); private: Tensor &_tensor; diff --git a/tests/NEON/ArrayAccessor.h b/tests/NEON/ArrayAccessor.h index 26bae10e00..e6911027a7 100644 --- a/tests/NEON/ArrayAccessor.h +++ b/tests/NEON/ArrayAccessor.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -45,9 +45,13 @@ public: { } + /** Prevent instances of this class from being copy constructed */ ArrayAccessor(const ArrayAccessor &) = delete; + /** Prevent instances of this class from being copied */ ArrayAccessor &operator=(const ArrayAccessor &) = delete; - ArrayAccessor(ArrayAccessor &&) = default; + /** Allow instances of this class to be move constructed */ + ArrayAccessor(ArrayAccessor &&) = default; + /** Allow instances of this class to be moved */ ArrayAccessor &operator=(ArrayAccessor &&) = default; size_t num_values() const override diff --git a/tests/NEON/Helper.h b/tests/NEON/Helper.h index 93f2010b95..b9f961243a 100644 --- a/tests/NEON/Helper.h +++ b/tests/NEON/Helper.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -50,11 +50,15 @@ void fill_tensors(D &&dist, std::initializer_list<int> seeds, T &&tensor, Ts &&. } } -// This template synthetizes an INESimpleFunction which runs the given kernel K +/** This template synthetizes an INESimpleFunction which runs the given kernel K */ template <typename K> class NESynthetizeFunction : public INESimpleFunction { public: + /** Configure the kernel. + * + * @param[in] args Configuration arguments. + */ template <typename... Args> void configure(Args &&... args) { @@ -64,11 +68,16 @@ public: } }; -// As above but this also setups a Zero border on the input tensor of the specified bordersize +/** As above but this also setups a Zero border on the input tensor of the specified bordersize */ template <typename K, int bordersize> class NESynthetizeFunctionWithZeroConstantBorder : public INESimpleFunction { public: + /** Configure the kernel. + * + * @param[in] first First configuration argument. + * @param[in] args Rest of the configuration arguments. + */ template <typename T, typename... Args> void configure(T first, Args &&... args) { diff --git a/tests/NEON/LutAccessor.h b/tests/NEON/LutAccessor.h index 388e036edb..046d1b87ff 100644 --- a/tests/NEON/LutAccessor.h +++ b/tests/NEON/LutAccessor.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -44,9 +44,13 @@ public: { } + /** Prevent instances of this class from being copy constructed */ LutAccessor(const LutAccessor &) = delete; + /** Prevent instances of this class from being copied */ LutAccessor &operator=(const LutAccessor &) = delete; - LutAccessor(LutAccessor &&) = default; + /** Allow instances of this class to be move constructed */ + LutAccessor(LutAccessor &&) = default; + /** Allow instances of this class to be moved */ LutAccessor &operator=(LutAccessor &&) = default; int num_elements() const override |