Verified Commit f5ef908b authored by Pavel Doležal's avatar Pavel Doležal
Browse files

ConfigFile: Add Doxygen comments

parent e6394298
......@@ -36,6 +36,7 @@ void DDP::ConfigFile::load_configuration(Config& cfg, std::string conf_file, std
try {
YAML::Node config = YAML::LoadFile(conf_file);
// Always load default configuration first and then load changes for given instance if present
if (config["default"])
load_instance(cfg, config["default"]);
......
......@@ -29,9 +29,24 @@
#include "Config.h"
namespace DDP {
/**
* @brief Parse YAML configuration file and fill Config structure
*/
struct ConfigFile
{
/**
* @brief Parses "default" and user given instances from YAML configuration file.
* @param cfg Config structure to fill
* @param conf_file Path to YAML configuration file
* @param instance Unique ID of DNS Probe instance
*/
static void load_configuration(Config& cfg, std::string conf_file, std::string instance = "default");
/**
* @brief Parses DNS Probe instance given in YAML::Node object
* @param cfg Config structure to fill
* @param node YAML Node with configuration for specific DNS Probe instance
*/
static void load_instance(Config& cfg, YAML::Node node);
};
}
\ No newline at end of file
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment