Skip to content

Commit

Permalink
🎨 Gradle-6 Format JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gilday committed Dec 31, 2019
1 parent e39b358 commit c5924d2
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@

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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

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();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
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() {
Expand Down
Original file line number Diff line number Diff line change
@@ -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 {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@
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() {
Expand Down

0 comments on commit c5924d2

Please sign in to comment.