🎨 Gradle-6 Format JavaDoc

This commit is contained in:
Johnathan Gilday 2019-12-31 11:17:56 -05:00
parent 3a26ab3460
commit b9331afc8f
6 changed files with 20 additions and 11 deletions

View File

@ -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<String> hello() {
// Guava ImmutableList class is an implementation detail.
List<String> values = ImmutableList.of("hello", "world");

View File

@ -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();
}

View File

@ -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) {

View File

@ -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() {

View File

@ -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 {
/**

View File

@ -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() {