fix: escape invalid javadoc characters

sundrio · Jul 21, 2021 · 147f519 · 147f519
1 parent ad92640
commit 147f519
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 9 deletions.
diff --git a/codegen/api/src/main/java/io/sundr/codegen/api/CodeGenerator.java b/codegen/api/src/main/java/io/sundr/codegen/api/CodeGenerator.java
@@ -121,7 +121,6 @@ public static <T> Builder<T> newGenerator(Class<T> type) {
   /**
    * Generate one or more items
    * 
-   * @param <T> the type of items to generate
    * @param items the items to generate
    * @return true if generation was succesful, false otherwise
    */

diff --git a/codegen/api/src/main/java/io/sundr/codegen/api/Renderer.java b/codegen/api/src/main/java/io/sundr/codegen/api/Renderer.java
@@ -20,7 +20,7 @@
 import java.util.function.Function;
 
 /**
- * The part of the CodeGenerator that renders an instance of <T> into a {@link String}.
+ * The part of the CodeGenerator that renders an instance of {@literal <}T{@literal >} into a {@link String}.
  */
 public interface Renderer<T> {
 
@@ -36,7 +36,7 @@ public interface Renderer<T> {
   /**
    * The rendering method.
    * 
-   * @param the item to render
+   * @param item the item to render
    * @return the {@link String} representation of the item.
    */
   default String render(T item) {

diff --git a/codegen/template/src/main/java/io/sundr/codegen/template/TemplateRendererFactory.java b/codegen/template/src/main/java/io/sundr/codegen/template/TemplateRendererFactory.java
@@ -40,7 +40,7 @@ public String[] getTemplateExtensions() {
   /**
    * Check if the renderer supports the specified template.
    * 
-   * @param content The template content.
+   * @param templateUrl The template url.
    * @return true if content is supported, false otherwise.
    */
   public boolean accepts(URL templateUrl) {

diff --git a/components/swagger/src/main/java/io/sundr/swagger/language/ArtifactUtil.java b/components/swagger/src/main/java/io/sundr/swagger/language/ArtifactUtil.java
@@ -30,7 +30,7 @@ public class ArtifactUtil {
   /**
    * Extracts the groupId from the specified coordinates
    * 
-   * @param the maven coordinates
+   * @param coordinates the maven coordinates
    * @return the groupId
    */
   public static String groupId(String coordinates) {
@@ -40,7 +40,7 @@ public static String groupId(String coordinates) {
   /**
    * Extracts the artifactId from the specified coordinates
    * 
-   * @param the maven coordinates
+   * @param coordinates the maven coordinates
    * @return the artifactId
    */
   public static String artifactId(String coordinates) {
@@ -50,7 +50,7 @@ public static String artifactId(String coordinates) {
   /**
    * Extracts the version from the specified coordinates
    * 
-   * @param the maven coordinates
+   * @param coordinates the maven coordinates
    * @return the version
    */
   public static String version(String coordinates) {
@@ -60,7 +60,7 @@ public static String version(String coordinates) {
   /**
    * Extracts the classifier from the specified coordinates
    * 
-   * @param the maven coordinates
+   * @param coordinates the maven coordinates
    * @return the classifier as an {@link Optional} string.
    */
   public static Optional<String> classifier(String coordinates) {

diff --git a/model/repo/src/main/java/io/sundr/model/repo/DefinitionRepository.java b/model/repo/src/main/java/io/sundr/model/repo/DefinitionRepository.java
@@ -60,7 +60,7 @@ private DefinitionRepository() {
    * The scoped instance is something that may be used in the context of a {@link Function} or a {@link Callable}.
    * So, when this method is used from within a call to Definition.withRepository(repo).call(...) it will return the value of
    * repo instead of the Singleton intance.
-   * The same goes for Definition.withNewRepository(repo -> { ... }).
+   * The same goes for Definition.withNewRepository(repo -{@literal >} { ... }).
    * 
    * @return the scoped instance if called from within withRepo/withNewRepo lambda, or the singleton instance otherwise.
    */