summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorCharles Edward Pax <charles.pax@gmail.com>2017-07-27 21:17:18 +0800
committerCharles Edward Pax <charles.pax@gmail.com>2017-07-27 21:17:18 +0800
commitc9180e0d8a91fae476fc63846f387edd9466aa64 (patch)
tree7c35c2006f5878932755f79aefe1d120acb847dd /src
parente82b814497c871db4faeb90bad9c3e46f825f6eb (diff)
Comments in conf.c.
Diffstat (limited to 'src')
-rw-r--r--src/conf.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/conf.c b/src/conf.c
index 1e2a3d4..1312700 100644
--- a/src/conf.c
+++ b/src/conf.c
@@ -116,7 +116,7 @@ void store_default_config_values() {
*
* \param[in] salida TODO Document this parameter
*
- * \return NULL if user_conf_d is NULL; salida if salida exists
+ * \return NULL if user_conf_d is NULL; otherwise, salida is returned unchanged
*/
// TODO Change 'salida' to a more descriptive variable name.
@@ -140,12 +140,14 @@ char * get_conf_values(char * salida) {
}
/**
- * \brief Retreive teh value of a given key in user_conf_d
+ * \brief Retreive the value of a given key in user_conf_d
*
* \details This function will look for a given key in the user_conf_d
* dictionary. If the key is found it will return the value of that
* dictionary entry.
*
+ * \param[in] key The key to search for in user_conf_d
+ *
* \return key value
*/
// TODO Make this function take a pointer to a dictionary as an