Conform to google-java-format when generating JavaDoc for classes (#…

…194) The generated JavaDoc for `record` classes would not always conform to `google-java-format`. When a `record` was not `@deprecated`, there would be no empty line between the description and the `@param`s. This has been solved, so that there is always an empty line between the description and deprecation/parameters.
Chrimle · Oct 25, 2024 · 4cf7078 · 4cf7078
1 parent e088fa1
commit 4cf7078
Show file tree

Hide file tree

Showing 82 changed files with 134 additions and 84 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ The mustache templates can be acquired through multiple ways.
 <dependency>
     <groupId>io.github.chrimle</groupId>
     <artifactId>openapi-to-java-records-mustache-templates</artifactId>
-    <version>1.11.0</version>
+    <version>1.11.1</version>
 </dependency>
 ```
 

diff --git a/docs/index.md b/docs/index.md
@@ -13,7 +13,7 @@ The mustache templates can be acquired through multiple ways.
 <dependency>
     <groupId>io.github.chrimle</groupId>
     <artifactId>openapi-to-java-records-mustache-templates</artifactId>
-    <version>1.11.0</version>
+    <version>1.11.1</version>
 </dependency>
 ```
 

diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>io.github.chrimle</groupId>
     <artifactId>openapi-to-java-records-mustache-templates</artifactId>
-    <version>1.11.0</version>
+    <version>1.11.1</version>
 
     <!-- Project Information -->
     <name>OpenAPI to Java records :: Mustache Templates</name>

