Add ko comment

yoooom · Apr 14, 2015 · 07c551e · 07c551e
1 parent 3915eb2
commit 07c551e
Show file tree

Hide file tree

Showing 19 changed files with 877 additions and 142 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -53,6 +53,16 @@ module.exports = function(grunt) {
             "bower_components/jquery.easing/js/jquery.easing.js",
           ],
         dest : "dist/lib"
+      },
+      doc : {
+        files: [
+          {expand : true, flatten : true, src: ["assets/jsdoc-plugin/jsdoc/ko.js"], dest: "node_modules/grunt-jsdoc/node_modules/jsdoc/plugins"},
+          {expand : true, flatten : true, src: ["assets/jsdoc-plugin/template/container.tmpl"], dest: "node_modules/jaguarjs-jsdoc/tmpl"},
+          {expand : true, flatten : true, src: ["assets/jsdoc-plugin/template/members.tmpl"], dest: "node_modules/jaguarjs-jsdoc/tmpl"},
+          {expand : true, flatten : true, src: ["assets/jsdoc-plugin/template/method.tmpl"], dest: "node_modules/jaguarjs-jsdoc/tmpl"},
+          {expand : true, flatten : true, src: ["assets/jsdoc-plugin/template/main.js"], dest: "node_modules/jaguarjs-jsdoc/static/scripts"},
+          {expand : true, flatten : true, src: ["assets/jsdoc-plugin/template/jaguar.css"], dest: "node_modules/jaguarjs-jsdoc/static/styles"}
+        ]
       }
     },
     qunit : {
@@ -90,7 +100,8 @@ module.exports = function(grunt) {
         }
     }
   });
-
+
+  grunt.registerTask("docBuild", ["copy:doc"]);
   grunt.registerTask("test", ["jshint", "qunit"]);
   grunt.registerTask("build", ["jshint", "concat", "uglify", "copy:lib", "jsdoc"]);
   grunt.registerTask("default", ["test", "concat", "uglify", "copy:lib", "jsdoc"]);

