Documented more things with JSDOC

This commit is contained in:
Danielv123 committed 2017-11-07 16:29:43 +01:00
1 parent 96d60e5428
commit 02dc688161
4 files changed
+56 -3

No files matched your search

+23 -1
View File
@@ -1,6 +1,21 @@
/**
Module for grabbing factorio locale from a local factorio install
@module getFactorioLocale
*/
const fs = require("fs");
const ini = require("ini");
/**
Gets raw factorio locale from the .ini file.
Not available outside of module through exports.
@memberof getFactorioLocale
@inner
@param {string} factorioDirectory
@param {string} languageCode
@param {function} callback
*/
function getLocale(factorioDirectory, languageCode, callback){
var localeFile = factorioDirectory + '/data/base/locale/' + languageCode + '/base.cfg';
fs.readFile(localeFile, "utf8", (err, rawLocale) => {
@@ -8,7 +23,14 @@ function getLocale(factorioDirectory, languageCode, callback){
});
}
function getLocaleAsObject(factorioDirectory, languageCode, callback){
/**
Gets factorios locale as an object, does not respect mods.
@param {string} factorioDirectory
@param {string} languageCode
@param {function} callback
*/
module.exports.asObject = function getLocaleAsObject(factorioDirectory, languageCode, callback){
if(typeof factorioDirectory != "string" || typeof languageCode != "string" || typeof callback != "function"){
throw "Error: wrong parameters provided";
}