Recursively document subparams and span table columns

This commit is contained in:
Andreas Hocevar
2014-04-30 17:58:00 +02:00
parent 7271b50d5a
commit 25dd0127e9
2 changed files with 7 additions and 4 deletions
+1 -3
View File
@@ -14,9 +14,7 @@ function addSubparams(params) {
var name = types[k]; var name = types[k];
if (name in olxTypes) { if (name in olxTypes) {
param.subparams = olxTypes[name]; param.subparams = olxTypes[name];
// TODO Change template before recursing here, because the table gets addSubparams(param.subparams);
// too wide.
//addSubparams(param.subparams);
// TODO Do we need to support multiple object literal types per // TODO Do we need to support multiple object literal types per
// param? // param?
break; break;
+6 -1
View File
@@ -21,10 +21,12 @@
params.hasDefault = false; params.hasDefault = false;
params.hasName = false; params.hasName = false;
var colspan = 2;
params.forEach(function(param) { params.forEach(function(param) {
if (!param) { return; } if (!param) { return; }
if (param.optional || param.nullable) { if (param.optional || param.nullable) {
++colspan;
params.hasAttributes = true; params.hasAttributes = true;
} }
@@ -33,6 +35,7 @@
} }
if (typeof param.defaultvalue !== 'undefined') { if (typeof param.defaultvalue !== 'undefined') {
++colspan;
params.hasDefault = true; params.hasDefault = true;
} }
}); });
@@ -71,6 +74,7 @@
<td class="name"><code><?js= param.name.replace(/^opt_/, "") ?></code></td> <td class="name"><code><?js= param.name.replace(/^opt_/, "") ?></code></td>
<?js } ?> <?js } ?>
<?js if (!param.subparams) {?>
<td class="type"> <td class="type">
<?js if (param.type && param.type.names) {?> <?js if (param.type && param.type.names) {?>
<?js= self.partial('type.tmpl', param.type.names) ?> <?js= self.partial('type.tmpl', param.type.names) ?>
@@ -96,8 +100,9 @@
<?js } ?> <?js } ?>
</td> </td>
<?js } ?> <?js } ?>
<?js } ?>
<td class="description last"><?js= param.description ?><?js if (param.subparams) { ?> <td<?js= (param.subparams ? ' colspan=' + colspan : ' ') ?> class="description last"><?js= param.description ?><?js if (param.subparams) { ?>
<h6>Properties</h6> <h6>Properties</h6>
<?js= self.partial('params.tmpl', param.subparams) ?> <?js= self.partial('params.tmpl', param.subparams) ?>
<?js } ?></td> <?js } ?></td>