Create java-doc for builder factory methods

Issue: #185
muehmar · Dec 6, 2023 · 63a324d · 63a324d
1 parent 54e964d
commit 63a324d
Show file tree

Hide file tree

Showing 4 changed files with 440 additions and 1 deletion.
diff --git a/...uehmar/gradle/openapi/generator/java/generator/pojo/safebuilder/SafeBuilderGenerator.java b/...uehmar/gradle/openapi/generator/java/generator/pojo/safebuilder/SafeBuilderGenerator.java
@@ -14,16 +14,23 @@
 import com.github.muehmar.gradle.openapi.generator.java.model.pojo.JavaObjectPojo;
 import com.github.muehmar.gradle.openapi.generator.settings.PojoSettings;
 import io.github.muehmar.codegenerator.Generator;
+import io.github.muehmar.codegenerator.java.JavaDocGenerator;
 import io.github.muehmar.codegenerator.writer.Writer;
 import java.util.function.Function;
 
 public class SafeBuilderGenerator implements Generator<JavaObjectPojo, PojoSettings> {
+  private static final String FACTORY_JAVA_DOC =
+      "Instantiates a new staged builder. Explicit properties have precedence over additional properties, i.e. an "
+          + "additional property with the same name as an explicit property will be discarded if the explicit "
+          + "property is set or if it gets set.";
   private final Generator<JavaObjectPojo, PojoSettings> delegate;
 
   public SafeBuilderGenerator(SafeBuilderVariant builderVariant) {
     this.delegate =
-        factoryMethod(builderVariant, simpleBuilderMethodName(builderVariant))
+        JavaDocGenerator.<JavaObjectPojo, PojoSettings>ofJavaDocString(FACTORY_JAVA_DOC)
+            .append(factoryMethod(builderVariant, simpleBuilderMethodName(builderVariant)))
             .appendSingleBlankLine()
+            .append(JavaDocGenerator.ofJavaDocString(FACTORY_JAVA_DOC))
             .append(factoryMethod(builderVariant, pojoBuilderMethodName(builderVariant)))
             .appendSingleBlankLine()
             .append(allOfBuilderGenerator(builderVariant))

diff --git a/...com/github/muehmar/gradle/openapi/generator/java/__snapshots__/JavaPojoGeneratorTest.snap b/...com/github/muehmar/gradle/openapi/generator/java/__snapshots__/JavaPojoGeneratorTest.snap
@@ -401,10 +401,22 @@ public class SampleObjectPojo1Dto {
     }
   }
 
+  /**
+   * Instantiates a new staged builder. Explicit properties have precedence over
+   * additional properties, i.e. an additional property with the same name as an
+   * explicit property will be discarded if the explicit property is set or if it
+   * gets set.
+   */
   public static FullPropertyBuilder0 fullBuilder() {
     return new FullPropertyBuilder0(new Builder());
   }
 
+  /**
+   * Instantiates a new staged builder. Explicit properties have precedence over
+   * additional properties, i.e. an additional property with the same name as an
+   * explicit property will be discarded if the explicit property is set or if it
+   * gets set.
+   */
   public static FullPropertyBuilder0 fullSampleObjectPojo1DtoBuilder() {
     return new FullPropertyBuilder0(new Builder());
   }
@@ -477,10 +489,22 @@ public class SampleObjectPojo1Dto {
     }
   }
 
+  /**
+   * Instantiates a new staged builder. Explicit properties have precedence over
+   * additional properties, i.e. an additional property with the same name as an
+   * explicit property will be discarded if the explicit property is set or if it
+   * gets set.
+   */
   public static PropertyBuilder0 builder() {
     return new PropertyBuilder0(new Builder());
   }
 
+  /**
+   * Instantiates a new staged builder. Explicit properties have precedence over
+   * additional properties, i.e. an additional property with the same name as an
+   * explicit property will be discarded if the explicit property is set or if it
+   * gets set.
+   */
   public static PropertyBuilder0 sampleObjectPojo1DtoBuilder() {
     return new PropertyBuilder0(new Builder());
   }