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/framework/datasets/ZipDataset.h | |
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/framework/datasets/ZipDataset.h')
-rw-r--r-- | tests/framework/datasets/ZipDataset.h | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/tests/framework/datasets/ZipDataset.h b/tests/framework/datasets/ZipDataset.h index b95b7209a7..3d93b92506 100644 --- a/tests/framework/datasets/ZipDataset.h +++ b/tests/framework/datasets/ZipDataset.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -62,6 +62,7 @@ public: { } + /** Allow instances of this class to be move constructed */ ZipDataset(ZipDataset &&) = default; /** Type of the dataset. */ @@ -70,21 +71,38 @@ public: /** Iterator for the dataset. */ struct iterator { + /** Construct an iterator. + * + * @param[in] iter1 Iterator 1. + * @param[in] iter2 Iterator 2. + */ iterator(iter1_type iter1, iter2_type iter2) : _iter1{ std::move(iter1) }, _iter2{ std::move(iter2) } { } + /** Get the description of the current value. + * + * @return description of the current value. + */ std::string description() const { return _iter1.description() + ":" + _iter2.description(); } + /** Get the value of the iterator. + * + * @return the value of the iterator. + */ ZipDataset::type operator*() const { return std::tuple_cat(*_iter1, *_iter2); } + /** Inrement the iterator. + * + * @return *this; + */ iterator &operator++() { ++_iter1; |