diff --git a/assets/jsdoc-plugin/jsdoc/ko.js b/assets/jsdoc-plugin/jsdoc/ko.js
@@ -0,0 +1,7 @@
+exports.defineTags = function(dictionary) {
+    dictionary.defineTag("ko", {
+        onTagged: function(doclet, tag) {
+            doclet.ko = tag.value;
+        }
+    });
+};
diff --git a/assets/jsdoc-plugin/template/container.tmpl b/assets/jsdoc-plugin/template/container.tmpl
@@ -0,0 +1,155 @@
+<?js
+    var self = this;
+    docs.forEach(function(doc, i) {
+?>
+
+<?js if (doc.kind === 'mainpage' || (doc.kind === 'package')) { ?>
+    <?js= self.partial('mainpage.tmpl', doc) ?>
+<?js } else if (doc.kind === 'source') { ?>
+    <?js= self.partial('source.tmpl', doc) ?>
+<?js } else { ?>
+
+<section>
+
+<header>
+    <h2><?js if (doc.ancestors && doc.ancestors.length) { ?>
+        <span class="ancestors"><?js= doc.ancestors.join('') ?></span>
+    <?js } ?>
+    <?js= doc.name ?>
+    <?js if (doc.variation) { ?>
+        <sup class="variation"><?js= doc.variation ?></sup>
+    <?js } ?></h2>
+    <?js if (doc.classdesc) { ?>
+        <div class="class-description"><?js= doc.classdesc ?></div>
+    <?js } ?>
+    <button id="toggle">English</button>
+</header>  
+
+<article>
+    <div class="container-overview">
+    <?js if (doc.kind === 'module' && doc.module) { ?>
+        <?js= self.partial('method.tmpl', doc.module) ?>
+    <?js } ?>
+
+    <?js if (doc.kind === 'class') { ?>
+        <?js= self.partial('method.tmpl', doc) ?>
+    <?js } else { ?>
+        <?js if (doc.description) { ?>
+            <div class="description"><?js= doc.description ?></div>
+        <?js } ?>
+
+        <?js= self.partial('details.tmpl', doc) ?>
+
+        <?js if (doc.examples && doc.examples.length) { ?>
+            <h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
+            <?js= self.partial('examples.tmpl', doc.examples) ?>
+        <?js } ?>
+    <?js } ?>
+    </div>
+
+    <?js if (doc.augments && doc.augments.length) { ?>
+        <h3 class="subsection-title">Extends</h3>
+
+        <ul><?js doc.augments.forEach(function(a) { ?>
+            <li><?js= self.linkto(a, a) ?></li>
+        <?js }); ?></ul>
+    <?js } ?>
+
+    <?js if (doc.mixes && doc.mixes.length) { ?>
+        <h3 class="subsection-title">Mixes In</h3>
+
+        <ul><?js doc.mixes.forEach(function(a) { ?>
+            <li><?js= self.linkto(a, a) ?></li>
+        <?js }); ?></ul>
+    <?js } ?>
+
+    <?js if (doc.requires && doc.requires.length) { ?>
+        <h3 class="subsection-title">Requires</h3>
+
+        <ul><?js doc.requires.forEach(function(r) { ?>
+            <li><?js= self.linkto(r, r) ?></li>
+        <?js }); ?></ul>
+    <?js } ?>
+
+    <?js
+        var classes = self.find({kind: 'class', memberof: doc.longname}); 
+        if (doc.kind !== 'globalobj' && classes && classes.length) { 
+    ?>
+        <h3 class="subsection-title">Classes</h3>
+
+        <dl><?js classes.forEach(function(c) { ?>
+            <dt><?js= self.linkto(c.longname, c.name) ?></dt>
+            <dd><?js if (c.summary) { ?><?js= c.summary ?><?js } ?></dd>
+        <?js }); ?></dl>
+    <?js } ?>
+
+    <?js
+        var namespaces = self.find({kind: 'namespace', memberof: doc.longname}); 
+        if (doc.kind !== 'globalobj' && namespaces && namespaces.length) { 
+    ?>
+        <h3 class="subsection-title">Namespaces</h3>
+
+        <dl><?js namespaces.forEach(function(n) { ?>
+            <dt><a href="namespaces.html#<?js= n.longname ?>"><?js= self.linkto(n.longname, n.name) ?></a></dt>
+            <dd><?js if (n.summary) { ?><?js= n.summary ?><?js } ?></dd>
+        <?js }); ?></dl>
+    <?js } ?>
+
+    <?js
+        var members = self.find({kind: 'member', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
+        if (members && members.length && members.forEach) { 
+    ?>
+        <h3 class="subsection-title">Members</h3>
+
+        <dl><?js members.forEach(function(p) { ?>
+            <?js= self.partial('members.tmpl', p) ?>
+        <?js }); ?></dl>
+    <?js } ?>
+
+    <?js
+        var methods = self.find({kind: 'function', memberof: title === 'Global' ? {isUndefined: true} : doc.longname});
+        if (methods && methods.length && methods.forEach) { 
+    ?>
+        <h3 class="subsection-title">Methods</h3>
+
+        <dl><?js methods.forEach(function(m) { ?>
+            <?js= self.partial('method.tmpl', m) ?>
+        <?js }); ?></dl>
+    <?js } ?>
+
+    <?js
+        var typedefs = self.find({kind: 'typedef', memberof: title === 'Global' ? {isUndefined: true} : doc.longname}); 
+        if (typedefs && typedefs.length && typedefs.forEach) { 
+    ?>
+        <h3 class="subsection-title">Type Definitions</h3>
+
+        <dl><?js typedefs.forEach(function(e) {
+                if (e.signature) {
+            ?>
+                <?js= self.partial('method.tmpl', e) ?>
+            <?js
+                }
+                else {
+            ?>
+                <?js= self.partial('members.tmpl', e) ?>
+            <?js
+                }
+            }); ?></dl>
+    <?js } ?>
+
+    <?js
+        var events = self.find({kind: 'event', memberof: title === 'Global' ? {isUndefined: true} : doc.longname}); 
+        if (events && events.length && events.forEach) { 
+    ?>
+        <h3 class="subsection-title">Events</h3>
+
+        <dl><?js events.forEach(function(e) { ?>
+            <?js= self.partial('method.tmpl', e) ?>
+        <?js }); ?></dl>
+    <?js } ?>
+</article>
+
+</section>  
+<?js } ?>
+
+<?js }); ?>