Fix up JSDocs, and make compat with closure

Author: davemevans

.jscsrc

@@ -21,5 +21,16 @@
     "validateParameterSeparator": ", ",
     "disallowMultipleVarDecl": {
         "allExcept": ["undefined"]
+    },
+    "jsDoc": {
+        "checkTypes": "strictNativeCase",
+        "checkParamExistence": true,
+        "checkParamNames": true,
+        "requireParamTypes": true,
+        "checkRedundantParams": true,
+        "checkReturnTypes": true,
+        "checkRedundantReturns": true,
+        "requireReturnTypes": true,
+        "checkTypes": true
     }
 }

src/core/Debug.js

@@ -82,7 +82,7 @@ function Debug() {
     }
     /**
      * This method will allow you send log messages to either the browser's console and/or dispatch an event to capture at the media player level.
-     * @param arguments The message you want to log. The Arguments object is supported for this method so you can send in comma separated logging items.
+     * @param {...*} arguments The message you want to log. The Arguments object is supported for this method so you can send in comma separated logging items.
      * @memberof module:Debug
      * @instance
      */
@@ -124,4 +124,4 @@ function Debug() {
 }
 
 Debug.__dashjs_factory_name = 'Debug';
-export default FactoryMaker.getSingletonFactory(Debug);
+export default FactoryMaker.getSingletonFactory(Debug);

src/core/FactoryMaker.js

@@ -29,7 +29,7 @@
  *  POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * @Module FactoryMaker
+ * @module FactoryMaker
  */
 let FactoryMaker = (function () {
 
@@ -49,8 +49,8 @@ let FactoryMaker = (function () {
      * this.factory.getSingletonInstance(this.context, 'VideoModel')
      * will return the video model for use in the extended object.
      *
-     * @param context {Object} injected into extended object as this.context
-     * @param className {String} string name found in all dash.js objects
+     * @param {Object} context - injected into extended object as this.context
+     * @param {string} className - string name found in all dash.js objects
      * with name __dashjs_factory_name Will be at the bottom. Will be the same as the object's name.
      * @returns {*} Context aware instance of specified singleton name.
      * @memberof module:FactoryMaker
@@ -69,9 +69,9 @@ let FactoryMaker = (function () {
     /**
      * Use this method to add an singleton instance to the system.  Useful for unit testing to mock objects etc.
      *
-     * @param context
-     * @param className
-     * @param instance
+     * @param {Object} context
+     * @param {string} className
+     * @param {Object} instance
      * @memberof module:FactoryMaker
      * @instance
      */
@@ -166,4 +166,4 @@ let FactoryMaker = (function () {
 
 }());
 
-export default FactoryMaker;
+export default FactoryMaker;

src/dash/DashMetrics.js

@@ -35,7 +35,7 @@ import DashManifestModel from './models/DashManifestModel.js';
 import FactoryMaker from '../core/FactoryMaker.js';
 
 /**
- * @Module DashMetrics
+ * @module DashMetrics
  */
 function DashMetrics() {
 
@@ -60,8 +60,8 @@ function DashMetrics() {
 
     /**
      *
-     * @param representationId
-     * @param periodIdx
+     * @param {string} representationId
+     * @param {number} periodIdx
      * @returns {*}
      */
     function getIndexForRepresentation(representationId, periodIdx) {
@@ -76,9 +76,9 @@ function DashMetrics() {
     /**
      * This method returns the current max index based on what is defined in the MPD.
      *
-     * @param bufferType - String 'audio' or 'video',
-     * @param periodIdx - Make sure this is the period index not id
-     * @return int
+     * @param {string} bufferType - String 'audio' or 'video',
+     * @param {number} periodIdx - Make sure this is the period index not id
+     * @return {number}
      * @memberof module:DashMetrics
      * @instance
      */
@@ -95,9 +95,9 @@ function DashMetrics() {
      * This method returns the current max index correlated to the max allowed bitrate
      * explicitly set via the MediaPlayer's API setMaxAllowedBitrateFor.
      *
-     * @param bufferType - String 'audio' or 'video',
-     * @param periodId - Make sure this is the period id not index.
-     * @return int
+     * @param {string} bufferType - String 'audio' or 'video',
+     * @param {number} periodId - Make sure this is the period id not index.
+     * @return {number}
      * @see {@link module:MediaPlayer#setMaxAllowedBitrateFor setMaxAllowedBitrateFor()}
      * @see {@link DashMetrics#getMaxIndexForBufferType getMaxIndexForBufferType()}
      * @memberof module:DashMetrics
@@ -115,7 +115,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -142,7 +142,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -161,7 +161,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {number}
      * @memberof module:DashMetrics
      * @instance
@@ -180,7 +180,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {null|*|vo}
      * @memberof module:DashMetrics
      * @instance
@@ -190,7 +190,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -224,7 +224,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -238,7 +238,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -263,7 +263,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -289,7 +289,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -315,7 +315,7 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
+     * @param {MetricsList} metrics
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -341,8 +341,8 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
-     * @param id
+     * @param {MetricsList} metrics
+     * @param {string} id
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance
@@ -372,8 +372,8 @@ function DashMetrics() {
     }
 
     /**
-     * @param metrics
-     * @param id
+     * @param {MetricsList} metrics
+     * @param {string} id
      * @returns {*}
      * @memberof module:DashMetrics
      * @instance