Fix JavaDoc generation and enable html checks again

Fix #116

Author: sonallux

pom.xml

@@ -114,7 +114,6 @@
                 <version>${maven-javadoc-plugin.version}</version>
                 <configuration>
                     <release>${java.version}</release>
-                    <doclint>-html</doclint>
                 </configuration>
                 <executions>
                     <execution>

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/JavaGenerator.java

@@ -30,7 +30,7 @@ public void generate(OpenAPI openAPI, Path outputDirectory, JavaPackage javaPack
 
         EndpointSplitter.splitEndpoints(spotifyWebApi);
 
-        var apiTemplate = new ApiGenerator(generationContext, objectGenerator::getObjectNameForResponse);
+        var apiTemplate = new ApiGenerator(generationContext);
         apiTemplate.generateEndpoints(spotifyWebApi);
 
         new SpotifyWebApiGenerator(generationContext).generate();

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/generators/ApiGenerator.java

@@ -12,7 +12,6 @@
 import lombok.RequiredArgsConstructor;
 
 import java.util.*;
-import java.util.function.Function;
 import java.util.stream.Stream;
 
 import static java.util.stream.Collectors.joining;
@@ -21,7 +20,6 @@
 @RequiredArgsConstructor
 public class ApiGenerator {
     private final GenerationContext generationContext;
-    private final Function<String, String> responseTypeMapper;
 
     private JavaPackage apisJavaPackage;
 
@@ -108,7 +106,7 @@ private List<ApiEndpoint.Parameter> generateEndpointRequest(ApiEndpoint endpoint
                 .map(ApiEndpoint.Parameter::asMethodParameter)
                 .collect(joining(", ")));
 
-        context.put("requiredJavaDocParameters", requiredParameterList.stream().map(ApiEndpoint.Parameter::asJavaDoc).collect(toList()));
+        context.put("requiredJavaDocParameters", requiredParameterList.stream().map(ApiEndpoint.Parameter::asJavaDoc).toList());
 
         endpoint.getOptionalQueryParameters().stream()
                 .filter(p -> "additional_types".equals(p.getName()))

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/generators/ObjectModelCreator.java

@@ -54,14 +54,8 @@ private void visitOperation(ApiCategory category, PathItem.HttpMethod method, St
         if (operation.getParameters() != null) {
             operation.getParameters().stream().map(generationContext::resolveParameter).forEach(parameter -> {
                 switch (parameter.getIn()) {
-                    case "path": {
-                        endpoint.addPathParameter(convertParameter(parameter), parameter.getRequired());
-                        break;
-                    }
-                    case "query": {
-                        endpoint.addQueryParameter(convertParameter(parameter), parameter.getRequired());
-                        break;
-                    }
+                    case "path" -> endpoint.addPathParameter(convertParameter(parameter), parameter.getRequired());
+                    case "query" -> endpoint.addQueryParameter(convertParameter(parameter), parameter.getRequired());
                 }
             });
         }

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/generators/ScopeGenerator.java

@@ -8,7 +8,6 @@
 
 import java.util.HashMap;
 import java.util.Map;
-import java.util.stream.Collectors;
 
 @RequiredArgsConstructor
 public class ScopeGenerator {
@@ -37,7 +36,7 @@ private Map<String, Object> createScope(Scopes scopes, JavaPackage javaPackage)
                         "description", scopeEntry.getValue().trim(),
                         "last", false
                 )))
-                .collect(Collectors.toList());
+                .toList();
         scopesContext.get(scopes.size() - 1).put("last", true);
         context.put("scopes", scopesContext);
 

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/generators/SpotifyWebApiGenerator.java

@@ -9,7 +9,6 @@
 
 import java.util.HashMap;
 import java.util.Map;
-import java.util.stream.Collectors;
 
 @RequiredArgsConstructor
 public class SpotifyWebApiGenerator {
@@ -34,7 +33,7 @@ private Map<String, Object> createContext(OpenAPI openAPI, JavaPackage javaPacka
                 .distinct()
                 .sorted()
                 .map(className -> Map.of("className", className, "fieldName", CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, className)))
-                .collect(Collectors.toList());
+                .toList();
 
         context.put("apis", apis);
         return context;

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/util/JavaPackage.java

@@ -31,7 +31,7 @@ private static boolean isValidJavaPackageName(String[] packageNames) {
         if (packageNames.length == 0) {
             return false;
         }
-        for (String packageName : packageNames) {
+        for (var packageName : packageNames) {
             if (Strings.isNullOrEmpty(packageName)) {
                 return false;
             }

spotify-web-api-java-generator/src/main/java/de/sonallux/spotify/generator/java/util/Markdown2Html.java

@@ -11,7 +11,6 @@
 
 import java.util.Arrays;
 import java.util.List;
-import java.util.stream.Collectors;
 
 public class Markdown2Html {
     private static final Parser PARSER;
@@ -43,20 +42,22 @@ public class Markdown2Html {
     public static String convert(String markdown) {
         var document = PARSER.parse(markdown);
         var html = HTML_RENDERER.render(document);
-        return html.replaceAll("<br />", "<br>");
+        return html
+                .replace("<br />", "<br>")
+                .replace("<img src", "<img alt=\"\" src");
     }
 
     public static String convertToSingleLine(String markdown) {
         return convert(markdown)
-            .replaceAll(">\n", ">")
-            .replaceAll("\n", " ")
+            .replace(">\n", ">")
+            .replace("\n", " ")
             .trim();
     }
 
     public static List<String> convertToLines(String markdown) {
         var html = convert(markdown);
         return Arrays.stream(html.split("\n"))
             .map(String::trim)
-            .collect(Collectors.toList());
+            .toList();
     }
 }

spotify-web-api-java-generator/src/main/resources/templates/api.mustache

@@ -13,7 +13,7 @@ public class {{className}} {
 {{#endpoints}}
 
     /**
-     * <h3>{{name}}</h3>
+     * <h4>{{name}}</h4>
      * {{description}}
     {{#javaDocParameters}}
      * {{.}}

spotify-web-api-java-generator/src/main/resources/templates/request.mustache

@@ -7,7 +7,7 @@ import de.sonallux.spotify.api.http.Request;
 import de.sonallux.spotify.api.models.*;
 
 /**
- * {{name}}
+ * <h2>{{name}}</h2>
 {{#scopes}}
  *
  * <h3>Required OAuth scopes</h3>
@@ -25,7 +25,7 @@ public class {{className}} {
     private final Request request;
 
     /**
-     * <h3>{{name}}</h3>
+     * {{name}}
     {{#requiredJavaDocParameters}}
      * {{.}}
     {{/requiredJavaDocParameters}}
@@ -53,7 +53,8 @@ public class {{className}} {
 
 {{#optionalPathParameters}}
     /**
-     * {{description}}
+     * @param {{javaName}} {{description}}
+     * @return this request
      */
     public {{className}} {{javaName}}({{type}} {{javaName}}) {
         this.request.addPathParameter("{{name}}", String.valueOf({{javaName}}));
@@ -63,7 +64,8 @@ public class {{className}} {
 {{/optionalPathParameters}}
 {{#optionalQueryParameters}}
     /**
-     * {{description}}
+     * @param {{javaName}} {{description}}
+     * @return this request
      */
     public {{className}} {{javaName}}({{type}} {{javaName}}) {
         this.request.addQueryParameter("{{name}}", String.valueOf({{javaName}}));
@@ -73,7 +75,8 @@ public class {{className}} {
 {{/optionalQueryParameters}}
 {{#optionalBodyParameters}}
     /**
-     * {{description}}
+     * @param {{javaName}} {{description}}
+     * @return this request
      */
     public {{className}} {{javaName}}({{type}} {{javaName}}) {
         this.request.addBodyParameter("{{name}}", {{javaName}});
@@ -82,7 +85,8 @@ public class {{className}} {
 
 {{/optionalBodyParameters}}
     /**
-     * Build the request into an executable call
+     * Build the request into an executable api call
+     * @return an executable api call
      */
     public ApiCall<{{responseType}}> build() {
         return apiClient.createApiCall(request, RESPONSE_TYPE);