Attach Javadocs to jar and fix warnings in some doc blocks (#11)

ExpediaGroup · Oct 29, 2019 · 3f69369 · 3f69369
1 parent 9abe159
commit 3f69369
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/pom.xml b/pom.xml
@@ -172,6 +172,19 @@
                     <target>${java.target.version}</target>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.1.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>

diff --git a/src/main/java/com/homeaway/dropwizard/bundle/resilience4j/Resilience4jBundle.java b/src/main/java/com/homeaway/dropwizard/bundle/resilience4j/Resilience4jBundle.java
@@ -51,6 +51,8 @@ public class Resilience4jBundle<T> implements ConfiguredBundle<T> {
 
     /**
      * Create a new bundle
+     *
+     * @param resilienceConfiguratorFunction Function to extract the Resilience4j configuration from the dropwizard configuration
      */
     public Resilience4jBundle(@NonNull Function<T, Resilience4jConfiguration> resilienceConfiguratorFunction) {
         this(resilienceConfiguratorFunction,
@@ -61,7 +63,9 @@ public Resilience4jBundle(@NonNull Function<T, Resilience4jConfiguration> resili
     /**
      * Create a new bundle, with a function for modifying CircuitBreaker configurations
      *
+     * @param resilienceConfiguratorFunction Function to extract the Resilience4j configuration from the dropwizard configuration
      * @param circuitBreakerConfigurator A function that will be passed the name and builder for each circuit breaker before it is created
+     * @param retryConfigurator A function that will be passed the name and builder for each retryer
      */
     public Resilience4jBundle(@NonNull Function<T, Resilience4jConfiguration> resilienceConfiguratorFunction,
                               @NonNull BiConsumer<String, CircuitBreakerConfig.Builder> circuitBreakerConfigurator,