瀏覽代碼

added javadoc to config.h

marius.rescheleit 5 年之前
父節點
當前提交
f460983cb6
共有 1 個文件被更改,包括 18 次插入2 次删除
  1. 18 2
      daemon/include/config.h

+ 18 - 2
daemon/include/config.h

@@ -6,12 +6,28 @@
 #include <sstream>
 #include <vector>
 
-// loads configurationdata from config.txt
-
+/**
+ * Namespace which loads and holds configuration data
+ */
 namespace Config {
+
+/**
+ * Load data from file into storage
+ *
+ * @param filename the name of the file which holds the data
+ */
 bool init(const std::string &filename);
+
+/**
+ * Load data from file into storage
+ *
+ * @param key get value from storage by key
+ */
 std::string getValue(const std::string &key);
 
+/**
+ * Map which holds the configuration data
+ */
 extern std::map<std::string, std::string> storage;
 }; // namespace Config