summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Goodliffe <dan@randomdan.homeip.net>2017-08-04 23:36:35 +0100
committerDan Goodliffe <dan@randomdan.homeip.net>2017-08-04 23:36:35 +0100
commitcd6fbae608ea403710535cd11f87ffd989c2901d (patch)
treecd00ca193b4f3c964f6be3ba8c846633184e2b74
parentImprove FileHandle's compatibility with a raw descriptor (diff)
downloadlibadhocutil-cd6fbae608ea403710535cd11f87ffd989c2901d.tar.bz2
libadhocutil-cd6fbae608ea403710535cd11f87ffd989c2901d.tar.xz
libadhocutil-cd6fbae608ea403710535cd11f87ffd989c2901d.zip
Add missing docs for GlobalStatic
-rw-r--r--libadhocutil/globalStatic.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/libadhocutil/globalStatic.h b/libadhocutil/globalStatic.h
index 544cc1e..d379146 100644
--- a/libadhocutil/globalStatic.h
+++ b/libadhocutil/globalStatic.h
@@ -2,9 +2,17 @@
#define ADHOCUTIL_GLOBALSTATIC_H
namespace AdHoc {
+ /**
+ * Wrapper class for initialising/destroying a global static object via
+ * __attribute__ constructor/destructor.
+ */
template<typename Object>
class GlobalStatic {
public:
+ /**
+ * Get the contained object.
+ * @return The object.
+ */
static Object * get();
private: