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 ( +
{this.renderImport(cls, mod)}
-