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>
---
 utils/Utils.h | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'utils/Utils.h')

diff --git a/utils/Utils.h b/utils/Utils.h
index cefb3ae4c0..73b6d4f832 100644
--- a/utils/Utils.h
+++ b/utils/Utils.h
@@ -62,8 +62,15 @@ namespace utils
 class Example
 {
 public:
+    /** Setup the example.
+     *
+     * @param[in] argc Argument count.
+     * @param[in] argv Argument values.
+     */
     virtual void do_setup(int argc, char **argv) {};
+    /** Run the example. */
     virtual void do_run() {};
+    /** Teardown the example. */
     virtual void do_teardown() {};
 
     /** Default destructor. */
@@ -489,9 +496,11 @@ private:
     unsigned int  _width, _height;
 };
 
+/** Numpy data loader */
 class NPYLoader
 {
 public:
+    /** Default constructor */
     NPYLoader()
         : _fs(), _shape(), _fortran_order(false), _typestring()
     {
-- 
cgit v1.2.1