From b9331afc8fad2e55c0051643e1fc3684da0cf15c Mon Sep 17 00:00:00 2001 From: Johnathan Gilday Date: Tue, 31 Dec 2019 11:17:56 -0500 Subject: [PATCH] :art: Gradle-6 Format JavaDoc --- .../src/main/java/com/baeldung/gradle/RxHelloWorld.java | 8 ++++++-- .../java/com/baeldung/gradle/RxHelloWorldUnitTest.java | 5 +++-- .../com/baeldung/fibonacci/impl/RecursiveFibonacci.java | 4 +++- .../fibonacci/impl/RecursiveFibonacciUnitTest.java | 3 +-- .../baeldung/fibonacci/FibonacciSequenceGenerator.java | 4 +++- .../fibonacci/FibonacciSequenceGeneratorFixture.java | 7 ++++--- 6 files changed, 20 insertions(+), 11 deletions(-) diff --git a/gradle-6/dependency-constraints/src/main/java/com/baeldung/gradle/RxHelloWorld.java b/gradle-6/dependency-constraints/src/main/java/com/baeldung/gradle/RxHelloWorld.java index 1c4e71541d..e4ebd9ba6b 100644 --- a/gradle-6/dependency-constraints/src/main/java/com/baeldung/gradle/RxHelloWorld.java +++ b/gradle-6/dependency-constraints/src/main/java/com/baeldung/gradle/RxHelloWorld.java @@ -5,10 +5,14 @@ import io.reactivex.Observable; import java.util.List; -/** Demonstrates a library type that returns an RxJava type. */ +/** + * Demonstrates a library type that returns an RxJava type. + */ public class RxHelloWorld { - /** @return an {@link Observable} that emits events "hello" and "world" before completing. */ + /** + * @return an {@link Observable} that emits events "hello" and "world" before completing. + */ public static Observable hello() { // Guava ImmutableList class is an implementation detail. List values = ImmutableList.of("hello", "world"); diff --git a/gradle-6/dependency-constraints/src/test/java/com/baeldung/gradle/RxHelloWorldUnitTest.java b/gradle-6/dependency-constraints/src/test/java/com/baeldung/gradle/RxHelloWorldUnitTest.java index 232c7d7e02..8a05fcfda3 100644 --- a/gradle-6/dependency-constraints/src/test/java/com/baeldung/gradle/RxHelloWorldUnitTest.java +++ b/gradle-6/dependency-constraints/src/test/java/com/baeldung/gradle/RxHelloWorldUnitTest.java @@ -4,9 +4,10 @@ import org.junit.jupiter.api.Test; import static com.baeldung.gradle.RxHelloWorld.hello; -/** Unit test for {@link RxHelloWorld}. */ +/** + * Unit test for {@link RxHelloWorld}. + */ final class RxHelloWorldUnitTest { - @Test void it_emits_hello_world_values() { hello().test().assertValues("hello", "world").assertComplete(); } diff --git a/gradle-6/fibonacci-recursive/src/main/java/com/baeldung/fibonacci/impl/RecursiveFibonacci.java b/gradle-6/fibonacci-recursive/src/main/java/com/baeldung/fibonacci/impl/RecursiveFibonacci.java index 764f4ad12c..def79521bd 100644 --- a/gradle-6/fibonacci-recursive/src/main/java/com/baeldung/fibonacci/impl/RecursiveFibonacci.java +++ b/gradle-6/fibonacci-recursive/src/main/java/com/baeldung/fibonacci/impl/RecursiveFibonacci.java @@ -3,7 +3,9 @@ package com.baeldung.fibonacci.impl; import com.baeldung.fibonacci.FibonacciSequenceGenerator; import com.google.auto.service.AutoService; -/** Recursive implementation of the {@link FibonacciSequenceGenerator}. */ +/** + * Recursive implementation of the {@link FibonacciSequenceGenerator}. + */ @AutoService(FibonacciSequenceGenerator.class) public final class RecursiveFibonacci implements FibonacciSequenceGenerator { @Override public int generate(int nth) { diff --git a/gradle-6/fibonacci-recursive/src/test/java/com/baeldung/fibonacci/impl/RecursiveFibonacciUnitTest.java b/gradle-6/fibonacci-recursive/src/test/java/com/baeldung/fibonacci/impl/RecursiveFibonacciUnitTest.java index 0703c97848..766f3b251b 100644 --- a/gradle-6/fibonacci-recursive/src/test/java/com/baeldung/fibonacci/impl/RecursiveFibonacciUnitTest.java +++ b/gradle-6/fibonacci-recursive/src/test/java/com/baeldung/fibonacci/impl/RecursiveFibonacciUnitTest.java @@ -4,8 +4,7 @@ import com.baeldung.fibonacci.FibonacciSequenceGenerator; import com.baeldung.fibonacci.FibonacciSequenceGeneratorFixture; /** - * Unit test which reuses the {@link FibonacciSequenceGeneratorFixture} test mix-in exported from - * the fibonacci-spi project. + * Unit test which reuses the {@link FibonacciSequenceGeneratorFixture} test mix-in exported from the fibonacci-spi project. */ final class RecursiveFibonacciUnitTest implements FibonacciSequenceGeneratorFixture { @Override public FibonacciSequenceGenerator provide() { diff --git a/gradle-6/fibonacci-spi/src/main/java/com/baeldung/fibonacci/FibonacciSequenceGenerator.java b/gradle-6/fibonacci-spi/src/main/java/com/baeldung/fibonacci/FibonacciSequenceGenerator.java index e152b7b515..5fd99100fc 100644 --- a/gradle-6/fibonacci-spi/src/main/java/com/baeldung/fibonacci/FibonacciSequenceGenerator.java +++ b/gradle-6/fibonacci-spi/src/main/java/com/baeldung/fibonacci/FibonacciSequenceGenerator.java @@ -1,6 +1,8 @@ package com.baeldung.fibonacci; -/** Describes an SPI for a Fibonacci sequence generator function. */ +/** + * Describes an SPI for a Fibonacci sequence generator function. + */ public interface FibonacciSequenceGenerator { /** diff --git a/gradle-6/fibonacci-spi/src/testFixtures/java/com/baeldung/fibonacci/FibonacciSequenceGeneratorFixture.java b/gradle-6/fibonacci-spi/src/testFixtures/java/com/baeldung/fibonacci/FibonacciSequenceGeneratorFixture.java index e5bfe8117b..5394590c03 100644 --- a/gradle-6/fibonacci-spi/src/testFixtures/java/com/baeldung/fibonacci/FibonacciSequenceGeneratorFixture.java +++ b/gradle-6/fibonacci-spi/src/testFixtures/java/com/baeldung/fibonacci/FibonacciSequenceGeneratorFixture.java @@ -6,12 +6,13 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; /** - * Reusable test fixture for {@link FibonacciSequenceGenerator} implementations. Tests will be - * skipped if no such implementation exists. + * Reusable test fixture for {@link FibonacciSequenceGenerator} implementations. Tests will be skipped if no such implementation exists. */ public interface FibonacciSequenceGeneratorFixture { - /** @return the implementation of {@link FibonacciSequenceGenerator} to test. Must not be null */ + /** + * @return the implementation of {@link FibonacciSequenceGenerator} to test. Must not be null + */ FibonacciSequenceGenerator provide(); @Test default void when_sequence_index_is_negative_then_throws() {