Merge pull request #7116 from jdfreder/jsdoc-tool

Use JSDoc to compile white listed JS API documentation

docs/jsdoc_config.json

@@ -0,0 +1,21 @@
+{
+    "markdown": {
+        "parser": "gfm"
+    },
+    "plugins": [ 
+        "plugins/markdown" ,
+        "jsdoc_plugin.js"
+    ],
+    "source": {
+        "include": [
+            "../IPython/html/static/notebook/js/notebook.js"
+        ]
+    },
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}

docs/jsdoc_plugin.js

@@ -0,0 +1,12 @@
+exports.handlers = {
+    newDoclet: function(e) {
+        // e.doclet will refer to the newly created doclet
+        // you can read and modify properties of that doclet if you wish
+        if (typeof e.doclet.name === 'string') {
+            if (e.doclet.name[0] == '_') {
+                console.log('Private method "' + e.doclet.longname + '" not documented.');
+                e.doclet.memberof = '<anonymous>';
+            }
+        }
+    }
+};