MDL-71113 js: Bare minimum fixes to build jsdoc
authorAndrew Nicols <andrew@nicols.co.uk>
Mon, 15 Mar 2021 01:50:09 +0000 (09:50 +0800)
committerAndrew Nicols <andrew@nicols.co.uk>
Fri, 18 Jun 2021 01:38:04 +0000 (09:38 +0800)
blocks/timeline/amd/build/event_list.min.js.map
blocks/timeline/amd/src/event_list.js
mod/forum/amd/build/local/grades/grader.min.js.map
mod/forum/amd/src/local/grades/grader.js
mod/lti/amd/build/contentitem.min.js.map
mod/lti/amd/src/contentitem.js
payment/amd/build/repository.min.js.map
payment/amd/src/repository.js
question/type/ddmarker/amd/build/shapes.min.js.map
question/type/ddmarker/amd/src/shapes.js

index 441b4e2..be868ae 100644 (file)
Binary files a/blocks/timeline/amd/build/event_list.min.js.map and b/blocks/timeline/amd/build/event_list.min.js.map differ
index f1bd1b4..785939b 100644 (file)
@@ -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);
index 6a89c72..3814b6a 100644 (file)
Binary files a/mod/forum/amd/build/local/grades/grader.min.js.map and b/mod/forum/amd/build/local/grades/grader.min.js.map differ
index 06bda81..d95d48b 100644 (file)
@@ -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];
index 198ab86..8162972 100644 (file)
Binary files a/mod/lti/amd/build/contentitem.min.js.map and b/mod/lti/amd/build/contentitem.min.js.map differ
index 74fb54e..1c8cccc 100644 (file)
@@ -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, ''),
index 47d3a2a..270ded7 100644 (file)
Binary files a/payment/amd/build/repository.min.js.map and b/payment/amd/build/repository.min.js.map differ
index c3e71b2..169dee5 100644 (file)
  * 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 = {
index 8bc1858..598e843 100644 (file)
Binary files a/question/type/ddmarker/amd/build/shapes.min.js.map and b/question/type/ddmarker/amd/build/shapes.min.js.map differ
index 5fd765e..a9631f4 100644 (file)
@@ -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;