Skip to content

Adding typedefs for members as well and styling. #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding typedefs for members as well and styling. #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion publish.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
var displayName;
var methods = find({kind:'function', memberof: item.longname});
var members = find({kind:'member', memberof: item.longname});
var typedefs = find({kind:'typedef', memberof: item.longname});
var conf = env && env.conf || {};
var classes = '';

Expand Down Expand Up @@ -397,6 +398,22 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
itemsNav += "</ul>";
}

if (docdash.typedefs && typedefs.find(function (m) { return m.scope === 'static'; } )) {
itemsNav += "<ul class='typedefs'>";

typedefs.forEach(function (typedef) {
if (!typedef.scope === 'static') return;
itemsNav += "<li data-type='typedef'";
if(docdash.collapse)
itemsNav += " style='display: none;'";
itemsNav += ">";
itemsNav += linkto(typedef.longname, typedef.name);
itemsNav += "</li>";
});

itemsNav += "</ul>";
}

itemsSeen[item.longname] = true;
}
itemsNav += '</li>';
Expand Down Expand Up @@ -469,7 +486,7 @@ function buildNav(members) {

members.globals.forEach(function(g) {
if ( (docdash.typedefs || g.kind !== 'typedef') && !hasOwnProp.call(seen, g.longname) ) {
globalNav += '<li>' + linkto(g.longname, g.name) + '</li>';
globalNav += '<li data-type="typedef">' + linkto(g.longname, g.name) + '</li>';
}
seen[g.longname] = true;
});
Expand Down
13 changes: 12 additions & 1 deletion static/styles/jsdoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,6 +713,17 @@ html[data-search-mode] .level-hide {
margin-right: 5px;
}

/** Add a '●' to typedef static members */
[data-type="typedef"] a::before {
content: '\25CF';
font-size: .55rem;
position: relative;
top: -2px;
display: inline-block;
margin-left: -14px;
margin-right: 5px;
}

#disqus_thread{
margin-left: 30px;
}
Expand Down Expand Up @@ -762,4 +773,4 @@ html[data-search-mode] .level-hide {
font-weight: 300;
font-style: normal;

}
}