Skip to content

Commit c19dba4

Browse files
darrenjwdarrenjw
committed
updated API docs
1 parent db604b2 commit c19dba4

36 files changed

+3360
-1356
lines changed

‎docs/api/index.html

+9-13
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@
88
<meta name="keywords" content="" />
99
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
1010

11+
1112
<link href="lib/index.css" media="screen" type="text/css" rel="stylesheet" />
1213
<link href="lib/template.css" media="screen" type="text/css" rel="stylesheet" />
1314
<link href="lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
14-
<script type="text/javascript" src="lib/jquery.js"></script>
15+
<script type="text/javascript" src="lib/jquery.min.js"></script>
1516
<script type="text/javascript" src="lib/jquery.panzoom.min.js"></script>
1617
<script type="text/javascript" src="lib/jquery.mousewheel.min.js"></script>
1718
<script type="text/javascript" src="lib/index.js"></script>
1819
<script type="text/javascript" src="index.js"></script>
1920
<script type="text/javascript" src="lib/scheduler.js"></script>
2021
<script type="text/javascript" src="lib/template.js"></script>
21-
<script type="text/javascript" src="lib/tools.tooltip.js"></script>
2222

2323
<script type="text/javascript">
2424
/* this variable can be used by the JS to determine the path to the root document */
@@ -56,7 +56,7 @@ <h1>Packages</h1>
5656
<li name="_root_.root" visbl="pub" class="indented0 current" data-isabs="false" fullComment="no" group="Ungrouped">
5757
<a id="_root_"></a><a id="root:_root_"></a>
5858
<span class="permalink">
59-
<a href="index.html#_root_" title="Permalink">
59+
<a href="index.html" title="Permalink">
6060
<i class="material-icons"></i>
6161
</a>
6262
</span>
@@ -69,10 +69,10 @@ <h1>Packages</h1>
6969
</span>
7070

7171

72-
</li><li name="_root_.breeze" visbl="pub" class="indented1 " data-isabs="false" fullComment="no" group="Ungrouped">
73-
<a id="breeze"></a><a id="breeze:breeze"></a>
72+
</li><li name="_root_.scala" visbl="pub" class="indented1 " data-isabs="false" fullComment="no" group="Ungrouped">
73+
<a id="scala"></a><a id="scala:scala"></a>
7474
<span class="permalink">
75-
<a href="index.html#breeze" title="Permalink">
75+
<a href="scala/index.html" title="Permalink">
7676
<i class="material-icons"></i>
7777
</a>
7878
</span>
@@ -81,16 +81,14 @@ <h1>Packages</h1>
8181
<span class="kind">package</span>
8282
</span>
8383
<span class="symbol">
84-
<a title="" href="breeze/index.html">
85-
<span class="name">breeze</span>
86-
</a>
84+
<a title="" href="scala/index.html"><span class="name">scala</span></a>
8785
</span>
8886

8987

9088
</li><li name="_root_.scalaglm" visbl="pub" class="indented1 " data-isabs="false" fullComment="no" group="Ungrouped">
9189
<a id="scalaglm"></a><a id="scalaglm:scalaglm"></a>
9290
<span class="permalink">
93-
<a href="index.html#scalaglm" title="Permalink">
91+
<a href="scalaglm/index.html" title="Permalink">
9492
<i class="material-icons"></i>
9593
</a>
9694
</span>
@@ -99,9 +97,7 @@ <h1>Packages</h1>
9997
<span class="kind">package</span>
10098
</span>
10199
<span class="symbol">
102-
<a title="" href="scalaglm/index.html">
103-
<span class="name">scalaglm</span>
104-
</a>
100+
<a title="" href="scalaglm/index.html"><span class="name">scalaglm</span></a>
105101
</span>
106102

107103

‎docs/api/index.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/lib/index.css

