Merge 201b5c8b5dfd16da0470b3dae2b4df963b193959 into 7c50c8d1fb622cfa37ba91b42e65c5afe5512443

include/ConfigLoader.h

@@ -4,16 +4,52 @@
 
 using json = nlohmann::json;
 
+/*!
+ * \class ConfigLoader
+ * \brief Enables configuration of specific engine variables via a custom JSON file.
+ *
+ *  The Config loader is responsible to handling customization for engine parameters like the
+ *  window icon, window title, ... through json files.
+ *
+ *  It includes a standard config file and the option to add a custom one by overwriting the setConfigFilePath()
+ *  function within the implementation of the \ref Game class. Those files get merged, with a priorization on
+ *  the parameters set within the custom config file.
+ *
+ *
+ *  The currently available config parameters with their default values are:
+ *  \include ../config.json
+ *
+ */
+
 class ConfigLoader {
 
 public:
     ConfigLoader();
     ~ConfigLoader();
 
+    /*!
+     *  \brief Creates the final config for the engine
+     *
+     *  Loads the default config and then creates the final config by either merging
+     *  (if the custom config has been set) or by implementing the standard config (if no custom
+     *  config was set).
+     *
+     *  \private
+     */
     void init();
-
+    /*!
+     * \brief Sets the customConfigPath variable
+     *
+     * \param path optional variable that should include the path to the custom config JSON file
+     *
+     * \private
+     */
     void setCustomConfig(const std::optional<std::string>& path);
-
+    /*!
+     * \brief Gets final configuration
+     * \return `json` variable containing the final config
+     * \private
+     */
     json getFinalConfig();
 
 private:

include/Game.h

@@ -9,6 +9,15 @@ public:
 
     virtual void init() = 0;
     virtual void update(uint_fast16_t diffTime) = 0;
+
+    /*!
+     *  \brief Sets the path for a custom config file.
+     *
+     *  Virtual function to be overwritten in the implementation to return the path of a custom config JSON file.
+     *  \sa Layout of the config file is shown in ConfigLoader
+     *
+     *  \return std::optional<std::string>
+     */
     virtual std::optional<std::string> setConfigFilePath() {return std::nullopt;}
 
     GameInternal* gameInternal; //!< \deprecated  

src/ConfigLoader.cpp

@@ -8,7 +8,7 @@ ConfigLoader::~ConfigLoader() {}
 
 void ConfigLoader::init() {
     //TODO: look into adaptive paths for better handling as this requires the implemented game
-    // to have ./engine in the root folder
+    // to have ./engine in the root folder (very low prio)
     const json baseConfig = loadConfigFromJSON("./engine/config.json");
 
     if (!customConfigPath.has_value()) {