diff --git a/src/js/assignJS.js b/src/js/assignJS.js index 04c9d6448f7f32b1ee68fbda9b5286796802b1c9..043d5d9654e58d0d305cc1cab735d442ead4d8ab 100644 --- a/src/js/assignJS.js +++ b/src/js/assignJS.js @@ -783,7 +783,7 @@ App.UI.jobLinks = function() { }; /** - * Generates assignment links + * Generates assignment links (as Sugarcube markup) * @param {number} ID slave ID * @param {string} [passage] optional next passage to go to * @param {linkCallback} [callback] @@ -807,6 +807,11 @@ App.UI.jobLinks = function() { return penthouseJobs.join(" | "); } + /** + * Generates transfer links (as Sugarcube markup) + * @param {number} ID slave ID + * @returns {string} + */ function transferLinks(ID) { /** @type {string[]} */ const transfers = []; @@ -826,7 +831,7 @@ App.UI.jobLinks = function() { } /** - * + * Generates assigment links (as a DocumentFragment) * @param {number} ID * @param {string} passage * @param {assignmentCallback} [callback] @@ -855,6 +860,12 @@ App.UI.jobLinks = function() { return res; } + /** + * Generates transfer links (as a DocumentFragment) + * @param {number} ID + * @param {assignmentCallback} [callback] + * @returns {DocumentFragment} + */ function transfersFragment(ID, callback) { /** @type {HTMLElement[]} */ const transfers = [];