electron-126: added code documentation

This commit is contained in:
Vishwas Shashidhar 2017-09-06 22:19:44 +05:30
parent 69d6c40ac3
commit 683962ee03

View File

@ -248,8 +248,8 @@ function updateUserConfig(newGlobalConfig, oldUserConfig) {
} }
/** /**
* Method to overwrite user config on windows installer * Manipulates user config on windows
* @param {String} perUserInstall - Is a flag to determine whether we are installing for per user * @param {String} perUserInstall - Is a flag to determine if we are installing for an individual user
* @returns {Promise} * @returns {Promise}
*/ */
function updateUserConfigWin(perUserInstall) { function updateUserConfigWin(perUserInstall) {
@ -267,12 +267,16 @@ function updateUserConfigWin(perUserInstall) {
return; return;
} }
// In case the file exists, we remove it so that all the
// values are fetched from the global config
// https://perzoinc.atlassian.net/browse/ELECTRON-126
fs.unlink(userConfigFile, (err) => { fs.unlink(userConfigFile, (err) => {
if (err) { if (err) {
log.send(logLevels.ERROR, 'config: Could not delete the user config file!'); log.send(logLevels.ERROR, 'config: Could not delete the user config file!');
reject(); reject();
return; return;
} }
log.send(logLevels.ERROR, 'config: Deleted user config file!');
resolve(); resolve();
}); });
@ -281,7 +285,7 @@ function updateUserConfigWin(perUserInstall) {
} }
/** /**
* Method to overwrite user config on mac installer * Manipulates user config on macOS
* @param {String} globalConfigPath - The global config path from installer * @param {String} globalConfigPath - The global config path from installer
* @returns {Promise} * @returns {Promise}
*/ */