From cda9d1c19e39527eae7c16c0183e1602e317b067 Mon Sep 17 00:00:00 2001 From: Peter Date: Sun, 30 Jul 2023 15:44:55 +0200 Subject: [PATCH] refactor: update JSDoc --- src/utility/pathfinding.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/utility/pathfinding.js b/src/utility/pathfinding.js index 2fe761ffb..11757e667 100644 --- a/src/utility/pathfinding.js +++ b/src/utility/pathfinding.js @@ -1,12 +1,12 @@ import * as arrayUtils from './arrayUtils'; -/** search - * @param {Hex} start ? - * @param {Hex} end ? - * @param {?} creatureSize ? - * @param {?} creatureId ? - * @param {?} grid ? - * @returns {?} ? +/** + * @param {Hex} start - Starting point of search + * @param {Hex} end - Ending point of search + * @param {number} creatureSize - The size of the creature who will walk the searched path + * @param {number} creatureId - The id of the creature who will walk the searched path + * @param {HexGrid} grid - The HexGrid instance to search + * @returns {Hex[]} A path of hexes or an empty array if no path is found */ export function search(start, end, creatureSize, creatureId, grid) { const openList = [];