aboutsummaryrefslogtreecommitdiff
path: root/utils/Utils.h
diff options
context:
space:
mode:
Diffstat (limited to 'utils/Utils.h')
-rw-r--r--utils/Utils.h9
1 files changed, 9 insertions, 0 deletions
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()
{