From 54c438997f2f8fe9c2074a6668967950d3ae11b9 Mon Sep 17 00:00:00 2001
From: ahocevar <andreas.hocevar@gmail.com>
Date: Mon, 21 May 2018 13:19:59 +0200
Subject: [PATCH] Render constructor params

---
 config/jsdoc/info/publish.js |  3 ++-
 site/src/pages/docs.js       | 23 ++++++++++++++++++++++-
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/config/jsdoc/info/publish.js b/config/jsdoc/info/publish.js
index 1225e63617..9062985223 100644
--- a/config/jsdoc/info/publish.js
+++ b/config/jsdoc/info/publish.js
@@ -92,7 +92,8 @@ exports.publish = function(data, opts) {
         const params = [];
         doc.params.forEach(function(param) {
           const paramInfo = {
-            name: param.name
+            name: param.name,
+            description: param.description
           };
           params.push(paramInfo);
           paramInfo.types = getTypes(param.type.names);
diff --git a/site/src/pages/docs.js b/site/src/pages/docs.js
index 48a38bcc35..a89181b0da 100644
--- a/site/src/pages/docs.js
+++ b/site/src/pages/docs.js
@@ -82,12 +82,33 @@ class Docs extends Component {
     );
   }
 
+  renderParams(params) {
+    //TODO Render types in a more structured way (like in default template?)
+    //TODO Use markdown for description
+    return (
+      <ul>
+        {params.map(param => (
+          <li key={param.name}>
+            {param.name}: {param.types.join('|')}
+            <br />
+            {param.description}
+          </li>
+        ))}
+      </ul>
+    );
+  }
+
   renderConstructor(cls, mod) {
     if (cls in mod.classes && cls in mod.classes[cls]) {
+      const params = mod.classes[cls][cls].params;
       return (
         <div>
           <p>{this.renderImport(cls, mod)}</p>
-          <h4>new {getName(cls)}()</h4>
+          <h4>
+            new {getName(cls)}({params.map(p => p.name).join(', ')})
+          </h4>
+          <h5>Parameters</h5>
+          {this.renderParams(params)}
         </div>
       );
     }