From c357c47be8a3f210f9eee9a05cc13f1051b036d3 Mon Sep 17 00:00:00 2001
From: Alex Gilday <alexander.gilday@arm.com>
Date: Wed, 21 Mar 2018 13:54:09 +0000
Subject: 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>
---
 tests/framework/TestCase.h | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'tests/framework/TestCase.h')

diff --git a/tests/framework/TestCase.h b/tests/framework/TestCase.h
index 18dd12e442..d7bf54d2fc 100644
--- a/tests/framework/TestCase.h
+++ b/tests/framework/TestCase.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 ARM Limited.
+ * Copyright (c) 2017-2018 ARM Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -40,9 +40,13 @@ namespace framework
 class TestCase
 {
 public:
+    /** Setup the test */
     virtual void do_setup() {};
+    /** Run the test */
     virtual void do_run() {};
+    /** Sync the test */
     virtual void do_sync() {};
+    /** Teardown the test */
     virtual void do_teardown() {};
 
     /** Default destructor. */
@@ -54,10 +58,15 @@ protected:
     friend class TestCaseFactory;
 };
 
+/** Data test case class */
 template <typename T>
 class DataTestCase : public TestCase
 {
 protected:
+    /** Construct a data test case.
+     *
+     * @param[in] data Test data.
+     */
     explicit DataTestCase(T data)
         : _data{ std::move(data) }
     {
-- 
cgit v1.2.1