From dbc9b7ae4ef8c4656158565051211604f0bee287 Mon Sep 17 00:00:00 2001 From: Alexander Bock Date: Wed, 14 Sep 2016 14:44:51 +0200 Subject: [PATCH] Move documentation to their own folder --- .../{util => documentation}/documentation.h | 0 .../{util => documentation}/documentation.inl | 0 .../documentation/documentationengine.h | 28 ++++++++++++++++ src/CMakeLists.txt | 8 +++-- src/{util => documentation}/documentation.cpp | 2 +- src/documentation/documentationengine.cpp | 33 +++++++++++++++++++ tests/test_documentation.inl | 2 +- 7 files changed, 68 insertions(+), 5 deletions(-) rename include/openspace/{util => documentation}/documentation.h (100%) rename include/openspace/{util => documentation}/documentation.inl (100%) create mode 100644 include/openspace/documentation/documentationengine.h rename src/{util => documentation}/documentation.cpp (99%) create mode 100644 src/documentation/documentationengine.cpp diff --git a/include/openspace/util/documentation.h b/include/openspace/documentation/documentation.h similarity index 100% rename from include/openspace/util/documentation.h rename to include/openspace/documentation/documentation.h diff --git a/include/openspace/util/documentation.inl b/include/openspace/documentation/documentation.inl similarity index 100% rename from include/openspace/util/documentation.inl rename to include/openspace/documentation/documentation.inl diff --git a/include/openspace/documentation/documentationengine.h b/include/openspace/documentation/documentationengine.h new file mode 100644 index 0000000000..4d4c091b39 --- /dev/null +++ b/include/openspace/documentation/documentationengine.h @@ -0,0 +1,28 @@ +/***************************************************************************************** + * * + * 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 __DOCUMENTATIONENGINE_H__ +#define __DOCUMENTATIONENGINE_H__ + +#endif // __DOCUMENTATIONENGINE_H__ diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index c50e7a7561..244b299a35 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -24,6 +24,8 @@ set(OPENSPACE_SOURCE ${OPENSPACE_BASE_DIR}/src/openspace.cpp + ${OPENSPACE_BASE_DIR}/src/documentation/documentation.cpp + ${OPENSPACE_BASE_DIR}/src/documentation/documentationengine.cpp ${OPENSPACE_BASE_DIR}/src/engine/configurationmanager.cpp ${OPENSPACE_BASE_DIR}/src/engine/downloadmanager.cpp ${OPENSPACE_BASE_DIR}/src/engine/logfactory.cpp @@ -86,7 +88,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/documentation.cpp ${OPENSPACE_BASE_DIR}/src/util/factorymanager.cpp ${OPENSPACE_BASE_DIR}/src/util/keys.cpp ${OPENSPACE_BASE_DIR}/src/util/openspacemodule.cpp @@ -106,6 +107,9 @@ set(OPENSPACE_SOURCE set(OPENSPACE_HEADER ${OPENSPACE_BASE_DIR}/include/openspace/openspace.h + ${OPENSPACE_BASE_DIR}/include/openspace/documentation/documentation.h + ${OPENSPACE_BASE_DIR}/include/openspace/documentation/documentation.inl + ${OPENSPACE_BASE_DIR}/include/openspace/documentation/documentationengine.h ${OPENSPACE_BASE_DIR}/include/openspace/engine/configurationmanager.h ${OPENSPACE_BASE_DIR}/include/openspace/engine/downloadmanager.h ${OPENSPACE_BASE_DIR}/include/openspace/engine/logfactory.h @@ -173,8 +177,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/documentation.h - ${OPENSPACE_BASE_DIR}/include/openspace/util/documentation.inl ${OPENSPACE_BASE_DIR}/include/openspace/util/factorymanager.h ${OPENSPACE_BASE_DIR}/include/openspace/util/factorymanager.inl ${OPENSPACE_BASE_DIR}/include/openspace/util/keys.h diff --git a/src/util/documentation.cpp b/src/documentation/documentation.cpp similarity index 99% rename from src/util/documentation.cpp rename to src/documentation/documentation.cpp index affa1d73ed..ae86af64f9 100644 --- a/src/util/documentation.cpp +++ b/src/documentation/documentation.cpp @@ -22,7 +22,7 @@ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * ****************************************************************************************/ -#include +#include namespace std { std::string to_string(std::string value) { diff --git a/src/documentation/documentationengine.cpp b/src/documentation/documentationengine.cpp new file mode 100644 index 0000000000..efc4309bae --- /dev/null +++ b/src/documentation/documentationengine.cpp @@ -0,0 +1,33 @@ +/***************************************************************************************** + * * + * 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. * + ****************************************************************************************/ + +#include + +namespace openspace { +namespace documentation { + + + +} // namespace documentation +} // namespace openspace diff --git a/tests/test_documentation.inl b/tests/test_documentation.inl index a46bcae869..ba9eff6b76 100644 --- a/tests/test_documentation.inl +++ b/tests/test_documentation.inl @@ -24,7 +24,7 @@ #include "gtest/gtest.h" -#include +#include #include