Skip to content

[scaladays] dottydoc fixes 2 #2487

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.

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions compiler/src/dotty/tools/dotc/config/ScalaSettings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -130,5 +130,12 @@ class ScalaSettings extends Settings.SettingGroup {
""
)

val projectUrl = StringSetting (
"-project-url",
"project repository homepage",
"The source repository of your project",
""
)

val wikiSyntax = BooleanSetting("-Xwiki-syntax", "Retains the Scala2 behavior of using Wiki Syntax in Scaladoc")
}
41 changes: 41 additions & 0 deletions doc-tool/resources/_includes/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@
<li class="index-title">
<span>API</span>
</li>
<li>
<input id="search-api-input" type="text" placeholder="Search API"/>
<script>
var input = document.getElementById("search-api-input");
input.onkeydown = function(evt) {
evt = evt || window.event;
if (evt.keyCode == 13) window.location = (
"{{ site.baseurl }}/api/search.html?" +
"searchTerm=" + input.value +
"&previousUrl=" + encodeURI(window.location)
);
};
</script>
</li>
{% endif %}
{% for pkg in docs %}
<li class="index-entity entity-package">
Expand All @@ -20,7 +34,16 @@ <h1><a class="entity-name" href="{{ site.baseurl }}/api/{{ pkg.path | join: "/"
{% for member in pkg.children %}
{% if member.kind == "object" and member.hasCompanion %}
{% elsif member.kind != "package" %}

{% if forloop.index == 6 and forloop.length > 7 %}
<li id="show-hidden-by-default" onclick="toggleHiddenByDefault(this);">+ expand rest</li>
<li class="hidden-by-default {% if member.hasCompanion %} with-companion {% endif %}">
{% elsif forloop.index > 6 and forloop.length > 7 %}
<li class="hidden-by-default {% if member.hasCompanion %} with-companion {% endif %}">
{% else %}
<li class="{% if member.hasCompanion %} with-companion {% endif %}">
{% endif %}<!-- end li setter -->

<div class="entity-kinds">
{% if member.hasCompanion %}
<a class="letter-anchor object" href="{{ site.baseurl }}/api/{{ member.companionPath | join: "/" }}.html">O</a>
Expand All @@ -29,10 +52,28 @@ <h1><a class="entity-name" href="{{ site.baseurl }}/api/{{ pkg.path | join: "/"
</div>
<a class="entity-name" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
</li>

{% if forloop.last and forloop.index > 6 %}
<li id="hide-hidden-by-default" onclick="toggleHiddenByDefault(this);">- collapse members</li>
{% endif %}

{% endif %} <!-- end != "package" -->

{% endfor %}
</ul>
</li>
{% endfor %}
</ul>
</div>
<script>
function toggleHiddenByDefault(li) {
var ul = li.parentElement;

for (var i = 0; i < ul.children.length; i++) {
var childLi = ul.children[i];
if (childLi.classList.contains('hidden-by-default') || childLi.id == "hide-hidden-by-default" || childLi.id == "show-hidden-by-default") {
childLi.classList.toggle('toggled');
}
}
}
</script>
11 changes: 11 additions & 0 deletions doc-tool/resources/_includes/toolbar.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,15 @@
<h1 id="project-name">{{ site.project }} Documentation</h1>
<h2 id="project-version">{{ site.version }}</h2>
</div>

{% if site.projectUrl %}
<a title="Project repository" id="github-link" href="{{ site.projectUrl }}">
{% if site.projectUrl contains "github" %}
<i class="fa fa-github" aria-hidden="true"></i>
{% else %}
<i class="fa fa-code" aria-hidden="true"></i>
{% endif %}
</a>
{% endif %}
</div>
<div id="toolbar-spacing"></div>
2 changes: 1 addition & 1 deletion doc-tool/resources/_layouts/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

<link
rel="stylesheet"
href="{{ site.baseurl }}/css/font-awesome.min.css"
href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"
>

<link
Expand Down
4 changes: 0 additions & 4 deletions doc-tool/resources/_layouts/rand.sh

This file was deleted.

161 changes: 161 additions & 0 deletions doc-tool/resources/_layouts/search.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
---
layout: main
extraCSS:
- css/toolbar.css
- css/search.css
---

{% include "toolbar" %}

<div id="back-container">
<span>
<a id="back-anchor" href="">Back</a>
</span>
</div>

<div id="search-container">
<h1 id="searching-for"></h1>
<div id="result-container">
<div class="results">
<h1>Entity Results</h1>
<ul id="entity-results">
</ul>
</div>
<div class="results">
<h1>Member Results</h1>
<ul id="member-results">
</ul>
</div>
</div>
</div>

<script>
// Parse parameters from URL:
var parameters = [];
var apiSearch = undefined;
var docs = {{ docs | json }};
(function() {
var pairs = location.search.substring(1).split('&');
for (var i = 0; i < pairs.length; i++) {
var keyVal = pairs[i].split('=');
parameters[keyVal[0]] = keyVal.length == 2 ? keyVal[1] : undefined;
}
})();

// Set search term and back button:
var searchTerm = parameters["searchTerm"];
document.getElementById("searching-for").innerHTML = 'Search results for "' + searchTerm + '"';
document.getElementById("back-anchor").href = parameters["previousUrl"];

if (!window.Worker) {
document.getElementById("searching-for").innerHTML =
"Couldn't search for \"" + searchTerm + "\", " +
"web workers not supported. Please update your browser.";
}
else {
// perform API search:
apiSearch = new Worker("{{ site.baseurl }}/js/api-search.js");
apiSearch.postMessage({
"type": "setup",
"search": searchTerm,
"docs": docs,
});

var insertEntity = function(entityResultsNode, entityResults) {
return function(entity, parent) {
var shouldInsert =
parent.kind == "package" &&
!(entity.kind == "object" && entity.hasCompanion)

if (shouldInsert) {
// If parent package not in list, create it first:
if (!(parent.name in entityResults)) {
var packageLi = document.createElement("li");
entityResultsNode.appendChild(packageLi);

packageLi.innerHTML =
"<h1 class=\"package-name\">" +
"<a href=\"{{ site.baseurl }}/api/" + parent.path.join('/') + "/index.html\">" +
parent.name +
"</a>" +
"</h1>";

var entityUl = document.createElement("ul");
entityUl.classList.add("entity-ul");
packageLi.appendChild(entityUl);
entityResults[parent.name] = entityUl;
var coverBlock = document.createElement("div");
coverBlock.classList.add("cover-block");
entityUl.appendChild(coverBlock);
}

// Insert into list of results in package, no need to sort -
// already sorted:
var entityUl = entityResults[parent.name];
var entityLi = document.createElement("li");
if (entity.hasCompanion)
entityLi.classList.add("entity-result-li", "with-companion");
else
entityLi.classList.add("entity-result-li");

var companion = !entity.hasCompanion ? "" : (
'<a class="letter-anchor object" href="{{ site.baseurl }}/api/' + entity.companionPath.join('/') + '.html">O</a>'
);

var letter =
'<a class="letter-anchor ' + entity.kind + '" href="{{ site.baseurl }}/api/' + entity.path.join('/') + '.html">' +
entity.kind.charAt(0).toUpperCase() +
'</a>'

entityLi.innerHTML = (
'<div class="entity-kinds">' +
companion +
letter +
'</div>' +
"<a class=\"entity-name\" href=\"{{ site.baseurl }}/api/" + entity.path.join('/') + ".html\">" +
entity.name +
"</a>"
);
entityUl.appendChild(entityLi);
return entityLi;
}
else {
return undefined;
}
};
};

var insertMember = function(member, li) {
li.appendChild(document.createTextNode(", " + member.name));
};

var entityResultsNode = document.getElementById("entity-results");
var entityResults = [];
var memberResultsNode = document.getElementById("member-results");
var memberResults = [];

apiSearch.onmessage = function(res) {
switch(res.data.type) {
case "entityResult": {
var entity = res.data.entity;
var package = res.data.package;
//console.log("got entity: " + entity.name + ", in package: " + package.name);
insertEntity(entityResultsNode, entityResults)(entity, package);
break;
}
case "memberResult": {
var member = res.data.member;
var parent = res.data.parent;
var package = res.data.package;
//console.log("got member: " + member.name + ", in entity: " + parent.name);
var li = insertEntity(memberResultsNode, memberResults)(parent, package);
if (li) insertMember(member, li);
break;
}
default: {
console.log("Got unknown message: " + res.data.type);
}
}
};
}
</script>
4 changes: 3 additions & 1 deletion doc-tool/resources/css/api-page.css
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ h1.section {
h1.section > span.expand-button.visible {
color: rgba(167, 161, 161, 0.5);
font-family: "Source Code Pro", sans-serif;
font-size: 25px;
font-size: 16px;
float: left;
margin: 14px 9px 0 0;
}

h1.section > span.expand-button.visible:hover {
Expand Down
1 change: 0 additions & 1 deletion doc-tool/resources/css/dottydoc.css
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ body {
div#content-wrapper {
min-height: 100vh;
padding-left: 0;
margin-top: 75px;
}

div#content-wrapper div#content-body {
Expand Down
Loading