Add missing JavaDoc

Citymonstret · Jan 25, 2019 · bd66656 · bd66656
1 parent fe0de72
commit bd66656
Show file tree

Hide file tree

Showing 17 changed files with 95 additions and 354 deletions.
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
+<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
 <title>All Classes</title>
 <meta name="date" content="2019-01-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -12,27 +12,7 @@
 <h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
-<li><a href="org/incendo/jenkins/objects/ArtifactDescription.html" title="class in org.incendo.jenkins.objects" target="classFrame">ArtifactDescription</a></li>
-<li><a href="org/incendo/jenkins/objects/BuildDescription.html" title="class in org.incendo.jenkins.objects" target="classFrame">BuildDescription</a></li>
-<li><a href="org/incendo/jenkins/objects/BuildInfo.html" title="class in org.incendo.jenkins.objects" target="classFrame">BuildInfo</a></li>
-<li><a href="org/incendo/jenkins/Jenkins.html" title="class in org.incendo.jenkins" target="classFrame">Jenkins</a></li>
-<li><a href="org/incendo/jenkins/JenkinsAPIType.html" title="enum in org.incendo.jenkins" target="classFrame">JenkinsAPIType</a></li>
-<li><a href="org/incendo/jenkins/JenkinsAuthentication.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsAuthentication</a></li>
 <li><a href="org/incendo/jenkins/JenkinsBasicAuthentication.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsBasicAuthentication</a></li>
-<li><a href="org/incendo/jenkins/JenkinsBuilder.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsBuilder</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsBuildNotFoundException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsBuildNotFoundException</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsJobNotFoundException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsJobNotFoundException</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsNodeReadException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsNodeReadException</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsNotAuthenticatedException.html" title="class in org.incendo.jenkins.exception" target="classFrame">JenkinsNotAuthenticatedException</a></li>
-<li><a href="org/incendo/jenkins/JenkinsPathProvider.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsPathProvider</a></li>
-<li><a href="org/incendo/jenkins/JenkinsReader.html" title="class in org.incendo.jenkins" target="classFrame">JenkinsReader</a></li>
-<li><a href="org/incendo/jenkins/objects/JobDescription.html" title="class in org.incendo.jenkins.objects" target="classFrame">JobDescription</a></li>
-<li><a href="org/incendo/jenkins/objects/JobInfo.html" title="class in org.incendo.jenkins.objects" target="classFrame">JobInfo</a></li>
-<li><a href="org/incendo/jenkins/json/JsonJenkinsReader.html" title="class in org.incendo.jenkins.json" target="classFrame">JsonJenkinsReader</a></li>
-<li><a href="org/incendo/jenkins/objects/MasterNode.html" title="class in org.incendo.jenkins.objects" target="classFrame">MasterNode</a></li>
-<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>
-<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>
-<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>
 </ul>
 </div>
 </body>

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
+<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
 <title>All Classes</title>
 <meta name="date" content="2019-01-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -12,27 +12,7 @@
 <h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
-<li><a href="org/incendo/jenkins/objects/ArtifactDescription.html" title="class in org.incendo.jenkins.objects">ArtifactDescription</a></li>
-<li><a href="org/incendo/jenkins/objects/BuildDescription.html" title="class in org.incendo.jenkins.objects">BuildDescription</a></li>
-<li><a href="org/incendo/jenkins/objects/BuildInfo.html" title="class in org.incendo.jenkins.objects">BuildInfo</a></li>
-<li><a href="org/incendo/jenkins/Jenkins.html" title="class in org.incendo.jenkins">Jenkins</a></li>
-<li><a href="org/incendo/jenkins/JenkinsAPIType.html" title="enum in org.incendo.jenkins">JenkinsAPIType</a></li>
-<li><a href="org/incendo/jenkins/JenkinsAuthentication.html" title="class in org.incendo.jenkins">JenkinsAuthentication</a></li>
 <li><a href="org/incendo/jenkins/JenkinsBasicAuthentication.html" title="class in org.incendo.jenkins">JenkinsBasicAuthentication</a></li>
