Skip to content

Commit bd66656

Browse files
CitymonstretCitymonstret
committed
Add missing JavaDoc
1 parent fe0de72 commit bd66656

17 files changed

+95
-354
lines changed

‎docs/allclasses-frame.html

+1-21
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
66
<title>All Classes</title>
77
<meta name="date" content="2019-01-25">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -12,27 +12,7 @@
1212
<h1 class="bar">All&nbsp;Classes</h1>
1313
<div class="indexContainer">
1414
<ul>
15-
<li><a href="org/incendo/jenkins/objects/ArtifactDescription.html" title="class in org.incendo.jenkins.objects" target="classFrame">ArtifactDescription</a></li>
16-
<li><a href="org/incendo/jenkins/objects/BuildDescription.html" title="class in org.incendo.jenkins.objects" target="classFrame">BuildDescription</a></li>
17-
<li><a href="org/incendo/jenkins/objects/BuildInfo.html" title="class in org.incendo.jenkins.objects" target="classFrame">BuildInfo</a></li>
18-
<li><a href="org/incendo/jenkins/Jenkins.html" title="class in org.incendo.jenkins" target="classFrame">Jenkins</a></li>
19-
<li><a href="org/incendo/jenkins/JenkinsAPIType.html" title="enum in org.incendo.jenkins" target="classFrame">JenkinsAPIType</a></li>
20-
<li><a href="org/incendo/jenkins/JenkinsAuthentication.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsAuthentication</a></li>
2115
<li><a href="org/incendo/jenkins/JenkinsBasicAuthentication.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsBasicAuthentication</a></li>
22-
<li><a href="org/incendo/jenkins/JenkinsBuilder.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsBuilder</a></li>
23-
<li><a href="org/incendo/jenkins/exception/JenkinsBuildNotFoundException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsBuildNotFoundException</a></li>
24-
<li><a href="org/incendo/jenkins/exception/JenkinsJobNotFoundException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsJobNotFoundException</a></li>
25-
<li><a href="org/incendo/jenkins/exception/JenkinsNodeReadException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsNodeReadException</a></li>
26-
<li><a href="org/incendo/jenkins/exception/JenkinsNotAuthenticatedException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsNotAuthenticatedException</a></li>
27-
<li><a href="org/incendo/jenkins/JenkinsPathProvider.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsPathProvider</a></li>
28-
<li><a href="org/incendo/jenkins/JenkinsReader.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsReader</a></li>
29-
<li><a href="org/incendo/jenkins/objects/JobDescription.html" title="class in org.incendo.jenkins.objects" target="classFrame">JobDescription</a></li>
30-
<li><a href="org/incendo/jenkins/objects/JobInfo.html" title="class in org.incendo.jenkins.objects" target="classFrame">JobInfo</a></li>
31-
<li><a href="org/incendo/jenkins/json/JsonJenkinsReader.html" title="class in org.incendo.jenkins.json" target="classFrame">JsonJenkinsReader</a></li>
32-
<li><a href="org/incendo/jenkins/objects/MasterNode.html" title="class in org.incendo.jenkins.objects" target="classFrame">MasterNode</a></li>
33-
<li><a href="org/incendo/jenkins/objects/Node.html" title="interface in org.incendo.jenkins.objects" target="classFrame"><span class="interfaceName">Node</span></a></li>
34-
<li><a href="org/incendo/jenkins/objects/NodeChild.html" title="interface in org.incendo.jenkins.objects" target="classFrame"><span class="interfaceName">NodeChild</span></a></li>
35-
<li><a href="org/incendo/jenkins/objects/NodePath.html" title="interface in org.incendo.jenkins.objects" target="classFrame"><span class="interfaceName">NodePath</span></a></li>
3616
</ul>
3717
</div>
3818
</body>

‎docs/allclasses-noframe.html