diff --git a/src/main/resources/templates/generateBuilders.mustache b/src/main/resources/templates/generateBuilders.mustache
@@ -1,6 +1,6 @@
 {{!
   Source: openapi-to-java-records-mustache-templates
-  Version: 1.11.0
+  Version: 1.11.1
 
   Enabled via configOptions.generateBuilders=true
 

diff --git a/src/main/resources/templates/javadoc.mustache b/src/main/resources/templates/javadoc.mustache
@@ -1,12 +1,14 @@
 {{!
   Source: openapi-to-java-records-mustache-templates
-  Version: 1.11.0
+  Version: 1.11.1
 
   This template is optional, and does not override an existing template.
 
 }}/**
  * {{description}}{{^description}}{{classname}}{{/description}}{{#isDeprecated}}
  *
- * @deprecated{{/isDeprecated}}{{#vars}}
- * @param {{name}} {{description}}{{^description}}{{{datatypeWithEnum}}}{{/description}}{{/vars}}
+ * @deprecated{{/isDeprecated}}{{#vars}}{{#-first}}{{^isDeprecated}}
+ *{{/isDeprecated}}{{/-first}}
+ * @param {{name}} {{description}}{{^description}}{{{datatypeWithEnum}}}{{/description}}{{!
+}}{{/vars}}
  */
diff --git a/src/main/resources/templates/licenseInfo.mustache b/src/main/resources/templates/licenseInfo.mustache
@@ -12,6 +12,6 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
diff --git a/src/main/resources/templates/modelEnum.mustache b/src/main/resources/templates/modelEnum.mustache
@@ -1,6 +1,6 @@
 {{!
   Source: openapi-to-java-records-mustache-templates
-  Version: 1.11.0
+  Version: 1.11.1
 
   Required mustache templates (generation will fail without them):
     - `deprecation.mustache`

diff --git a/src/main/resources/templates/pojo.mustache b/src/main/resources/templates/pojo.mustache
@@ -1,6 +1,6 @@
 {{!
   Source: openapi-to-java-records-mustache-templates
-  Version: 1.11.0
+  Version: 1.11.1
 
   Required imports:
     - none

diff --git a/src/main/resources/templates/serializableModel.mustache b/src/main/resources/templates/serializableModel.mustache
@@ -1,6 +1,6 @@
 {{!
   Source: openapi-to-java-records-mustache-templates
-  Version: 1.11.0
+  Version: 1.11.1
 
   Enabled via configOptions.serializableModel=true
 

diff --git a/src/main/resources/templates/useBeanValidation.mustache b/src/main/resources/templates/useBeanValidation.mustache
@@ -1,6 +1,6 @@
 {{!
   Source: openapi-to-java-records-mustache-templates
-  Version: 1.11.0
+  Version: 1.11.1
 
   Enabled via configOption.useBeanValidation=true
 

diff --git a/...a/main/io/github/chrimle/example/additionalEnumTypeAnnotations/DeprecatedExampleEnum.java b/...a/main/io/github/chrimle/example/additionalEnumTypeAnnotations/DeprecatedExampleEnum.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...main/io/github/chrimle/example/additionalEnumTypeAnnotations/DeprecatedExampleRecord.java b/...main/io/github/chrimle/example/additionalEnumTypeAnnotations/DeprecatedExampleRecord.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...rc/gen/java/main/io/github/chrimle/example/additionalEnumTypeAnnotations/ExampleEnum.java b/...rc/gen/java/main/io/github/chrimle/example/additionalEnumTypeAnnotations/ExampleEnum.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/.../gen/java/main/io/github/chrimle/example/additionalEnumTypeAnnotations/ExampleRecord.java b/.../gen/java/main/io/github/chrimle/example/additionalEnumTypeAnnotations/ExampleRecord.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record
+ *
  * @param field1 a boolean field
  */
 public record ExampleRecord(

diff --git a/.../github/chrimle/example/additionalEnumTypeAnnotations/ExampleRecordWithDefaultFields.java b/.../github/chrimle/example/additionalEnumTypeAnnotations/ExampleRecordWithDefaultFields.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record with default fields
+ *
  * @param field1 a String field with a default value
  */
 public record ExampleRecordWithDefaultFields(

diff --git a/...imle/example/additionalEnumTypeAnnotations/ExampleRecordWithNullableFieldsOfEachType.java b/...imle/example/additionalEnumTypeAnnotations/ExampleRecordWithNullableFieldsOfEachType.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -34,6 +34,7 @@
 
 /**
  * Example of a Record with fields of each type
+ *
  * @param field1 a Boolean field
  * @param field2 a String field
  * @param field3 an Integer field

diff --git a/...imle/example/additionalEnumTypeAnnotations/ExampleRecordWithRequiredFieldsOfEachType.java b/...imle/example/additionalEnumTypeAnnotations/ExampleRecordWithRequiredFieldsOfEachType.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -36,6 +36,7 @@
 
 /**
  * Example of a Record with fields of each type
+ *
  * @param field1 a Boolean field
  * @param field2 a String field
  * @param field3 an Integer field

diff --git a/...ain/io/github/chrimle/example/additionalEnumTypeAnnotations/RecordWithAllConstraints.java b/...ain/io/github/chrimle/example/additionalEnumTypeAnnotations/RecordWithAllConstraints.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -33,6 +33,7 @@
 
 /**
  * Example of a Record which has fields with constraints
+ *
  * @param stringStandard String
  * @param stringDefault String
  * @param stringNullable String

diff --git a/...va/main/io/github/chrimle/example/additionalEnumTypeAnnotations/RecordWithInnerEnums.java b/...va/main/io/github/chrimle/example/additionalEnumTypeAnnotations/RecordWithInnerEnums.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record with inner enum classes
+ *
  * @param exampleInner Example of an inner enum class
  * @param exampleInnerTwo Example of another inner enum class
  */

diff --git a/.../main/io/github/chrimle/example/additionalModelTypeAnnotations/DeprecatedExampleEnum.java b/.../main/io/github/chrimle/example/additionalModelTypeAnnotations/DeprecatedExampleEnum.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...ain/io/github/chrimle/example/additionalModelTypeAnnotations/DeprecatedExampleRecord.java b/...ain/io/github/chrimle/example/additionalModelTypeAnnotations/DeprecatedExampleRecord.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...c/gen/java/main/io/github/chrimle/example/additionalModelTypeAnnotations/ExampleEnum.java b/...c/gen/java/main/io/github/chrimle/example/additionalModelTypeAnnotations/ExampleEnum.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...gen/java/main/io/github/chrimle/example/additionalModelTypeAnnotations/ExampleRecord.java b/...gen/java/main/io/github/chrimle/example/additionalModelTypeAnnotations/ExampleRecord.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record
+ *
  * @param field1 a boolean field
  */
 @com.chrimle.example.annotations.TestAnnotationOne

diff --git a/...github/chrimle/example/additionalModelTypeAnnotations/ExampleRecordWithDefaultFields.java b/...github/chrimle/example/additionalModelTypeAnnotations/ExampleRecordWithDefaultFields.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record with default fields
+ *
  * @param field1 a String field with a default value
  */
 @com.chrimle.example.annotations.TestAnnotationOne

diff --git a/...mle/example/additionalModelTypeAnnotations/ExampleRecordWithNullableFieldsOfEachType.java b/...mle/example/additionalModelTypeAnnotations/ExampleRecordWithNullableFieldsOfEachType.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -34,6 +34,7 @@
 
 /**
  * Example of a Record with fields of each type
+ *
  * @param field1 a Boolean field
  * @param field2 a String field
  * @param field3 an Integer field

diff --git a/...mle/example/additionalModelTypeAnnotations/ExampleRecordWithRequiredFieldsOfEachType.java b/...mle/example/additionalModelTypeAnnotations/ExampleRecordWithRequiredFieldsOfEachType.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -36,6 +36,7 @@
 
 /**
  * Example of a Record with fields of each type
+ *
  * @param field1 a Boolean field
  * @param field2 a String field
  * @param field3 an Integer field

diff --git a/...in/io/github/chrimle/example/additionalModelTypeAnnotations/RecordWithAllConstraints.java b/...in/io/github/chrimle/example/additionalModelTypeAnnotations/RecordWithAllConstraints.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -33,6 +33,7 @@
 
 /**
  * Example of a Record which has fields with constraints
+ *
  * @param stringStandard String
  * @param stringDefault String
  * @param stringNullable String

diff --git a/...a/main/io/github/chrimle/example/additionalModelTypeAnnotations/RecordWithInnerEnums.java b/...a/main/io/github/chrimle/example/additionalModelTypeAnnotations/RecordWithInnerEnums.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record with inner enum classes
+ *
  * @param exampleInner Example of an inner enum class
  * @param exampleInnerTwo Example of another inner enum class
  */

diff --git a/...c/src/gen/java/main/io/github/chrimle/example/generateBuilders/DeprecatedExampleEnum.java b/...c/src/gen/java/main/io/github/chrimle/example/generateBuilders/DeprecatedExampleEnum.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...src/gen/java/main/io/github/chrimle/example/generateBuilders/DeprecatedExampleRecord.java b/...src/gen/java/main/io/github/chrimle/example/generateBuilders/DeprecatedExampleRecord.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...openapi/src/src/gen/java/main/io/github/chrimle/example/generateBuilders/ExampleEnum.java b/...openapi/src/src/gen/java/main/io/github/chrimle/example/generateBuilders/ExampleEnum.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 

diff --git a/...enapi/src/src/gen/java/main/io/github/chrimle/example/generateBuilders/ExampleRecord.java b/...enapi/src/src/gen/java/main/io/github/chrimle/example/generateBuilders/ExampleRecord.java
@@ -12,7 +12,7 @@
  * openapi-to-java-records-mustache-templates. For further information,
  * questions, requesting features or reporting issues, please visit:
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
- * Generated with Version: 1.11.0
+ * Generated with Version: 1.11.1
  *
  */
 
@@ -29,6 +29,7 @@
 
 /**
  * Example of a Record
+ *
  * @param field1 a boolean field
  */
 public record ExampleRecord(