Updated Maven setup for Javadocs

whitfin · Mar 28, 2017 · 9162604 · 9162604
1 parent 888d380
commit 9162604
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 48 deletions.
diff --git a/pom.xml b/pom.xml
@@ -84,6 +84,32 @@
                     <target>1.8</target>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.10.4</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>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
@@ -116,32 +142,6 @@
             <id>release</id>
             <build>
                 <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-source-plugin</artifactId>
-                        <version>3.0.1</version>
-                        <executions>
-                            <execution>
-                                <id>attach-sources</id>
-                                <goals>
-                                    <goal>jar-no-fork</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>2.10.4</version>
-                        <executions>
-                            <execution>
-                                <id>attach-javadocs</id>
-                                <goals>
-                                    <goal>jar</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>

diff --git a/src/main/java/com/zackehh/jackson/scope/SafeExecution.java b/src/main/java/com/zackehh/jackson/scope/SafeExecution.java
@@ -20,7 +20,7 @@ public interface SafeExecution<T> {
      *
      * @param mapper an ObjectMapper instance to use in scope.
      * @return an instance of the defined custom type.
-     * @throws IOException
+     * @throws IOException if an error occurs in the Jackson operation.
      */
     T apply(ObjectMapper mapper) throws IOException;
-}
+}
diff --git a/src/main/java/com/zackehh/jackson/stream/collectors/ArrayNodeCollector.java b/src/main/java/com/zackehh/jackson/stream/collectors/ArrayNodeCollector.java
@@ -24,8 +24,6 @@ public class ArrayNodeCollector implements Collector<JsonNode, ArrayNode, ArrayN
     /**
      * Simply returns a Supplier which creates a new empty ArrayNode instance
      * in order to collect JsonNode values into.
-     *
-     * @inheritDoc
      */
     @Override
     public Supplier<ArrayNode> supplier() {
@@ -35,8 +33,6 @@ public Supplier<ArrayNode> supplier() {
     /**
      * Returns a BiConsumer which adds a pre-created JsonNode into the ArrayNode
      * instance provided by the Supplier.
-     *
-     * @inheritDoc
      */
     @Override
     public BiConsumer<ArrayNode, JsonNode> accumulator() {
@@ -46,8 +42,6 @@ public BiConsumer<ArrayNode, JsonNode> accumulator() {
     /**
      * Returns an operator which combines two ArrayNode instances by adding all
      * JsonNode values from the right instance into the left instance.
-     *
-     * @inheritDoc
      */
     @Override
     public BinaryOperator<ArrayNode> combiner() {
@@ -58,8 +52,6 @@ public BinaryOperator<ArrayNode> combiner() {
      * Returns a Function to identify the input.
      *
      * This is moot and not called due to the provided Characteristics.
-     *
-     * @inheritDoc
      */
     @Override
     public Function<ArrayNode, ArrayNode> finisher() {
@@ -69,8 +61,6 @@ public Function<ArrayNode, ArrayNode> finisher() {
     /**
      * Returns a Set of Characteristics to apply to this Collector. The only one
      * provided is that there's an identity finisher, in order to remove the call.
-     *
-     * @inheritDoc
      */
     @Override
     public Set<Characteristics> characteristics() {

diff --git a/src/main/java/com/zackehh/jackson/stream/collectors/ObjectNodeCollector.java b/src/main/java/com/zackehh/jackson/stream/collectors/ObjectNodeCollector.java
@@ -26,8 +26,6 @@ public class ObjectNodeCollector implements Collector<Map.Entry<String, JsonNode
     /**
      * Simply returns a Supplier which creates a new empty ObjectNode
      * instance in order to collect JsonNode values into.
-     *
-     * @inheritDoc
      */
     @Override
     public Supplier<ObjectNode> supplier() {
@@ -37,8 +35,6 @@ public Supplier<ObjectNode> supplier() {
     /**
      * Returns a BiConsumer which adds a pre-created JsonNode into the ObjectNode
      * instance provided by the Supplier.
-     *
-     * @inheritDoc
      */
     @Override
     public BiConsumer<ObjectNode, Map.Entry<String, JsonNode>> accumulator() {
@@ -51,8 +47,6 @@ public BiConsumer<ObjectNode, Map.Entry<String, JsonNode>> accumulator() {
      *
      * This will overwrite any entries in the left with the same key as an entry
      * in the right instance.
-     *
-     * @inheritDoc
      */
     @Override
     public BinaryOperator<ObjectNode> combiner() {
@@ -70,8 +64,6 @@ public BinaryOperator<ObjectNode> combiner() {
      * Returns a Function to identify the input.
      *
      * This is moot and not called due to the provided Characteristics.
-     *
-     * @inheritDoc
      */
     @Override
     public Function<ObjectNode, ObjectNode> finisher() {
@@ -82,8 +74,6 @@ public Function<ObjectNode, ObjectNode> finisher() {
      * Returns a Set of Characteristics to apply to this Collector. The only ones
      * provided are that there's an identity finisher and that there is not specific
      * order of the incoming pairs.
-     *
-     * @inheritDoc
      */
     @Override
     public Set<Characteristics> characteristics() {