can generate jsdoc; private methods marked as such

[dygraphs.git] / jsdoc-toolkit / app / plugins / frameworkPrototype.js

diff --git a/jsdoc-toolkit/app/plugins/frameworkPrototype.js b/jsdoc-toolkit/app/plugins/frameworkPrototype.js
new file mode 100644 (file)
index 0000000..9c41751
--- /dev/null
+++ b/jsdoc-toolkit/app/plugins/frameworkPrototype.js
@@ -0,0 +1,16 @@
+JSDOC.PluginManager.registerPlugin(
+       "JSDOC.frameworkPrototype",
+       {
+               onPrototypeClassCreate: function(classCreator) {
+                       var desc = "";
+                       if (classCreator.comment) {
+                               desc = classCreator.comment;
+                       }
+                       var insert = desc+"/** @name "+classCreator.name+"\n@constructor\n@scope "+classCreator.name+".prototype */"
+                       
+                       insert = insert.replace(/\*\/\/\*\*/g, "\n");
+                       /*DEBUG*///print("insert is "+insert);
+                       classCreator.addComment.data = insert;
+               }
+       }
+);