jsdoc - PIXI documentation filtering

Added the filterpixi.js jsdoc plugin which marks some PIXI
interaction-related methods and properties as private. This ensures that
they do not show up in the final Phaser documentation.

Author: pnstickne

tasks/jsdoc-conf.json

@@ -20,8 +20,8 @@
             "./src/system/", 
             "./src/tilemap/", 
             "./src/time/", 
-            "./src/tween/", 
-            "./src/utils/" 
+            "./src/tween/",
+            "./src/utils/"
         ],
         "exclude": [
             "./src/physics/p2/p2.js"
@@ -30,6 +30,7 @@
         "excludePattern": "(^|\\/|\\\\)_"
     },
     "plugins"   : [
+        "./tasks/jsdoc-plugins/filterpixi",
         "./tasks/jsdoc-plugins/proptomember",
         "./tasks/jsdoc-plugins/sourceproxy",
         "plugins/markdown"

tasks/jsdoc-plugins/filterpixi.js

@@ -0,0 +1,42 @@
+/**
+* Mark various PIXI properties/methods as private if they are not relevant to Phaser. 
+*/
+
+var path = require('path');
+
+function docletParamsAcceptInteractionData (doclet) {
+
+    if (Array.isArray(doclet.params)) {
+        return doclet.params.some(function (p) {
+            return p.type && p.type.names.some(function (n) {
+                return n === 'PIXI.InteractionData';
+            });
+        });
+    }
+
+}
+
+var unwantedNames = {
+    'PIXI.DisplayObject#defaultCursor': 1,
+    'PIXI.DisplayObject#interactive' : 1
+};
+
+function hasUnwantedName (doclet) {
+
+    var longname = doclet.longname;
+    return unwantedNames[longname];
+
+}
+
+exports.handlers = {};
+exports.handlers.newDoclet = function (e) {
+
+    var doclet = e.doclet;
+
+    if (docletParamsAcceptInteractionData(doclet) ||
+        hasUnwantedName(doclet))
+    {
+        doclet.access = 'private';
+    }
+
+};