Fixed Grunt jsdoc for es6. Added one doc to factory maker to test. Added Readme.md to docs as home page.

Author: Dan Sparacio

Gruntfile.js

@@ -195,7 +195,7 @@ module.exports = function (grunt) {
         jsdoc: {
             dist: {
                 options: {
-                    destination: 'docs/jsdocs',
+                    destination: 'dist/jsdoc',
                     configure: 'build/jsdoc/jsdoc_conf.json'
                 }
             }

build/jsdoc/jsdoc_conf.json

@@ -3,7 +3,7 @@
         "allowUnknownTags": true
     },
     "source": {
-        "include": ["./src/"]
+        "include": ["./src/", "README.md"]
     },
     "plugins": [ "plugins/markdown" ],
     "templates": {

package.json

@@ -27,12 +27,12 @@
     "grunt-exorcise": "^2.1.0",
     "grunt-githooks": "^0.5.0",
     "grunt-jscs": "^2.5.0",
-    "grunt-jsdoc": "^0.5.8",
-    "grunt-mocha-istanbul": "^3.0.1",
+    "grunt-jsdoc": "^0.6.0",
     "ink-docstrap": "^1.1.0",
+    "jsdoc": "^3.4.0",
+    "grunt-mocha-istanbul": "^3.0.1",
     "iron-mocha": "^1.0.3",
     "istanbul": "^0.4.1",
-    "jsdoc": "^3.4.0",
     "load-grunt-tasks": "^3.1.0",
     "mocha": "^2.3.4",
     "sinon": "^1.17.2",

src/core/FactoryMaker.js

@@ -29,7 +29,7 @@
  *  POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * @ignore
+ * @Module FactoryMaker
  */
 let FactoryMaker = (function () {
 
@@ -44,6 +44,18 @@ let FactoryMaker = (function () {
         }
     }
 
+    /**
+     * Use this method from your extended object.  this.factory is injected into your object.
+     * 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 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#getSingletonInstance
+     * @instance
+     */
     function getSingletonInstance(context, className) {
         for (let i in singletonContexts) {
             let obj = singletonContexts[i];
@@ -54,6 +66,12 @@ let FactoryMaker = (function () {
         return null;
     }
 
+    /**
+     *
+     * @param context
+     * @param className
+     * @param instance
+     */
     function setSingletonInstance(context, className, instance) {
         for (let i in singletonContexts) {
             let obj = singletonContexts[i];