fix: function's returns are missing (#13)

googleapis · May 20, 2020 · 2b79e8f · 2b79e8f
1 parent 60d8724
commit 2b79e8f
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 23 deletions.
diff --git a/static/styles/jsdoc-default.css b/static/styles/jsdoc-default.css
@@ -504,7 +504,7 @@ footer {
    max-width: 800px;
 }
 
-.params, .props {
+.params, .returns, .props {
     border-spacing: 0;
     border: 1px solid #ddd;
     border-radius: 3px;
@@ -518,34 +518,34 @@ footer {
     font-size: 100%;
 }
 
-.params td, .params th, .props td, .props th {
+.params td, .params th,.returns td, .returns th, .props td, .props th {
     margin: 0px;
     text-align: left;
     vertical-align: top;
     padding: 10px;
     display: table-cell;
 }
 
-.params td {
+.params td, .returns td {
     border-top: 1px solid #eee;
 }
 
-.params thead tr, .props thead tr {
+.params thead tr, .returns thead tr,.props thead tr {
     background-color: #fff;
     font-weight: bold;
 }
 
-.params .params thead tr, .props .props thead tr {
+.params .params thead tr, .returns .returns thead tr, .props .props thead tr {
     background-color: #fff;
     font-weight: bold;
 }
 
-.params td.description>p:first-child, .props td.description>p:first-child {
+.params td.description>p:first-child, .returns td.description>p:first-child, .props td.description>p:first-child {
     margin-top: 0;
     padding-top: 0;
 }
 
-.params td.description>p:last-child, .props td.description>p:last-child {
+.params td.description>p:last-child, .returns td.description>p:last-child, .props td.description>p:last-child {
     margin-bottom: 0;
     padding-bottom: 0;
 }
@@ -737,7 +737,7 @@ table tbody td {
     /*word-wrap: break-word;*/
 }
 
-td table.params, td table.props {
+td table.params, td table.returns, td table.props {
     border: 0;
 }
 

diff --git a/tmpl/method.tmpl b/tmpl/method.tmpl
@@ -51,6 +51,11 @@
   <?js= this.partial('params.tmpl', params) ?>
 <?js } ?>
 
+<?js if (data.returns && returns.length) { ?>
+  <h5>Returns:</h5>
+  <?js= this.partial('returns.tmpl', returns) ?>
+<?js } ?>
+
 <?js= this.partial('details.tmpl', data) ?>
 
 <?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
@@ -112,7 +117,7 @@
     exceptions.forEach(function(r) { ?>
       <?js= self.partial('exceptions.tmpl', r) ?>
     <?js });
-  } 
+  }
 } ?>
 
 <?js if (data.examples && examples.length) { ?>

diff --git a/tmpl/returns.tmpl b/tmpl/returns.tmpl
@@ -1,17 +1,33 @@
 <?js
-var data = obj || {};
-if (data.description) {
+var returns = obj;
 ?>
-  <div class="param-desc">
-    <?js= description ?>
-  </div>
-<?js } ?>
 
-<?js if (data.type && data.type.names) {?>
-  <dl class="param-type">
-    <dt>Type</dt>
-    <dd>
-      <?js= this.partial('type.tmpl', data.type.names) ?>
-    </dd>
-  </dl>
-<?js } ?>
+<table class="returns">
+  <thead>
+    <tr>
+      <th>Type</th>
+      <th class="last">Description</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <?js
+      var self = this;
+      returns.forEach(item => {
+        if (!item) { return; }
+    ?>
+      <tr>
+        <td class="type">
+          <?js if (item.type && item.type.names) {?>
+            <?js= self.partial('type.tmpl', item.type.names) ?>
+          <?js } ?>
+        </td>
+
+        <td class="description">
+          <?js= item.description ?>
+        </td>
+      </tr>
+    <?js }
+  ); ?>
+  </tbody>
+</table>