Rename Documented to DocumentationGenerator

src/CMakeLists.txt

@@ -27,6 +27,7 @@ set(OPENSPACE_SOURCE
     ${OPENSPACE_BASE_DIR}/src/documentation/core_registration.cpp
     ${OPENSPACE_BASE_DIR}/src/documentation/documentation.cpp
     ${OPENSPACE_BASE_DIR}/src/documentation/documentationengine.cpp
+    ${OPENSPACE_BASE_DIR}/src/documentation/documentationgenerator.cpp
     ${OPENSPACE_BASE_DIR}/src/documentation/verifier.cpp
     ${OPENSPACE_BASE_DIR}/src/engine/configurationmanager.cpp
     ${OPENSPACE_BASE_DIR}/src/engine/configurationmanager_doc.inl
@@ -138,7 +139,6 @@ set(OPENSPACE_SOURCE
     ${OPENSPACE_BASE_DIR}/src/util/blockplaneintersectiongeometry.cpp
     ${OPENSPACE_BASE_DIR}/src/util/boxgeometry.cpp
     ${OPENSPACE_BASE_DIR}/src/util/camera.cpp
-    ${OPENSPACE_BASE_DIR}/src/util/documented.cpp
     ${OPENSPACE_BASE_DIR}/src/util/factorymanager.cpp
     ${OPENSPACE_BASE_DIR}/src/util/keys.cpp
     ${OPENSPACE_BASE_DIR}/src/util/openspacemodule.cpp
@@ -167,6 +167,7 @@ set(OPENSPACE_HEADER
     ${OPENSPACE_BASE_DIR}/include/openspace/documentation/core_registration.h
     ${OPENSPACE_BASE_DIR}/include/openspace/documentation/documentation.h
     ${OPENSPACE_BASE_DIR}/include/openspace/documentation/documentationengine.h
+    ${OPENSPACE_BASE_DIR}/include/openspace/documentation/documentationgenerator.h
     ${OPENSPACE_BASE_DIR}/include/openspace/documentation/verifier.h
     ${OPENSPACE_BASE_DIR}/include/openspace/documentation/verifier.inl
     ${OPENSPACE_BASE_DIR}/include/openspace/engine/configurationmanager.h
@@ -282,7 +283,6 @@ set(OPENSPACE_HEADER
     ${OPENSPACE_BASE_DIR}/include/openspace/util/blockplaneintersectiongeometry.h
     ${OPENSPACE_BASE_DIR}/include/openspace/util/boxgeometry.h
     ${OPENSPACE_BASE_DIR}/include/openspace/util/camera.h
-    ${OPENSPACE_BASE_DIR}/include/openspace/util/documented.h
     ${OPENSPACE_BASE_DIR}/include/openspace/util/factorymanager.h
     ${OPENSPACE_BASE_DIR}/include/openspace/util/factorymanager.inl
     ${OPENSPACE_BASE_DIR}/include/openspace/util/keys.h

src/documentation/documentationengine.cpp

@@ -62,7 +62,7 @@ DocumentationEngine::DuplicateDocumentationException::DuplicateDocumentationExce
 {}
 
 DocumentationEngine::DocumentationEngine()
-    : Documented(
+    : DocumentationGenerator(
         "Documentation",
         "documentation",
         {

src/documentation/documentationgenerator.cpp

@@ -22,7 +22,7 @@
  * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
  ****************************************************************************************/
 
-#include <openspace/util/documented.h>
+#include <openspace/documentation/documentationgenerator.h>
 
 #include <openspace/openspace.h>
 #include <openspace/util/time.h>
@@ -40,10 +40,10 @@ namespace {
 
 namespace openspace {
 
-Documented::Documented(std::string name,
-                       std::string jsonName,
-                       std::vector<HandlebarTemplate> handlebarTemplates,
-                       std::string javascriptFilename)
+DocumentationGenerator::DocumentationGenerator(std::string name,
+                                               std::string jsonName,
+                                        std::vector<HandlebarTemplate> handlebarTemplates,
+                                               std::string javascriptFilename)
     : _name(std::move(name))
     , _jsonName(std::move(jsonName))
     , _handlebarTemplates(std::move(handlebarTemplates))
@@ -63,7 +63,7 @@ Documented::Documented(std::string name,
     );
 }
     
-void Documented::writeDocumentation(const std::string& filename) {
+void DocumentationGenerator::writeDocumentation(const std::string& filename) {
     std::ifstream handlebarsInput(absPath(HandlebarsFilename));
     std::ifstream jsInput(absPath(_javascriptFile));
     

src/interaction/interactionhandler.cpp

@@ -73,7 +73,7 @@ namespace interaction {
 // InteractionHandler
 InteractionHandler::InteractionHandler()
     : properties::PropertyOwner("Interaction")
-    , Documented(
+    , DocumentationGenerator(
         "Documentation",
         "keybindings",
         {

src/scene/scene.cpp

@@ -83,7 +83,7 @@ namespace {
 namespace openspace {
 
 Scene::Scene()
-    : Documented(
+    : DocumentationGenerator(
         "Documented",
         "propertyOwners",
         {

src/scripting/scriptengine.cpp

@@ -66,7 +66,7 @@ namespace {
 std::string ScriptEngine::OpenSpaceLibraryName = "openspace";
 
 ScriptEngine::ScriptEngine()
-    : Documented(
+    : DocumentationGenerator(
         "Script Documentation",
         "scripting",
         {

src/util/factorymanager.cpp

@@ -53,7 +53,7 @@ FactoryManager::FactoryNotFoundError::FactoryNotFoundError(std::string t)
 }
 
 FactoryManager::FactoryManager()
-    : Documented(
+    : DocumentationGenerator(
         "Factory Documentation",
         "factories",
         {