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>

1 files changed, 20 insertions, 1 deletions

diff --git a/tests/framework/datasets/ContainerDataset.h b/tests/framework/datasets/ContainerDataset.h
index 80616c46fc..8dfd2164c7 100644
--- a/tests/framework/datasets/ContainerDataset.h
+++ b/tests/framework/datasets/ContainerDataset.h
@@ -72,8 +72,10 @@ public:
     {
     }
 
+    /** Allow instances of this class to be copy constructed */
     ContainerDataset(const ContainerDataset &) = default;
-    ContainerDataset(ContainerDataset &&)      = default;
+    /** Allow instances of this class to be move constructed */
+    ContainerDataset(ContainerDataset &&) = default;
 
     /** Type of the dataset. */
     using type = std::tuple<container_value_type>;
@@ -81,22 +83,39 @@ public:
     /** Iterator for the dataset. */
     struct iterator
     {
+        /** Construct iterator
+         *
+         * @param[in] name     Description of the values.
+         * @param[in] iterator Iterator for the values.
+         */
         iterator(std::string name, container_const_iterator iterator)
             : _name{ name }, _iterator{ iterator }
         {
         }
 
+        /** Get a description of the current value.
+         *
+         * @return a description.
+         */
         std::string description() const
         {
             using support::cpp11::to_string;
             return _name + "=" + to_string(*_iterator);
         }
 
+        /** Get the current value.
+         *
+         * @return the current value.
+         */
         ContainerDataset::type operator*() const
         {
             return std::make_tuple(*_iterator);
         }
 
+        /** Increment the iterator.
+         *
+         * @return this.
+         */
         iterator &operator++()
         {
             ++_iterator;