docs(plugin): better doc helper documentation

Author: fugerit79

fj-doc-maven-plugin/src/main/resources/config/template/flavour/flavour-macro.ftl

@@ -81,4 +81,32 @@
     <@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
 </#macro>
 
-<#macro createSpringBootPath context outputMime outputExtension outputDescription><@createSpringBootPathPrefix context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription pathPrefix=''/></#macro>
+<#macro createSpringBootPath context outputMime outputExtension outputDescription><@createSpringBootPathPrefix context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription pathPrefix=''/></#macro>
+
+<#macro docProcessConfigDocHelperComment context>
+   /*
+    * FreemarkerDocProcessConfig is thread-safe and should be initialized once for each config file.
+    *
+    * Consider using a @ApplicationScoped or Singleton approach.
+    */
+</#macro>
+
+<#macro getDocProcessConfigDocHelperComment context>
+   /**
+    * Accessor for FreemarkerDocProcessConfig configuration.
+    *
+    * @return the FreemarkerDocProcessConfig instance associated with this helper.
+    */
+</#macro>
+
+<#macro docHelperBody context>
+public class DocHelper {
+
+    <@docProcessConfigDocHelperComment context=context/>
+    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://${context.resourcePathFmConfigXml}" );
+
+    <@getDocProcessConfigDocHelperComment context=context/>
+    public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
+
+}
+</#macro>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3-gradle-kts/DocHelper.ftl

@@ -6,10 +6,4 @@ import org.fugerit.java.doc.freemarker.process.FreemarkerDocProcessConfigFacade;
 import jakarta.enterprise.context.ApplicationScoped;
 
 @ApplicationScoped
-public class DocHelper {
-
-    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://${context.resourcePathFmConfigXml}" );
-
-    public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
-
-}
+<@fhm.docHelperBody context=context/>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3-gradle/DocHelper.ftl

@@ -6,10 +6,4 @@ import org.fugerit.java.doc.freemarker.process.FreemarkerDocProcessConfigFacade;
 import jakarta.enterprise.context.ApplicationScoped;
 
 @ApplicationScoped
-public class DocHelper {
-
-    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://${context.resourcePathFmConfigXml}" );
-
-    public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
-
-}
+<@fhm.docHelperBody context=context/>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3-properties/DocHelper.ftl

@@ -6,10 +6,4 @@ import org.fugerit.java.doc.freemarker.process.FreemarkerDocProcessConfigFacade;
 import jakarta.enterprise.context.ApplicationScoped;
 
 @ApplicationScoped
-public class DocHelper {
-
-    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://${context.resourcePathFmConfigXml}" );
-
-    public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
-
-}
+<@fhm.docHelperBody context=context/>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3/DocHelper.ftl

@@ -6,10 +6,4 @@ import org.fugerit.java.doc.freemarker.process.FreemarkerDocProcessConfigFacade;
 import jakarta.enterprise.context.ApplicationScoped;
 
 @ApplicationScoped
-public class DocHelper {
-
-    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://${context.resourcePathFmConfigXml}" );
-
-    public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
-
-}
+<@fhm.docHelperBody context=context/>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/DocHelper.ftl

@@ -6,10 +6,4 @@ import org.fugerit.java.doc.freemarker.process.FreemarkerDocProcessConfigFacade;
 import org.springframework.stereotype.Component;
 
 @Component
-public class DocHelper {
-
-    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://${context.resourcePathFmConfigXml}" );
-
-    public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
-
-}
+<@fhm.docHelperBody context=context/>