add doxygen

This commit is contained in:
2020-06-01 23:24:24 +02:00
parent f3a0bfed40
commit af365474a7
15 changed files with 241 additions and 10 deletions

View File

@@ -6,7 +6,19 @@
class config_reader
{
public:
/**
* @brief config_reader
* Generate a objet to extract info to a config file
* @param path File path to extract the file
*/
config_reader(std::string);
/**
* @brief get_param
* Permit extract a value in a config file
* @param variable Name of a field to extract the info
* @param value Info extracted
* @return True if the field exists, false if not
*/
bool get_param(std::string variable, std::string &value);
private:
std::ifstream file;