+55
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,56 @@
3131
url('open-sans-v13-latin-regular.woff') format('woff'),
3232
url('open-sans-v13-latin-regular.ttf') format('truetype');
3333
}
34+
@font-face {
35+
font-family: 'Open Sans';
36+
font-style: italic;
37+
font-weight: 400;
38+
src: url('open-sans-v13-latin-400i.eot');
39+
src: local('Open Sans Italic'), local('OpenSans-Italic'),
40+
url('open-sans-v13-latin-400i.eot?#iefix') format('embedded-opentype'),
41+
url('open-sans-v13-latin-400i.woff') format('woff'),
42+
url('open-sans-v13-latin-400i.ttf') format('truetype');
43+
}
44+
@font-face {
45+
font-family: 'Open Sans';
46+
font-style: oblique;
47+
font-weight: 400;
48+
src: url('open-sans-v13-latin-400i.eot');
49+
src: local('Open Sans Italic'), local('OpenSans-Italic'),
50+
url('open-sans-v13-latin-400i.eot?#iefix') format('embedded-opentype'),
51+
url('open-sans-v13-latin-400i.woff') format('woff'),
52+
url('open-sans-v13-latin-400i.ttf') format('truetype');
53+
}
54+
@font-face {
55+
font-family: 'Open Sans';
56+
font-style: normal;
57+
font-weight: 700;
58+
src: url('open-sans-v13-latin-700.eot');
59+
src: local('Open Sans Bold'), local('OpenSans-Bold'),
60+
url('open-sans-v13-latin-700.eot?#iefix') format('embedded-opentype'),
61+
url('open-sans-v13-latin-700.woff') format('woff'),
62+
url('open-sans-v13-latin-700.ttf') format('truetype');
63+
}
64+
@font-face {
65+
font-family: 'Open Sans';
66+
font-style: italic;
67+
font-weight: 700;
68+
src: url('open-sans-v13-latin-700i.eot');
69+
src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
70+
url('open-sans-v13-latin-700i.eot?#iefix') format('embedded-opentype'),
71+
url('open-sans-v13-latin-700i.woff') format('woff'),
72+
url('open-sans-v13-latin-700i.ttf') format('truetype');
73+
}
74+
@font-face {
75+
font-family: 'Open Sans';
76+
font-style: oblique;
77+
font-weight: 700;
78+
src: url('open-sans-v13-latin-700i.eot');
79+
src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
80+
url('open-sans-v13-latin-700i.eot?#iefix') format('embedded-opentype'),
81+
url('open-sans-v13-latin-700i.woff') format('woff'),
82+
url('open-sans-v13-latin-700i.ttf') format('truetype');
83+
}
3484

3585
@font-face {
3686
font-family: 'Source Code Pro';
@@ -61,6 +111,10 @@
61111
margin: 0px;
62112
}
63113

114+
u {
115+
text-decoration: underline;
116+
}
117+
64118
a {
65119
cursor: pointer;
66120
text-decoration: none;
@@ -432,6 +486,7 @@ div#content-container > div#subpackage-spacer {
432486
margin: 1.1rem 0.5rem 0 0.5em;
433487
font-size: 0.8em;
434488
min-width: 8rem;
489+
max-width: 16rem;
435490
}
436491

437492
div#packages > h1 {

‎docs/api/lib/index.js