+1-21
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
66
<title>All Classes</title>
77
<meta name="date" content="2019-01-25">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -12,27 +12,7 @@
1212
<h1 class="bar">All&nbsp;Classes</h1>
1313
<div class="indexContainer">
1414
<ul>
15-
<li><a href="org/incendo/jenkins/objects/ArtifactDescription.html" title="class in org.incendo.jenkins.objects">ArtifactDescription</a></li>
16-
<li><a href="org/incendo/jenkins/objects/BuildDescription.html" title="class in org.incendo.jenkins.objects">BuildDescription</a></li>
17-
<li><a href="org/incendo/jenkins/objects/BuildInfo.html" title="class in org.incendo.jenkins.objects">BuildInfo</a></li>
18-
<li><a href="org/incendo/jenkins/Jenkins.html" title="class in org.incendo.jenkins">Jenkins</a></li>
19-
<li><a href="org/incendo/jenkins/JenkinsAPIType.html" title="enum in org.incendo.jenkins">JenkinsAPIType</a></li>
20-
<li><a href="org/incendo/jenkins/JenkinsAuthentication.html" title="class in org.incendo.jenkins">JenkinsAuthentication</a></li>
2115
<li><a href="org/incendo/jenkins/JenkinsBasicAuthentication.html" title="class in org.incendo.jenkins">JenkinsBasicAuthentication</a></li>
22-
<li><a href="org/incendo/jenkins/JenkinsBuilder.html" title="class in org.incendo.jenkins">JenkinsBuilder</a></li>
23-
<li><a href="org/incendo/jenkins/exception/JenkinsBuildNotFoundException.html" title="class in org.incendo.jenkins.exception">JenkinsBuildNotFoundException</a></li>
24-
<li><a href="org/incendo/jenkins/exception/JenkinsJobNotFoundException.html" title="class in org.incendo.jenkins.exception">JenkinsJobNotFoundException</a></li>
25-
<li><a href="org/incendo/jenkins/exception/JenkinsNodeReadException.html" title="class in org.incendo.jenkins.exception">JenkinsNodeReadException</a></li>
26-
<li><a href="org/incendo/jenkins/exception/JenkinsNotAuthenticatedException.html" title="class in org.incendo.jenkins.exception">JenkinsNotAuthenticatedException</a></li>
27-
<li><a href="org/incendo/jenkins/JenkinsPathProvider.html" title="class in org.incendo.jenkins">JenkinsPathProvider</a></li>
28-
<li><a href="org/incendo/jenkins/JenkinsReader.html" title="class in org.incendo.jenkins">JenkinsReader</a></li>
29-
<li><a href="org/incendo/jenkins/objects/JobDescription.html" title="class in org.incendo.jenkins.objects">JobDescription</a></li>
30-
<li><a href="org/incendo/jenkins/objects/JobInfo.html" title="class in org.incendo.jenkins.objects">JobInfo</a></li>
31-
<li><a href="org/incendo/jenkins/json/JsonJenkinsReader.html" title="class in org.incendo.jenkins.json">JsonJenkinsReader</a></li>
32-
<li><a href="org/incendo/jenkins/objects/MasterNode.html" title="class in org.incendo.jenkins.objects">MasterNode</a></li>
33-
<li><a href="org/incendo/jenkins/objects/Node.html" title="interface in org.incendo.jenkins.objects"><span class="interfaceName">Node</span></a></li>
34-
<li><a href="org/incendo/jenkins/objects/NodeChild.html" title="interface in org.incendo.jenkins.objects"><span class="interfaceName">NodeChild</span></a></li>
35-
<li><a href="org/incendo/jenkins/objects/NodePath.html" title="interface in org.incendo.jenkins.objects"><span class="interfaceName">NodePath</span></a></li>
3616
</ul>
3717
</div>
3818
</body>

‎docs/constant-values.html

