jsdoc-defs.js

/**
 * Global definitions for JSDoc
 */

/**
 * A callback for handling AngularJS $http service responses.
 *
 * @callback $httpCallback
 * @param {Object} response - An AngularJS $http service response object.
 * @returns {*} any value that may be passed into a Promise chain.
 */

/**
 * A callback for handling AngularJS $http service responses (response data only).
 *
 * @callback $httpDataCallback
 * @param {Object} data - The `data` property from an AngularJS $http service response object.
 * @returns {*} any value that may be passed into a Promise chain.
 */

/**
 * An object containing the previous and current instructor states.
 * @typedef {Object} InstructorStateObject
 * @property {Object} previousInstructorState
 * @property {Object} currentInstructorState
 */