Merge pull request #12624 from ahocevar/apidoc-undefined

Improve API docs for optional properties
This commit is contained in:
Andreas Hocevar
2021-09-05 09:30:04 +02:00
committed by GitHub

View File

@@ -70,7 +70,7 @@
<?js if (!param.subparams) {?> <?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) + (param.optional && typeof param.defaultvalue === 'undefined' && param.type.names.indexOf('undefined') === -1 ? ' | undefined' : '') ?>
<?js if (typeof param.defaultvalue !== 'undefined') { ?> <?js if (typeof param.defaultvalue !== 'undefined') { ?>
(defaults to <?js= self.htmlsafe(param.defaultvalue) ?>) (defaults to <?js= self.htmlsafe(param.defaultvalue) ?>)
<?js } ?> <?js } ?>