Document STUB.h macros and usage

diff --git a/src/tests/STUB.h b/src/tests/STUB.h
index 15aa1c9cc6a90ed5bd60a8126af7488324482ea3..e5362e431770db9078c825b63eabdd293f85023a 100644 (file)
--- a/src/tests/STUB.h
+++ b/src/tests/STUB.h
@@ -1,11 +1,43 @@
 #ifndef STUB
 #include "fatal.h"
 
+/** \group STUB
+ *
+ *  A set of useful macros to create stub_* files.
+ * 
+ * Intended for use building unit tests, if a stubbed function is called
+ * by any code it is linked to it will abort with a message indicating
+ * which API file is missing from the linked dependencies.
+ *
+ * Usage:
+ *    at the top of your intended stub file define STUB_API to be the
+ *    name of the .cc file or library you are providing a stub of
+ *    then include this STUB.h header.
+ *
+ *   #define STUB_API "foo/libexample.la"
+ *   #include "tests/STUB.h"
+ */
+
+/// macro to stub a void function.
 #define STUB { fatal(STUB_API " required"); }
+
+/** macro to stub a function with return value.
+ *  Aborts unit tests requiring its definition with a message about the missing linkage
+ */
 #define STUB_RETVAL(x) { fatal(STUB_API " required"); return x; }
-//#define STUB_RETREF(x) { fatal(STUB_API " required"); x* o = new (x); return *o; }
-// NP: no () around the x here
+
+/** macro to stub a function which returns a reference to dynamic
+ *  Aborts unit tests requiring its definition with a message about the missing linkage
+ *  This macro uses 'new x' to construct a stack vailable for the reference, may leak.
+ *  \param x may be the type to define or a constructor call with parameter values
+ */
 #define STUB_RETREF(x) { fatal(STUB_API " required"); return new x; }
+
+/** macro to stub a function which returns a reference to static
+ *  Aborts unit tests requiring its definition with a message about the missing linkage
+ *  This macro uses static variable definition to avoid leaks.
+ *  \param x  the type name to define
+ */
 #define STUB_RETSTATREF(x) { fatal(STUB_API " required"); static x v; return v; }
 
 #endif /* STUB */