+3-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
66
<title>Constant Field Values</title>
77
<meta name="date" content="2019-01-25">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -31,8 +31,7 @@
3131
<!-- -->
3232
</a>
3333
<ul class="navList" title="Navigation">
34-
<li><a href="overview-summary.html">Overview</a></li>
35-
<li>Package</li>
34+
<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
3635
<li>Class</li>
3736
<li><a href="overview-tree.html">Tree</a></li>
3837
<li><a href="deprecated-list.html">Deprecated</a></li>
@@ -81,8 +80,7 @@ <h2 title="Contents">Contents</h2>
8180
<!-- -->
8281
</a>
8382
<ul class="navList" title="Navigation">
84-
<li><a href="overview-summary.html">Overview</a></li>
85-
<li>Package</li>
83+
<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
8684
<li>Class</li>
8785
<li><a href="overview-tree.html">Tree</a></li>
8886
<li><a href="deprecated-list.html">Deprecated</a></li>

‎docs/deprecated-list.html

+3-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
66
<title>Deprecated List</title>
77
<meta name="date" content="2019-01-25">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -31,8 +31,7 @@
3131
<!-- -->
3232
</a>
3333
<ul class="navList" title="Navigation">
34-
<li><a href="overview-summary.html">Overview</a></li>
35-
<li>Package</li>
34+
<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
3635
<li>Class</li>
3736
<li><a href="overview-tree.html">Tree</a></li>
3837
<li class="navBarCell1Rev">Deprecated</li>
@@ -81,8 +80,7 @@ <h2 title="Contents">Contents</h2>
8180
<!-- -->
8281
</a>
8382
<ul class="navList" title="Navigation">
84-
<li><a href="overview-summary.html">Overview</a></li>
85-
<li>Package</li>
83+
<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
8684
<li>Class</li>
8785
<li><a href="overview-tree.html">Tree</a></li>
8886
<li class="navBarCell1Rev">Deprecated</li>

‎docs/help-doc.html

+3-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
66
<title>API Help</title>
77
<meta name="date" content="2019-01-25">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -31,8 +31,7 @@
3131
<!-- -->
3232
</a>
3333
<ul class="navList" title="Navigation">
34-
<li><a href="overview-summary.html">Overview</a></li>
35-
<li>Package</li>
34+
<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
3635
<li>Class</li>
3736
<li><a href="overview-tree.html">Tree</a></li>
3837
<li><a href="deprecated-list.html">Deprecated</a></li>
@@ -75,10 +74,6 @@ <h1 class="title">How This API Document Is Organized</h1>
7574
<div class="contentContainer">
7675
<ul class="blockList">
7776
<li class="blockList">
78-
<h2>Overview</h2>
79-
<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
80-
</li>
81-
<li class="blockList">
8277
<h2>Package</h2>
8378
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p>
8479
<ul>
@@ -182,8 +177,7 @@ <h2>Constant Field Values</h2>
182177
<!-- -->
183178
</a>
184179
<ul class="navList" title="Navigation">
185-
<li><a href="overview-summary.html">Overview</a></li>
186-
<li>Package</li>
180+
<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
187181
<li>Class</li>
188182
<li><a href="overview-tree.html">Tree</a></li>
189183
<li><a href="deprecated-list.html">Deprecated</a></li>

‎docs/index-files/index-1.html

