can generate jsdoc; private methods marked as such

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

diff --git a/jsdoc-toolkit/app/plugins/tagParamConfig.js b/jsdoc-toolkit/app/plugins/tagParamConfig.js
new file mode 100644 (file)
index 0000000..3ea8a1b
--- /dev/null
+++ b/jsdoc-toolkit/app/plugins/tagParamConfig.js
@@ -0,0 +1,31 @@
+JSDOC.PluginManager.registerPlugin(
+       "JSDOC.tagParamConfig",
+       {
+               onDocCommentTags: function(comment) {
+                       var currentParam = null;
+                       var tags = comment.tags;
+                       for (var i = 0, l = tags.length; i < l; i++) {
+                               
+                               if (tags[i].title == "param") {
+                                       if (tags[i].name.indexOf(".") == -1) {
+                                               currentParam = i;
+                                       }
+                               }
+                               else if (tags[i].title == "config") {
+                                       tags[i].title = "param";
+                                       if (currentParam == null) {
+                                               tags[i].name = "arguments"+"."+tags[i].name;
+                                       }
+                                       else if (tags[i].name.indexOf(tags[currentParam].name+".") != 0) {
+                                               tags[i].name = tags[currentParam].name+"."+tags[i].name;
+                                       }
+                                       currentParam != null
+                                       //tags[currentParam].properties.push(tags[i]);
+                               }
+                               else {
+                                       currentParam = null;
+                               }
+                       }
+               }
+       }
+);