fix jsdoc, add wiki as submodule

Author: DanielBoettner

.gitignore

@@ -6,4 +6,5 @@ git_tags.txt
 template/debug.log
 dist/
 node_modules/
-docs/
+docs/
+wiki/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "wiki"]
+	path = wiki
+	url = https://github.com/DanielBoettner/fvtt-loot-sheet-npc-5e.wiki.git

modules/API.js

@@ -98,7 +98,7 @@ class API {
     /**
      * Convert a stack of Tokens to a given type, apply modifiers if given
      * 
-     * @param {Array<Token5e} tokens Array of ActorTokens
+     * @param {Array<Token5e>} tokens Array of ActorTokens
      * @param {string} type Type of sheet (loot|merchant)
      * @param {object} options 
      */

modules/classes/LootsheetNPC5e.js

@@ -399,7 +399,7 @@ class LootSheet5eNPC extends ActorSheet5eNPC {
      * @param {event} event 
      * @param {number|null} all 
      * 
-     * @uses PermissionHelper
+     * uses PermissionHelper
      */
     _buyItem(event, all = null) {
         event.preventDefault();

modules/helper/Helper.js

@@ -55,7 +55,8 @@ class LootSheetNPC5eHelper {
      * @param {number} chanceOfDamagedItems 
      * @param {number} damagedItemsMultiplier 
      * @param {number} removeDamagedItems 
-     * @returns 
+     * 
+     * @returns {Array<Items>} items Filtered lootable items
      */
     static _getLootableItems(
         items,

modules/helper/ItemHelper.js

@@ -19,7 +19,7 @@ class ItemHelper {
      * @param {Actor5e} source 
      * @param {Actor5e} destination 
      * @param {Item} items 
-     * @returns 
+     * @returns {Array<object>} Array with moved item
      */
     static async moveItems(source, destination, items) {
 
@@ -109,7 +109,6 @@ class ItemHelper {
      * @param {Actor} buyer 
      * @param {string} itemId 
      * @param {number} quantity 
-     * @returns 
      */
     static async transaction(seller, buyer, itemId, quantity) {
         let sellItem = seller.getEmbeddedEntity("Item", itemId);

modules/helper/PermissionHelper.js

@@ -50,7 +50,7 @@ class PermissionHelper {
      * @param {number} newLevel 
      * @param {event} event
      * 
-     * @uses PermissionControl 
+     * uses PermissionControl 
      */
     static _updatePermissions(actorData, playerId, newLevel, event) {
         // Read player permission on this actor and adjust to new level

package.json

@@ -4,7 +4,8 @@
   "description": "A javascript FoundryVTT module. Adding an additional NPC sheet for Loot/Containers/Merchant",
   "main": "lootsheetnpc5e.js",
   "scripts": {
-    "all": "npm run less && npm run copyfiles && npm run localcopy",
+    "local-all": "npm run less && npm run copyfiles && npm run localcopy && npm run generate-docs",
+    "all": "npm run less && npm run copyfiles ",
     "test": "echo \"Error: no test specified\" && exit 1",
     "copyfiles": "copyfiles ./lootsheetnpc5e.js ./module.json ./modules/**/* ./template/**/* ./packs/**/* ./icons/**/* ./dist",
     "less": "lessc -clean-css ./styles/lootsheetNPC5e.less ./dist/styles/lootsheetNPC5e.css",