Add documentation/specification for ConfigurationManager

Add documentation testing to ConfigurationManager

include/openspace/documentation/documentation.h

@@ -28,6 +28,7 @@
 #include <ghoul/misc/assert.h>
 #include <ghoul/misc/boolean.h>
 #include <ghoul/misc/dictionary.h>
+#include <ghoul/misc/exception.h>
 
 #include <iterator>
 #include <map>
@@ -39,12 +40,18 @@
 namespace openspace {
 namespace documentation {
 
+using Optional = ghoul::Boolean;
+
 struct TestResult {
     bool success;
     std::vector<std::string> offenders;
 };
 
-using Optional = ghoul::Boolean;
+struct SpecificationError : public ghoul::RuntimeError {
+    SpecificationError(TestResult result, std::string component);
+
+    TestResult result;
+};
 
 struct Verifier {
     virtual TestResult operator()(const ghoul::Dictionary& dict,

include/openspace/documentation/documented.h

@@ -0,0 +1,45 @@
+/*****************************************************************************************
+ *                                                                                       *
+ * OpenSpace                                                                             *
+ *                                                                                       *
+ * Copyright (c) 2014-2016                                                               *
+ *                                                                                       *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
+ * software and associated documentation files (the "Software"), to deal in the Software *
+ * without restriction, including without limitation the rights to use, copy, modify,    *
+ * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
+ * permit persons to whom the Software is furnished to do so, subject to the following   *
+ * conditions:                                                                           *
+ *                                                                                       *
+ * The above copyright notice and this permission notice shall be included in all copies *
+ * or substantial portions of the Software.                                              *
+ *                                                                                       *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
+ * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
+ ****************************************************************************************/
+
+#ifndef __DOCUMENTED_H__
+#define __DOCUMENTED_H__
+
+#include <openspace/documentation/documentation.h>
+
+namespace openspace {
+namespace documentation {
+
+template <typename T>
+struct Documented {
+    static Documentation Documentation() {
+        static_assert(false, "Missing template specialization for type" + typeid(T));
+    }
+};
+
+} // namespace documentation
+} // namespace openspace
+
+
+
+#endif // __DOCUMENTED_H__