MDL-71113 js: Bare minimum fixes to build jsdoc

blocks/timeline/amd/src/event_list.js

@@ -18,7 +18,6 @@
  * given day range.
  *
  * @module     block_timeline/event_list
- * @package    block_timeline
  * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -174,9 +173,9 @@ function(
      * @param {Number} limit Limit the result set to this number of items
      * @param {Number} daysOffset How many days (from midnight) to offset the results from
      * @param {int|undefined} daysLimit How many dates (from midnight) to limit the result to
-     * @param {int|falsey} lastId The ID of the last seen event (if any)
+     * @param {int|false} lastId The ID of the last seen event (if any)
      * @param {int|undefined} courseId Course ID to restrict events to
-     * @return {promise} A jquery promise
+     * @return {Promise} A jquery promise
      */
     var load = function(midnight, limit, daysOffset, daysLimit, lastId, courseId) {
         var startTime = midnight + (daysOffset * SECONDS_IN_DAY);

mod/forum/amd/src/local/grades/grader.js

@@ -17,7 +17,6 @@
  * This module will tie together all of the different calls the gradable module will make.
  *
  * @module     mod_forum/local/grades/grader
- * @package    mod_forum
  * @copyright  2019 Mathew May <mathew.solutions>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -65,7 +64,7 @@ const displayUserPicker = (root, html) => {
  *
  * @param {String} html
  * @param {String} js
- * @return {[*, *]}
+ * @returns {array} An array containing the HTML, and JS.
  */
 const fetchContentFromRender = (html, js) => {
     return [html, js];

mod/lti/amd/src/contentitem.js

@@ -21,7 +21,6 @@
  *
  * @module     mod_lti/contentitem
  * @class      contentitem
- * @package    mod_lti
  * @copyright  2016 Jun Pataleta <jun@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since      3.2
@@ -89,8 +88,6 @@ define(
 
         /**
          * Array of form fields for LTI tool configuration.
-         *
-         * @type {*[]}
          */
         var ltiFormFields = [
             new FormField('name', FormField.TYPES.TEXT, false, ''),

payment/amd/build/repository.min.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/repository.js"],"names":["getAvailableGateways","component","paymentArea","itemId","Ajax","call","methodname","args","paymentarea","itemid"],"mappings":"oKAwBA,uDAUO,GAAMA,CAAAA,CAAoB,CAAG,SAACC,CAAD,CAAYC,CAAZ,CAAyBC,CAAzB,CAAoC,CASpE,MAAOC,WAAKC,IAAL,CAAU,CARD,CACZC,UAAU,CAAE,qCADA,CAEZC,IAAI,CAAE,CACFN,SAAS,CAATA,CADE,CAEFO,WAAW,CAAEN,CAFX,CAGFO,MAAM,CAAEN,CAHN,CAFM,CAQC,CAAV,EAAqB,CAArB,CACV,CAVM,C","sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Repository for payment subsystem.\n *\n * @module     core_payment/repository\n * @package    core_payment\n * @copyright  2020 Shamim Rezaie <shamim@moodle.com>\n * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Returns the list of gateways that can process payments in the given currency.\n *\n * @param {string} component\n * @param {string} paymentArea\n * @param {number} itemId\n * @returns {Promise<{shortname: string, name: string, description: String}[]>}\n */\nexport const getAvailableGateways = (component, paymentArea, itemId) => {\n    const request = {\n        methodname: 'core_payment_get_available_gateways',\n        args: {\n            component,\n            paymentarea: paymentArea,\n            itemid: itemId,\n        }\n    };\n    return Ajax.call([request])[0];\n};\n"],"file":"repository.min.js"}
+{"version":3,"sources":["../src/repository.js"],"names":["getAvailableGateways","component","paymentArea","itemId","Ajax","call","methodname","args","paymentarea","itemid"],"mappings":"oKAuBA,uDAkBO,GAAMA,CAAAA,CAAoB,CAAG,SAACC,CAAD,CAAYC,CAAZ,CAAyBC,CAAzB,CAAoC,CASpE,MAAOC,WAAKC,IAAL,CAAU,CARD,CACZC,UAAU,CAAE,qCADA,CAEZC,IAAI,CAAE,CACFN,SAAS,CAATA,CADE,CAEFO,WAAW,CAAEN,CAFX,CAGFO,MAAM,CAAEN,CAHN,CAFM,CAQC,CAAV,EAAqB,CAArB,CACV,CAVM,C","sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Repository for payment subsystem.\n *\n * @module     core_payment/repository\n * @copyright  2020 Shamim Rezaie <shamim@moodle.com>\n * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * @typedef {Object} PaymentGateway A Payment Gateway\n * @property {string} shortname\n * @property {string} name\n * @property {string} description\n */\n\n/**\n * Returns the list of gateways that can process payments in the given currency.\n *\n * @method getAvailableGateways\n * @param {string} component\n * @param {string} paymentArea\n * @param {number} itemId\n * @returns {Promise<PaymentGateway[]>}\n */\nexport const getAvailableGateways = (component, paymentArea, itemId) => {\n    const request = {\n        methodname: 'core_payment_get_available_gateways',\n        args: {\n            component,\n            paymentarea: paymentArea,\n            itemid: itemId,\n        }\n    };\n    return Ajax.call([request])[0];\n};\n"],"file":"repository.min.js"}

payment/amd/src/repository.js

@@ -17,20 +17,27 @@
  * Repository for payment subsystem.
  *
  * @module     core_payment/repository
- * @package    core_payment
  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 import Ajax from 'core/ajax';
 
+/**
+ * @typedef {Object} PaymentGateway A Payment Gateway
+ * @property {string} shortname
+ * @property {string} name
+ * @property {string} description
+ */
+
 /**
  * Returns the list of gateways that can process payments in the given currency.
  *
+ * @method getAvailableGateways
  * @param {string} component
  * @param {string} paymentArea
  * @param {number} itemId
- * @returns {Promise<{shortname: string, name: string, description: String}[]>}
+ * @returns {Promise<PaymentGateway[]>}
  */
 export const getAvailableGateways = (component, paymentArea, itemId) => {
     const request = {

question/type/ddmarker/amd/src/shapes.js

@@ -21,7 +21,6 @@
  * These classes can represent shapes, let you alter them, can go to and from a string
  * representation, and can give you an SVG representation.
  *
- * @package    qtype_ddmarker
  * @subpackage shapes
  * @copyright  2018 The Open University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -218,7 +217,7 @@ define(function() {
     /**
      * Get the handles that should be offered to edit this shape, or null if not appropriate.
      *
-     * @return {[Object]} with properties moveHandle {Point} and editHandles {Point[]}
+     * @return {Object[]} with properties moveHandle {Point} and editHandles {Point[]}
      */
     Shape.prototype.getHandlePositions = function() {
         return null;