* 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
*/
* @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);
* 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
*/
*
* @param {String} html
* @param {String} js
- * @return {[*, *]}
+ * @returns {array} An array containing the HTML, and JS.
*/
const fetchContentFromRender = (html, js) => {
return [html, js];
*
* @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
/**
* Array of form fields for LTI tool configuration.
- *
- * @type {*[]}
*/
var ltiFormFields = [
new FormField('name', FormField.TYPES.TEXT, false, ''),
* 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 = {
* 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
/**
* 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;