+12-18
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
6-
<title>A-Index</title>
5+
<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
6+
<title>I-Index</title>
77
<meta name="date" content="2019-01-25">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
@@ -12,7 +12,7 @@
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="A-Index";
15+
parent.document.title="I-Index";
1616
}
1717
}
1818
catch(err) {
@@ -31,8 +31,7 @@
3131
<!-- -->
3232
</a>
3333
<ul class="navList" title="Navigation">
34-
<li><a href="../overview-summary.html">Overview</a></li>
35-
<li>Package</li>
34+
<li><a href="../org/incendo/jenkins/package-summary.html">Package</a></li>
3635
<li>Class</li>
3736
<li><a href="../overview-tree.html">Tree</a></li>
3837
<li><a href="../deprecated-list.html">Deprecated</a></li>
@@ -68,21 +67,17 @@
6867
<!-- -->
6968
</a></div>
7069
<!-- ========= END OF TOP NAVBAR ========= -->
71-
<div class="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">E</a>&nbsp;<a href="index-4.html">G</a>&nbsp;<a href="index-5.html">H</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">J</a>&nbsp;<a href="index-8.html">M</a>&nbsp;<a href="index-9.html">N</a>&nbsp;<a href="index-10.html">O</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">V</a>&nbsp;<a href="index-15.html">W</a>&nbsp;<a name="I:A">
70+
<div class="contentContainer"><a href="index-1.html">I</a>&nbsp;<a href="index-2.html">J</a>&nbsp;<a href="index-3.html">O</a>&nbsp;<a name="I:I">
7271
<!-- -->
7372
</a>
74-
<h2 class="title">A</h2>
73+
<h2 class="title">I</h2>
7574
<dl>
76-
<dt><a href="../org/incendo/jenkins/objects/ArtifactDescription.html" title="class in org.incendo.jenkins.objects"><span class="typeNameLink">ArtifactDescription</span></a> - Class in <a href="../org/incendo/jenkins/objects/package-summary.html">org.incendo.jenkins.objects</a></dt>
77-
<dd>
78-
<div class="block">Artifact descriptions are what is listed on Jenkins as artifacts.</div>
79-
</dd>
80-
<dt><span class="memberNameLink"><a href="../org/incendo/jenkins/objects/ArtifactDescription.html#ArtifactDescription-java.lang.String-java.lang.String-java.lang.String-">ArtifactDescription(String, String, String)</a></span> - Constructor for class org.incendo.jenkins.objects.<a href="../org/incendo/jenkins/objects/ArtifactDescription.html" title="class in org.incendo.jenkins.objects">ArtifactDescription</a></dt>
81-
<dd>
82-
<div class="block">Instantiates a new Artifact description.</div>
83-
</dd>
75+
<dt><span class="memberNameLink"><a href="../org/incendo/jenkins/JenkinsBasicAuthentication.html#initialize-okhttp3.OkHttpClient.Builder-">initialize(OkHttpClient.Builder)</a></span> - Method in class org.incendo.jenkins.<a href="../org/incendo/jenkins/JenkinsBasicAuthentication.html" title="class in org.incendo.jenkins">JenkinsBasicAuthentication</a></dt>
76+
<dd>&nbsp;</dd>
77+
<dt><span class="memberNameLink"><a href="../org/incendo/jenkins/JenkinsBasicAuthentication.html#intercept-okhttp3.Interceptor.Chain-">intercept(Interceptor.Chain)</a></span> - Method in class org.incendo.jenkins.<a href="../org/incendo/jenkins/JenkinsBasicAuthentication.html" title="class in org.incendo.jenkins">JenkinsBasicAuthentication</a></dt>
78+
<dd>&nbsp;</dd>
8479
</dl>
85-
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">E</a>&nbsp;<a href="index-4.html">G</a>&nbsp;<a href="index-5.html">H</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">J</a>&nbsp;<a href="index-8.html">M</a>&nbsp;<a href="index-9.html">N</a>&nbsp;<a href="index-10.html">O</a>&nbsp;<a href="index-11.html">R</a>&nbsp;<a href="index-12.html">S</a>&nbsp;<a href="index-13.html">T</a>&nbsp;<a href="index-14.html">V</a>&nbsp;<a href="index-15.html">W</a>&nbsp;</div>
80+
<a href="index-1.html">I</a>&nbsp;<a href="index-2.html">J</a>&nbsp;<a href="index-3.html">O</a>&nbsp;</div>
8681
<!-- ======= START OF BOTTOM NAVBAR ====== -->
8782
<div class="bottomNav"><a name="navbar.bottom">
8883
<!-- -->
@@ -92,8 +87,7 @@ <h2 class="title">A</h2>
9287
<!-- -->
9388
</a>
9489
<ul class="navList" title="Navigation">
95-
<li><a href="../overview-summary.html">Overview</a></li>
96-
<li>Package</li>
90+
<li><a href="../org/incendo/jenkins/package-summary.html">Package</a></li>
9791
<li>Class</li>
9892
<li><a href="../overview-tree.html">Tree</a></li>
9993
<li><a href="../deprecated-list.html">Deprecated</a></li>

0 commit comments

Comments
 (0)