109 lines
3.2 KiB
Cheetah
109 lines
3.2 KiB
Cheetah
<?js
|
|
var params = obj;
|
|
|
|
/* sort subparams under their parent params (like opts.classname) */
|
|
var parentParam = null;
|
|
params.forEach(function(param, i) {
|
|
if (!param) { return; }
|
|
if (parentParam && param.name && param.name.startsWith(parentParam.name + '.')) {
|
|
param.name = param.name.substr(parentParam.name.length+1);
|
|
parentParam.subparams = parentParam.subparams || [];
|
|
parentParam.subparams.push(param);
|
|
params[i] = null;
|
|
}
|
|
else {
|
|
parentParam = param;
|
|
}
|
|
});
|
|
|
|
/* determine if we need extra "attributes" column */
|
|
params.hasAttributes = false;
|
|
params.hasName = false;
|
|
|
|
var colspan = 2;
|
|
params.forEach(function(param) {
|
|
if (!param) { return; }
|
|
if (param.type && param.type.names && param.type.names.includes('undefined')) {
|
|
param.optional = true;
|
|
}
|
|
if (param.name.startsWith('var_')) {
|
|
params.hasAttributes = true;
|
|
param.variable = true;
|
|
}
|
|
|
|
if (param.optional || param.nullable) {
|
|
params.hasAttributes = true;
|
|
}
|
|
|
|
if (param.name) {
|
|
params.hasName = true;
|
|
}
|
|
|
|
});
|
|
?>
|
|
|
|
<table class="params">
|
|
<thead>
|
|
<tr>
|
|
<?js if (params.hasName) {?>
|
|
<th>Name</th>
|
|
<?js } ?>
|
|
|
|
<th>Type</th>
|
|
|
|
<th class="last">Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
<?js
|
|
var self = this;
|
|
|
|
if (params[0].name === 'options' && params[0].subparams) {
|
|
var onlyOptions = true;
|
|
for (var i = 1; i < params.length; ++i) {
|
|
if (params[i]) {
|
|
onlyOptions = false;
|
|
break;
|
|
}
|
|
}
|
|
if (onlyOptions) {
|
|
var hasName = params.hasName;
|
|
params = params[0].subparams;
|
|
params.hasName = hasName;
|
|
}
|
|
}
|
|
|
|
params.forEach(function(param) {
|
|
if (!param) { return; }
|
|
?>
|
|
|
|
<tr class="<?js= (param.stability && param.stability !== 'stable') ? 'unstable' : '' ?>">
|
|
<?js if (params.hasName) {?>
|
|
<td class="name"><code><?js= param.name ?></code></td>
|
|
<?js } ?>
|
|
|
|
<?js if (!param.subparams) {?>
|
|
<td class="type">
|
|
<?js if (param.type && param.type.names) {?>
|
|
<?js= self.partial('type.tmpl', param.type.names) + (param.optional && typeof param.defaultvalue === 'undefined' && !param.type.names.includes('undefined') ? ' | undefined' : '') ?>
|
|
<?js if (typeof param.defaultvalue !== 'undefined') { ?>
|
|
(defaults to <?js= self.htmlsafe(param.defaultvalue) ?>)
|
|
<?js } ?>
|
|
<?js } ?>
|
|
</td>
|
|
|
|
<?js } ?>
|
|
|
|
<td<?js= (param.subparams ? ' colspan=' + colspan : ' ') ?> class="description last">
|
|
<?js if (param.stability) { ?>
|
|
<?js= self.partial('stability.tmpl', param) ?>
|
|
<?js } ?>
|
|
<?js= param.description ?><?js if (param.subparams) { ?>
|
|
<?js= self.partial('params.tmpl', param.subparams) ?>
|
|
<?js } ?></td>
|
|
</tr>
|
|
|
|
<?js }); ?>
|
|
</tbody>
|
|
</table> |