Update to be on par with JSDoc features

Author: ar2rsawseen

fixtures/generators/generator.js

@@ -0,0 +1,18 @@
+/**
+ * Generate numbers in the Fibonacci sequence.
+ *
+ * @generator
+ * @function fibonacci
+ * @yields {number} The next number in the Fibonacci sequence.
+ */
+ 
+ function *fibonacci(n) {
+  const infinite = !n && n !== 0;
+  let current = 0;
+  let next = 1;
+  
+  while (infinite || n--) {
+    yield current;
+    [current, next] = [next, current + next];
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docdash",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami",
   "main": "publish.js",
   "scripts": {

publish.js

@@ -83,6 +83,12 @@ function needsSignature(doclet) {
             }
         }
     }
+    // and namespaces that are functions get a signature (but finding them is a		
+    // bit messy)		
+    else if (doclet.kind === 'namespace' && doclet.meta && doclet.meta.code &&		
+        doclet.meta.code.type && doclet.meta.code.type.match(/[Ff]unction/)) {		
+        needsSig = true;		
+    }
 
     return needsSig;
 }
@@ -168,12 +174,13 @@ function addSignatureReturns(f) {
     var attribsString = '';
     var returnTypes = [];
     var returnTypesString = '';
+    var source = f.yields || f.returns;
 
     // jam all the return-type attributes into an array. this could create odd results (for example,
     // if there are both nullable and non-nullable return types), but let's assume that most people
     // who use multiple @return tags aren't using Closure Compiler type annotations, and vice-versa.
-    if (f.returns) {
-        f.returns.forEach(function(item) {
+    if (source) {
+        source.forEach(function(item) {
             helper.getAttribs(item).forEach(function(attrib) {
                 if (attribs.indexOf(attrib) === -1) {
                     attribs.push(attrib);
@@ -184,8 +191,8 @@ function addSignatureReturns(f) {
         attribsString = buildAttribsString(attribs);
     }
 
-    if (f.returns) {
-        returnTypes = addNonParamAttributes(f.returns);
+    if (source) {
+        returnTypes = addNonParamAttributes(source);
     }
     if (returnTypes.length) {
         returnTypesString = util.format( ' → %s{%s}', attribsString, returnTypes.join('|') );

tmpl/container.tmpl

@@ -93,6 +93,18 @@
             <dd><?js if (c.summary) { ?><?js= c.summary ?><?js } ?></dd>
         <?js }); ?></dl>
     <?js } ?>
+    
+    <?js
+        var interfaces = self.find({kind: 'interface', memberof: doc.longname});		
+        if (!isGlobalPage && interfaces && interfaces.length) {		
+    ?>		
+	    <h3 class="subsection-title">Interfaces</h3>		
+	
+	    <dl><?js interfaces.forEach(function(i) { ?>		
+	        <dt><?js= self.linkto(i.longname, i.name) ?></dt>		
+	        <dd><?js if (i.summary) { ?><?js= i.summary ?><?js } ?></dd>		
+	    <?js }); ?></dl>		
+	<?js } ?>
 
      <?js
         var mixins = self.find({kind: 'mixin', memberof: doc.longname});

tmpl/mainpage.tmpl

@@ -3,6 +3,11 @@ var data = obj;
 var self = this;
 ?>
 
+<?js if (data.kind === 'package') { ?>
+    <section class="package">
+        <h3><?js= data.name ?> <?js= data.version ?></h3>		
+    </section>
+<?js } ?>
 <?js if (data.readme) { ?>
     <section class="readme">
         <article><?js= data.readme ?></article>

tmpl/method.tmpl

@@ -87,6 +87,18 @@ var self = this;
 <?js }); ?></ul>
 <?js } ?>
 
+<?js if (data.modifies && modifies.length) {?>		
+<h5>Modifies:</h5>		
+<?js if (modifies.length > 1) { ?><ul><?js		
+    modifies.forEach(function(m) { ?>		
+        <li><?js= self.partial('modifies.tmpl', m) ?></li>		
+    <?js });		
+?></ul><?js } else {		
+    modifies.forEach(function(m) { ?>		
+        <?js= self.partial('modifies.tmpl', m) ?>		
+    <?js });		
+} } ?>
+
 <?js if (data.exceptions && exceptions.length) { ?>
 <h5>Throws:</h5>
 <?js if (exceptions.length > 1) { ?><ul><?js
@@ -111,3 +123,14 @@ var self = this;
     <?js });
 } } ?>
 
+<?js if (data.yields && yields.length) { ?>		
+<h5>Yields:</h5>		
+<?js if (yields.length > 1) { ?><ul><?js		
+    yields.forEach(function(r) { ?>		
+        <li><?js= self.partial('returns.tmpl', r) ?></li>		
+    <?js });		
+?></ul><?js } else {		
+    yields.forEach(function(r) { ?>		
+        <?js= self.partial('returns.tmpl', r) ?>		
+    <?js });		
+} } ?>

tmpl/modifies.tmpl

@@ -0,0 +1,14 @@
+<?js
+var data = obj || {};
+?>
+
+<?js if (data.type && data.type.names) {?>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        <?js= this.partial('type.tmpl', data.type.names) ?>
+    </dd>
+</dl>
+<?js } ?>

tmpl/params.tmpl

@@ -11,7 +11,14 @@
         }
 
         if (parentParam && parentParam.name && param.name) {
-            paramRegExp = new RegExp('^(?:' + parentParam.name + '(?:\\[\\])*)\\.(.+)$');
+            try {
+                paramRegExp = new RegExp('^(?:' + parentParam.name + '(?:\\[\\])*)\\.(.+)$');
+            }		
+            catch (e) {		
+                // there's probably a typo in the JSDoc comment that resulted in a weird		
+                // parameter name		
+                return;		
+            }
 
             if ( paramRegExp.test(param.name) ) {
                 param.name = RegExp.$1;