ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Only document enums when they have API properties

Browse Source
This commit is contained in:
Andreas Hocevar
2020-03-28 10:51:25 +01:00
parent a6a5b72c57
commit dd44ecf185
2 changed files with 9 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
config/jsdoc/api/plugins/api.js
View File

@@ -73,9 +73,6 @@ function includeAugments(doclet) {
});
}
cls._hideConstructor = true;
if (!cls.undocumented) {
cls._documented = true;
}
}
}
}
@@ -182,13 +179,14 @@ exports.handlers = {
doclet._hideConstructor = true;
includeAugments(doclet);
sortOtherMembers(doclet);
} else if (!doclet._hideConstructor
&& !(doclet.longname in defaultExports && byLongname[doclet.longname].some(d => d.isEnum))) {
} else if (!doclet._hideConstructor) {
// Remove all other undocumented symbols
doclet.undocumented = true;
}
if (doclet._documented) {
delete doclet.undocumented;
if (doclet.memberof && byLongname[doclet.memberof] &&
byLongname[doclet.memberof][0].isEnum &&
!byLongname[doclet.memberof][0].properties.some(p => p.stability)) {
byLongname[doclet.memberof][0].undocumented = true;
}
}
},