Fix JSDoc issues

Fix missing documentation for parameters and return types, incorect
config and errors in type definitions.
This commit is contained in:
Hornwitser committed 2020-06-17 20:53:18 +02:00
1 parent 3dba92a03d
commit 703fda43ad
20 files changed
+193 -52

No files matched your search

+7 -3
View File
@@ -106,8 +106,11 @@ async function loadFile(server, modVersions, modPath) {
*
* @param {module:lib/factorio.FactorioServer} server -
* The server to generate the export mod for.
* @param {Map<string, string>} modVersions -
* Mapping of mod name to versions to get icons from.
* @param {Array<Object>} items - Array of item prototypes.
* @return {itemSheet: Jimp, itemData: Map<string, Object>} Item spritesheet and metadata.
* @return {{itemSheet: Jimp, itemData: Map<string,Object>}}
* Item spritesheet and metadata.
* @memberof module:lib/factorio
* @private
* @inner
@@ -259,9 +262,10 @@ async function exportItems(server, modVersions, items) {
*
* @param {module:lib/factorio.FactorioServer} server -
* The server to export the locale from.
* @param modVersions {Map<string, string>} modVersions -
* @param {Map<string, string>} modVersions -
* Mapping of mod name to version to export locale from.
* @param modOrder {Array<string>} modOrder - Load order of the mods.
* @param {Array<string>} modOrder - Load order of the mods.
* @param {string} languageCode - Language to export locale for.
* @returns {Map<string, string>} merged locale information
* @memberof module:lib/factorio
* @private