-<li><a href="org/incendo/jenkins/JenkinsBuilder.html" title="class in org.incendo.jenkins">JenkinsBuilder</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsBuildNotFoundException.html" title="class in org.incendo.jenkins.exception">JenkinsBuildNotFoundException</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsJobNotFoundException.html" title="class in org.incendo.jenkins.exception">JenkinsJobNotFoundException</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsNodeReadException.html" title="class in org.incendo.jenkins.exception">JenkinsNodeReadException</a></li>
-<li><a href="org/incendo/jenkins/exception/JenkinsNotAuthenticatedException.html" title="class in org.incendo.jenkins.exception">JenkinsNotAuthenticatedException</a></li>
-<li><a href="org/incendo/jenkins/JenkinsPathProvider.html" title="class in org.incendo.jenkins">JenkinsPathProvider</a></li>
-<li><a href="org/incendo/jenkins/JenkinsReader.html" title="class in org.incendo.jenkins">JenkinsReader</a></li>
-<li><a href="org/incendo/jenkins/objects/JobDescription.html" title="class in org.incendo.jenkins.objects">JobDescription</a></li>
-<li><a href="org/incendo/jenkins/objects/JobInfo.html" title="class in org.incendo.jenkins.objects">JobInfo</a></li>
-<li><a href="org/incendo/jenkins/json/JsonJenkinsReader.html" title="class in org.incendo.jenkins.json">JsonJenkinsReader</a></li>
-<li><a href="org/incendo/jenkins/objects/MasterNode.html" title="class in org.incendo.jenkins.objects">MasterNode</a></li>
-<li><a href="org/incendo/jenkins/objects/Node.html" title="interface in org.incendo.jenkins.objects"><span class="interfaceName">Node</span></a></li>
-<li><a href="org/incendo/jenkins/objects/NodeChild.html" title="interface in org.incendo.jenkins.objects"><span class="interfaceName">NodeChild</span></a></li>
-<li><a href="org/incendo/jenkins/objects/NodePath.html" title="interface in org.incendo.jenkins.objects"><span class="interfaceName">NodePath</span></a></li>
 </ul>
 </div>
 </body>

diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
+<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
 <title>Constant Field Values</title>
 <meta name="date" content="2019-01-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -31,8 +31,7 @@
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
 <li><a href="deprecated-list.html">Deprecated</a></li>
@@ -81,8 +80,7 @@ <h2 title="Contents">Contents</h2>
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
 <li><a href="deprecated-list.html">Deprecated</a></li>

diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
+<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
 <title>Deprecated List</title>
 <meta name="date" content="2019-01-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -31,8 +31,7 @@
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
 <li class="navBarCell1Rev">Deprecated</li>
@@ -81,8 +80,7 @@ <h2 title="Contents">Contents</h2>
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
 <li class="navBarCell1Rev">Deprecated</li>

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
+<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
 <title>API Help</title>
 <meta name="date" content="2019-01-25">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -31,8 +31,7 @@
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
 <li><a href="deprecated-list.html">Deprecated</a></li>
@@ -75,10 +74,6 @@ <h1 class="title">How This API Document Is Organized</h1>
 <div class="contentContainer">
 <ul class="blockList">
 <li class="blockList">
-<h2>Overview</h2>
-<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>
-</li>
-<li class="blockList">
 <h2>Package</h2>
 <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>
 <ul>
@@ -182,8 +177,7 @@ <h2>Constant Field Values</h2>
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="overview-tree.html">Tree</a></li>
 <li><a href="deprecated-list.html">Deprecated</a></li>

diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:04:07 CET 2019 -->
-<title>A-Index</title>
+<!-- Generated by javadoc (1.8.0_191) on Fri Jan 25 15:09:13 CET 2019 -->
+<title>I-Index</title>
 <meta name="date" content="2019-01-25">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
@@ -12,7 +12,7 @@
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="A-Index";
+            parent.document.title="I-Index";
         }
     }
     catch(err) {
@@ -31,8 +31,7 @@
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="../overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="../org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="../overview-tree.html">Tree</a></li>
 <li><a href="../deprecated-list.html">Deprecated</a></li>
@@ -68,21 +67,17 @@
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
-<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">
+<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">
 <!--   -->
 </a>
-<h2 class="title">A</h2>
+<h2 class="title">I</h2>
 <dl>
-<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>
-<dd>
-<div class="block">Artifact descriptions are what is listed on Jenkins as artifacts.</div>
-</dd>
-<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>
-<dd>
-<div class="block">Instantiates a new Artifact description.</div>
-</dd>
+<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>
+<dd>&nbsp;</dd>
+<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>
+<dd>&nbsp;</dd>
 </dl>
-<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>
+<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>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
@@ -92,8 +87,7 @@ <h2 class="title">A</h2>
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
-<li><a href="../overview-summary.html">Overview</a></li>
-<li>Package</li>
+<li><a href="../org/incendo/jenkins/package-summary.html">Package</a></li>
 <li>Class</li>
 <li><a href="../overview-tree.html">Tree</a></li>
 <li><a href="../deprecated-list.html">Deprecated</a></li>