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

Introduces apidoc changes

Browse Source 
- Removes modules from the apidoc navigation
- Adds a weight paramater to the search to be
more accurate on searchresults
This commit is contained in:
Kai Volland
2019-09-27 17:25:01 +02:00
parent b045e4ee5b
commit d08c0baff9
4 changed files with 200 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
config/jsdoc/api/template/tmpl/navigation.tmpl
View File

@@ -1,7 +1,7 @@
<?js
var self = this;
function toShortName(name) {
return name.indexOf('module:') === 0 ? name.split('/').pop() : name;
return name.indexOf('module:') === 0 ? name.split('/').pop() : name;
}
?>
<div class="navigation">
@@ -10,29 +10,21 @@ function toShortName(name) {
</div>
<ul class="list">
<?js
let navbuilder;
this.nav.forEach(navbuilder = function (item) {
this.nav.forEach(function (item) {
?>
<li class="item" data-name="<?js= item.longname ?>">
<li class="item" data-name="<?js= item.longname ?>" data-shortname="<?js= item.name.toLowerCase() ?>">
<span class="title">
<?js= self.linkto(item.longname, item.type === 'module' ? item.longname.replace('module:', '') : item.name) ?>
<?js= self.linkto(item.longname, item.prettyname) ?>
<?js if (item.type === 'namespace' &&
(item.members.length + item.typedefs.length + item.methods.length +
item.events.length > 0)) { ?>
item.events.length > 0)) { ?>
<?js } ?>
</span>
<ul class="members itemMembers">
<?js
if (item.classes.length) {
?>
<span class="subtitle">Classes</span>
<?js
item.classes.forEach(function (v) {
navbuilder(v);
});
}
?>
</ul>
<?js if (item.module && item.module.longname) { ?>
<span class="modulelink">
<?js= self.linkto(item.module.longname, '↳ module') ?>
</span>
<?js } ?>
<ul class="members itemMembers">
<?js
if (item.members.length) {