From 9888f66c84c0c2d71c546a254c91960fe4e38754 Mon Sep 17 00:00:00 2001
From: rejas <github@veeck.de>
Date: Mon, 27 Jul 2020 20:14:10 +0200
Subject: [PATCH] Cleanup check_config jsdoc

---
 js/check_config.js | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/js/check_config.js b/js/check_config.js
index 64dbbc6e..7ed6ea96 100644
--- a/js/check_config.js
+++ b/js/check_config.js
@@ -17,8 +17,10 @@ const Log = require(rootPath + "/js/logger.js");
 const Utils = require(rootPath + "/js/utils.js");
 
 /**
- * Return string with path of configuration file
+ * Returns a string with path of configuration file.
  * Check if set by environment variable MM_CONFIG_FILE
+ *
+ * @returns {string} path and filename of the config file
  */
 function getConfigFile() {
 	// FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
@@ -30,7 +32,7 @@ function getConfigFile() {
 }
 
 /**
- *
+ * Checks the config file using eslint.
  */
 function checkConfigFile() {
 	const configFileName = getConfigFile();
@@ -41,7 +43,7 @@ function checkConfigFile() {
 		throw new Error("No config file present!");
 	}
 
-	// check permission
+	// Check permission
 	try {
 		fs.accessSync(configFileName, fs.F_OK);
 	} catch (e) {