From 501245d0c25db2e50d594bc969ad9b6b7793b045 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Bresson?= <dev@jmini.fr>
Date: Sun, 3 Jun 2018 18:32:54 +0200
Subject: [PATCH] Fix javadoc in clioption (#188)

* Fix javadoc warning

* Update 'maven-javadoc-plugin' to 3.0.1
---
 CI/pom.xml.bash                                                | 3 ++-
 CI/pom.xml.circleci                                            | 3 ++-
 CI/pom.xml.circleci.java7                                      | 3 ++-
 CI/pom.xml.ios                                                 | 3 ++-
 CI/pom.xml.shippable                                           | 3 ++-
 modules/openapi-generator/pom.xml                              | 2 +-
 .../src/main/java/org/openapitools/codegen/CliOption.java      | 3 ++-
 pom.xml                                                        | 3 ++-
 8 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/CI/pom.xml.bash b/CI/pom.xml.bash
index 895dc3ec694c..b20d6fb9780b 100644
--- a/CI/pom.xml.bash
+++ b/CI/pom.xml.bash
@@ -214,12 +214,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <source>1.8</source>
                     <encoding>UTF-8</encoding>
                     <maxmemory>1g</maxmemory>
+                    <failOnWarnings>true</failOnWarnings>
                     <excludePackageNames>${javadoc.package.exclude}</excludePackageNames>
                 </configuration>
                 <executions>
diff --git a/CI/pom.xml.circleci b/CI/pom.xml.circleci
index b157730fe4b0..13f0d57dc6b0 100644
--- a/CI/pom.xml.circleci
+++ b/CI/pom.xml.circleci
@@ -218,12 +218,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <source>1.8</source>
                     <encoding>UTF-8</encoding>
                     <maxmemory>1g</maxmemory>
+                    <failOnWarnings>true</failOnWarnings>
                     <excludePackageNames>${javadoc.package.exclude}</excludePackageNames>
                 </configuration>
                 <executions>
diff --git a/CI/pom.xml.circleci.java7 b/CI/pom.xml.circleci.java7
index 0e58889f596d..35ced7128493 100644
--- a/CI/pom.xml.circleci.java7
+++ b/CI/pom.xml.circleci.java7
@@ -218,12 +218,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <source>1.8</source>
                     <encoding>UTF-8</encoding>
                     <maxmemory>1g</maxmemory>
+                    <failOnWarnings>true</failOnWarnings>
                     <excludePackageNames>${javadoc.package.exclude}</excludePackageNames>
                 </configuration>
                 <executions>
diff --git a/CI/pom.xml.ios b/CI/pom.xml.ios
index d144d1fb67c6..806bb420900b 100644
--- a/CI/pom.xml.ios
+++ b/CI/pom.xml.ios
@@ -214,12 +214,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <source>1.8</source>
                     <encoding>UTF-8</encoding>
                     <maxmemory>1g</maxmemory>
+                    <failOnWarnings>true</failOnWarnings>
                     <excludePackageNames>${javadoc.package.exclude}</excludePackageNames>
                 </configuration>
                 <executions>
diff --git a/CI/pom.xml.shippable b/CI/pom.xml.shippable
index d2671818dad9..0e230389daef 100644
--- a/CI/pom.xml.shippable
+++ b/CI/pom.xml.shippable
@@ -214,12 +214,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <source>1.8</source>
                     <encoding>UTF-8</encoding>
                     <maxmemory>1g</maxmemory>
+                    <failOnWarnings>true</failOnWarnings>
                     <excludePackageNames>${javadoc.package.exclude}</excludePackageNames>
                 </configuration>
                 <executions>
diff --git a/modules/openapi-generator/pom.xml b/modules/openapi-generator/pom.xml
index 96dfc3f3a241..9e3f4eabf061 100644
--- a/modules/openapi-generator/pom.xml
+++ b/modules/openapi-generator/pom.xml
@@ -160,7 +160,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <debug>true</debug>
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CliOption.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CliOption.java
index 633aaebfe9bd..72d2b75b103e 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/CliOption.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/CliOption.java
@@ -18,6 +18,7 @@
 package org.openapitools.codegen;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
+
 import io.swagger.v3.parser.util.SchemaTypeUtil;
 
 import java.util.LinkedHashMap;
@@ -108,7 +109,7 @@ public static CliOption newBoolean(String opt, String description) {
      * @param opt Option name
      * @param description Option description
      * @param defaultValue the default value to use if option not specified
-     * @return
+     * @return the CliOption created
      */
     public static CliOption newBoolean(String opt, String description, boolean defaultValue) {
         return new CliOption(opt, description, SchemaTypeUtil.BOOLEAN_TYPE).defaultValue(String.valueOf(defaultValue));
diff --git a/pom.xml b/pom.xml
index 86025fb86eed..27eed456e7c8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -214,12 +214,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.0.1</version>
                 <configuration>
                     <aggregate>true</aggregate>
                     <source>1.8</source>
                     <encoding>UTF-8</encoding>
                     <maxmemory>1g</maxmemory>
+                    <failOnWarnings>true</failOnWarnings>
                     <excludePackageNames>${javadoc.package.exclude}</excludePackageNames>
                 </configuration>
                 <executions>