Skip to content

Commit a5a59ca

Browse files
committed
Fixed JavaDoc issues.
Generate JavaDoc during site generation.
1 parent 315bb4f commit a5a59ca

File tree

4 files changed

+14
-100
lines changed

4 files changed

+14
-100
lines changed

jenkins-client/src/main/java/com/offbytwo/jenkins/JenkinsServer.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414

1515
import javax.xml.bind.JAXBException;
1616

17-
import com.offbytwo.jenkins.helper.FunctionalHelper;
18-
import com.offbytwo.jenkins.model.BaseModel;
1917
import org.apache.http.HttpStatus;
2018
import org.apache.http.client.HttpResponseException;
2119
import org.apache.http.entity.ContentType;

jenkins-client/src/main/java/com/offbytwo/jenkins/model/BuildWithDetails.java

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,12 @@
2121
import java.net.URI;
2222
import java.net.URISyntaxException;
2323
import java.util.ArrayList;
24-
import java.util.Collection;
2524
import java.util.Collections;
2625
import java.util.HashMap;
2726
import java.util.LinkedHashMap;
2827
import java.util.List;
2928
import java.util.Map;
3029
import java.util.Objects;
31-
import java.util.stream.Collectors;
32-
33-
import java.util.function.Function;
34-
import java.util.stream.Collectors;
3530

3631
import static java.util.stream.Collectors.toList;
3732
import static java.util.stream.Collectors.toMap;
@@ -362,7 +357,7 @@ public Map<String, Object> getParameters() {
362357
* @return The full console output of the build. The line separation is done by
363358
* {@code CR+LF}.
364359
*
365-
* @see {@link #streamConsoleOutput(BuildConsoleStreamListener, int, int, boolean)} method for obtaining logs for running build
360+
* @see #streamConsoleOutput(BuildConsoleStreamListener, int, int, boolean) method for obtaining logs for running build
366361
*
367362
* @throws IOException in case of a failure.
368363
*/
@@ -373,7 +368,7 @@ public String getConsoleOutputText() throws IOException {
373368
/**
374369
* The full console output with HTML.
375370
*
376-
* @see {@link #streamConsoleOutput(BuildConsoleStreamListener, int, int, boolean)} method for obtaining logs for running build
371+
* @see #streamConsoleOutput(BuildConsoleStreamListener, int, int, boolean) method for obtaining logs for running build
377372
*
378373
* @return The console output as HTML.
379374
* @throws IOException in case of an error.
@@ -430,6 +425,7 @@ public void streamConsoleOutput(final BuildConsoleStreamListener listener, final
430425
* Use this method to periodically obtain logs from jenkins and skip chunks that were already received
431426
*
432427
* @param bufferOffset offset in console lo
428+
* @param crumbFlag <code>true</code> or <code>false</code>.
433429
* @return ConsoleLog object containing console output of the build. The line separation is done by
434430
* {@code CR+LF}.
435431
* @throws IOException in case of a failure.

jenkins-client/src/test/java/com/offbytwo/jenkins/FirstTest.java

Lines changed: 0 additions & 56 deletions
This file was deleted.

pom.xml

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -406,43 +406,18 @@
406406
<groupId>org.apache.maven.plugins</groupId>
407407
<artifactId>maven-project-info-reports-plugin</artifactId>
408408
</plugin>
409-
<!--
410409
<plugin>
411410
<groupId>org.apache.maven.plugins</groupId>
412-
<artifactId>maven-pmd-plugin</artifactId>
413-
<version>3.5</version>
414-
<configuration>
415-
<targetJdk>${maven.compiler.target}</targetJdk>
416-
</configuration>
417-
</plugin>
418-
<plugin>
419-
<groupId>org.codehaus.mojo</groupId>
420-
<artifactId>cobertura-maven-plugin</artifactId>
421-
<version>2.7</version>
422-
</plugin>
423-
<plugin>
424-
<groupId>org.codehaus.mojo</groupId>
425-
<artifactId>findbugs-maven-plugin</artifactId>
426-
<version>2.5.2</version>
427-
</plugin>
428-
<plugin>
429-
<groupId>org.apache.maven.plugins</groupId>
430-
<artifactId>maven-jxr-plugin</artifactId>
431-
<version>2.5</version>
411+
<artifactId>maven-javadoc-plugin</artifactId>
412+
<reportSets>
413+
<reportSet>
414+
<reports>
415+
<report>javadoc-no-fork</report>
416+
<report>aggregate-no-fork</report>
417+
</reports>
418+
</reportSet>
419+
</reportSets>
432420
</plugin>
433-
-->
434-
<plugin>
435-
<groupId>org.apache.maven.plugins</groupId>
436-
<artifactId>maven-javadoc-plugin</artifactId>
437-
<reportSets>
438-
<reportSet>
439-
<reports>
440-
<report>javadoc-no-fork</report>
441-
<report>aggregate-no-fork</report>
442-
</reports>
443-
</reportSet>
444-
</reportSets>
445-
</plugin>
446421
</plugins>
447422
</reporting>
448423

@@ -490,7 +465,8 @@
490465
<execution>
491466
<id>attach-javadocs</id>
492467
<goals>
493-
<goal>jar</goal>
468+
<goal>javadoc-no-fork</goal>
469+
<goal>test-javadoc-no-fork</goal>
494470
</goals>
495471
</execution>
496472
</executions>

0 commit comments

Comments
 (0)