+46-34
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var QueryString = function(key) {
3737

3838
$(document).ready(function() {
3939
// Clicking #doc-title returns the user to the root package
40-
$("#doc-title").click(function() { document.location = toRoot + "index.html" });
40+
$("#doc-title").on("click", function() { document.location = toRoot + "index.html" });
4141

4242
scheduler = new Scheduler();
4343
scheduler.addLabel("init", 1);
@@ -107,26 +107,36 @@ function handleKeyNavigation() {
107107
};
108108
};
109109

110+
function safeOffset($elem) {
111+
return $elem.length ? $elem.offset() : { top:0, left:0 }; // offset relative to viewport
112+
}
113+
110114
/** Scroll helper, ensures that the selected elem is inside the viewport */
111115
var Scroller = function ($container) {
112116
scroller = this;
113117
scroller.container = $container;
114118

115119
scroller.scrollDown = function($elem) {
116-
var yPos = $elem.offset().top; // offset relative to viewport
117-
if ($container.height() < yPos || (yPos - $("#search").height()) < 0) {
118-
$container.animate({
119-
scrollTop: $container.scrollTop() + yPos - $("#search").height() - 10
120-
}, 200);
120+
var offset = safeOffset($elem);
121+
if (offset !== undefined) {
122+
var yPos = offset.top;
123+
if ($container.height() < yPos || (yPos - $("#search").height()) < 0) {
124+
$container.animate({
125+
scrollTop: $container.scrollTop() + yPos - $("#search").height() - 10
126+
}, 200);
127+
}
121128
}
122129
};
123130

124131
scroller.scrollUp = function ($elem) {
125-
var yPos = $elem.offset().top; // offset relative to viewport
126-
if (yPos < $("#search").height()) {
127-
$container.animate({
128-
scrollTop: $container.scrollTop() + yPos - $("#search").height() - 10
129-
}, 200);
132+
var offset = safeOffset($elem);
133+
if (offset !== undefined) {
134+
var yPos = offset.top;
135+
if (yPos < $("#search").height()) {
136+
$container.animate({
137+
scrollTop: $container.scrollTop() + yPos - $("#search").height() - 10
138+
}, 200);
139+
}
130140
}
131141
};
132142

@@ -138,7 +148,7 @@ function handleKeyNavigation() {
138148
};
139149

140150
scheduler.add("init", function() {
141-
$("#textfilter input").blur();
151+
$("#textfilter input").trigger("blur");
142152
var items = new EntityIterator(
143153
$("div#results-content > div#entity-results > ul.entities span.entity > a").toArray(),
144154
$("div#results-content > div#member-results > ul.entities span.entity > a").toArray()
@@ -150,7 +160,7 @@ function handleKeyNavigation() {
150160
$old.addClass("selected");
151161
scroller.scrollDown($old);
152162

153-
$(window).bind("keydown", function(e) {
163+
$(window).on("keydown", function(e) {
154164
switch ( e.keyCode ) {
155165
case 9: // tab
156166
$old.removeClass("selected");
@@ -159,33 +169,33 @@ function handleKeyNavigation() {
159169
case 13: // enter
160170
var href = $old.attr("href");
161171
location.replace(href);
162-
$old.click();
163-
$("#textfilter input").attr("value", "");
172+
$old.trigger("click");
173+
$("#textfilter input").val("");
164174
break;
165175

166176
case 27: // escape
167-
$("#textfilter input").attr("value", "");
177+
$("#textfilter input").val("");
168178
$("div#search-results").hide();
169179
$("#search > span.close-results").hide();
170180
$("#search > span#doc-title").show();
171181
break;
172182

173183
case 37: // left
174-
var oldTop = $old.offset().top;
184+
var oldTop = safeOffset($old).top;
175185
$old.removeClass("selected");
176186
$old = items.left();
177187
$old.addClass("selected");
178188

179-
(oldTop - $old.offset().top < 0 ? scroller.scrollDown : scroller.scrollUp)($old);
189+
(oldTop - safeOffset($old).top < 0 ? scroller.scrollDown : scroller.scrollUp)($old);
180190
break;
181191

182192
case 38: // up
183193
$old.removeClass('selected');
184194
$old = items.prev();
185195

186196
if ($old === undefined) { // scroll past top
187-
$(window).unbind("keydown");
188-
$("#textfilter input").focus();
197+
$(window).off("keydown");
198+
$("#textfilter input").trigger("focus");
189199
scroller.scrollTop();
190200
return false;
191201
} else {
@@ -195,12 +205,12 @@ function handleKeyNavigation() {
195205
break;
196206

197207
case 39: // right
198-
var oldTop = $old.offset().top;
208+
var oldTop = safeOffset($old).top;
199209
$old.removeClass("selected");
200210
$old = items.right();
201211
$old.addClass("selected");
202212

203-
(oldTop - $old.offset().top < 0 ? scroller.scrollDown : scroller.scrollUp)($old);
213+
(oldTop - safeOffset($old).top < 0 ? scroller.scrollDown : scroller.scrollUp)($old);
204214
break;
205215

206216
case 40: // down
@@ -218,10 +228,10 @@ function handleKeyNavigation() {
218228
function configureTextFilter() {
219229
scheduler.add("init", function() {
220230
var input = $("#textfilter input");
221-
input.bind('keyup', function(event) {
231+
input.on('keyup', function(event) {
222232
switch ( event.keyCode ) {
223233
case 27: // escape
224-
input.attr("value", "");
234+
input.val("");
225235
$("div#search-results").hide();
226236
$("#search > span.close-results").hide();
227237
$("#search > span#doc-title").show();
@@ -231,7 +241,7 @@ function configureTextFilter() {
231241
return false;
232242

233243
case 40: // down arrow
234-
$(window).unbind("keydown");
244+
$(window).off("keydown");
235245
handleKeyNavigation();
236246
return false;
237247
}
@@ -240,8 +250,8 @@ function configureTextFilter() {
240250
});
241251
});
242252
scheduler.add("init", function() {
243-
$("#textfilter > .input > .clear").click(function() {
244-
$("#textfilter input").attr("value", "");
253+
$("#textfilter > .input > .clear").on("click", function() {
254+
$("#textfilter input").val("");
245255
$("div#search-results").hide();
246256
$("#search > span.close-results").hide();
247257
$("#search > span#doc-title").show();
@@ -251,11 +261,11 @@ function configureTextFilter() {
251261
});
252262

253263
scheduler.add("init", function() {
254-
$("div#search > span.close-results").click(function() {
264+
$("div#search > span.close-results").on("click", function() {
255265
$("div#search-results").hide();
256266
$("#search > span.close-results").hide();
257267
$("#search > span#doc-title").show();
258-
$("#textfilter input").attr("value", "");
268+
$("#textfilter input").val("");
259269
});
260270
});
261271
}
@@ -525,7 +535,7 @@ function listItem(entity, regExp) {
525535
function searchAll() {
526536
scheduler.clear("search"); // clear previous search
527537
maxJobs = 1; // clear previous max
528-
var searchStr = $("#textfilter input").attr("value").trim() || '';
538+
var searchStr = ($("#textfilter input").val() || '').trim();
529539

530540
if (searchStr === '') {
531541
$("div#search-results").hide();
@@ -555,10 +565,12 @@ function searchAll() {
555565
entityH1.innerHTML = "Entity results";
556566
entityResults.appendChild(entityH1);
557567

558-
$("div#results-content")
559-
.prepend("<span class='search-text'>"
560-
+" Showing results for <span class='query-str'>\"" + searchStr + "\"</span>"
561-
+"</span>");
568+
$("div#results-content").prepend(
569+
$("<span>")
570+
.addClass("search-text")
571+
.append(document.createTextNode(" Showing results for "))
572+
.append($("<span>").addClass("query-str").text(searchStr))
573+
);
562574

563575
var regExp = compilePattern(searchStr);
564576

‎docs/api/lib/jquery.min.js

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)