X-Git-Url: https://vaikene.ee/gitweb/pswgen09.html?a=blobdiff_plain;f=src%2Flibs%2FCommon%2Fglobals.h;h=ca360505dae81e817e298928978212e0a0961134;hb=13dedf19c628b9967e4c4106ab0fd967f1df0b90;hp=93346d58f702ef851a0150ec5fef2df6622938d3;hpb=4d81227da330c21c7aa0badc88bd5ad4467067fb;p=evaf
diff --git a/src/libs/Common/globals.h b/src/libs/Common/globals.h
index 93346d5..ca36050 100644
--- a/src/libs/Common/globals.h
+++ b/src/libs/Common/globals.h
@@ -3,7 +3,7 @@
* @brief Global constants and macros for eVaf
* @author Enar Vaikene
*
- * Copyright (c) 2011 Enar Vaikene
+ * Copyright (c) 2011-2019 Enar Vaikene
*
* This file is part of the eVaf C++ cross-platform application development framework.
*
@@ -24,6 +24,7 @@
#include "ilogger.h"
/**
+ * @mainpage
* eVaf is a C++ cross-platform modular application development framework using Qt.
*
* The eVaf main executable is an empty container that needs to be filled with external modules to
@@ -50,6 +51,12 @@
* data object by one. If no other module kept the data object, then the data object's reference counter
* becomes zero and it is destroyed too.
*/
+
+/**
+ * Global eVaf namespace.
+ *
+ * eVaf is a C++ cross-platform modular application development framework using Qt.
+ */
namespace eVaf {
/**
@@ -64,7 +71,7 @@ namespace eVaf {
namespace Common {
/**
- * eVaf common library initialized
+ * eVaf common library initializer
* @return True if ok; false if the initialization failed
*
* Call this function to initialize the common eVaf library after creating the Qt application
@@ -72,6 +79,14 @@ namespace Common {
*/
extern bool COMMON_EXPORT init();
+/**
+ * eVaf common library finalizer
+ *
+ * Call this function to finalize the common eVaf library after destroying the Qt application
+ * object and unloading all the modules.
+ */
+extern void COMMON_EXPORT done();
+
/**
* Internal implementation of the common eVaf library.
*/
@@ -89,15 +104,15 @@ namespace Internal {
*/
#define EVAF_TEST(cond) \
if (!cond) \
- EVAF_FATAL(#cond);
+ EVAF_FATAL_ERROR(#cond);
/**
* Tests that the condition is true with a custom error message.
*
* This macro tests for the condition and if not true, exist with a custom fatal error message.
*/
-#define EVAF_TEST_X(const, msg) \
+#define EVAF_TEST_X(cond, msg) \
if (!cond) \
- EVAF_FATAL(msg);
+ EVAF_FATAL_ERROR(msg);
#endif // globals.h