From 959b7e924caf6fcfb7e25aedb89d1a8327ba3b4b Mon Sep 17 00:00:00 2001
From: Markus Kreth <markus.kreth@web.de>
Date: Thu, 8 Dec 2022 22:08:05 +0100
Subject: [PATCH] added some comments to generation templates.

---
 .classpath                                    | 38 -------------------
 .gitignore                                    |  6 ++-
 src/main/resources/template/enum_template.tpl |  2 +
 .../enum_template_with_initializer.tpl        |  5 ++-
 ...late_with_inner_propertyresourcebundle.tpl |  2 +
 5 files changed, 12 insertions(+), 41 deletions(-)
 delete mode 100644 .classpath

diff --git a/.classpath b/.classpath
deleted file mode 100644
index 74ff893..0000000
--- a/.classpath
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<classpath>
-	<classpathentry kind="src" output="target/classes" path="src/main/java">
-		<attributes>
-			<attribute name="optional" value="true"/>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
-	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
-		<attributes>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
-		<attributes>
-			<attribute name="test" value="true"/>
-			<attribute name="maven.pomderived" value="true"/>
-			<attribute name="optional" value="true"/>
-		</attributes>
-	</classpathentry>
-	<classpathentry exported="true" kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
-		<attributes>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11">
-		<attributes>
-			<attribute name="maven.pomderived" value="true"/>
-		</attributes>
-	</classpathentry>
-	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
-		<attributes>
-			<attribute name="maven.pomderived" value="true"/>
-			<attribute name="test" value="true"/>
-		</attributes>
-	</classpathentry>
-	<classpathentry kind="output" path="target/classes"/>
-</classpath>
diff --git a/.gitignore b/.gitignore
index 8070aba..f1f6662 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,5 @@
-
-\.settings/
+.classpath
+.project
+.factorypath
+.settings
 target
diff --git a/src/main/resources/template/enum_template.tpl b/src/main/resources/template/enum_template.tpl
index 9ee662d..643dd3c 100644
--- a/src/main/resources/template/enum_template.tpl
+++ b/src/main/resources/template/enum_template.tpl
@@ -8,6 +8,8 @@ import javax.annotation.processing.Generated;
 
 /**
  * Property keys from ${fileName}
+ * {@link #getValue()} gives the key for the entry, with {@link #getString(UnaryOperator<String>)}
+ * the value is given directly.
  */
 @Generated(date = "${generation_date}", value = "${generator_name}")
 public enum ${classname} {
diff --git a/src/main/resources/template/enum_template_with_initializer.tpl b/src/main/resources/template/enum_template_with_initializer.tpl
index ab44e1b..6101d32 100644
--- a/src/main/resources/template/enum_template_with_initializer.tpl
+++ b/src/main/resources/template/enum_template_with_initializer.tpl
@@ -8,6 +8,8 @@ import javax.annotation.processing.Generated;
 
 /**
  * Property keys from ${fileName}
+ * {@link #getValue()} gives the key for the entry, with {@link #getText()} the value for the key is given directly.
+ * This enum needs to be initialized before any use by {@link #init(UnaryOperator)}.
  */
 @Generated(date = "${generation_date}", value = "${generator_name}")
 public enum ${classname} {
@@ -19,7 +21,8 @@ public enum ${classname} {
 	${e.constant} ("${e.key}")<#sep>,
 </#sep>
 </#list>;
-    private static UnaryOperator<String> function;
+
+	private static UnaryOperator<String> function;
 	private final String value;
 
 	private ${classname} (String value) {
diff --git a/src/main/resources/template/enum_template_with_inner_propertyresourcebundle.tpl b/src/main/resources/template/enum_template_with_inner_propertyresourcebundle.tpl
index d3955af..0ddfc7d 100644
--- a/src/main/resources/template/enum_template_with_inner_propertyresourcebundle.tpl
+++ b/src/main/resources/template/enum_template_with_inner_propertyresourcebundle.tpl
@@ -9,6 +9,8 @@ import javax.annotation.processing.Generated;
 
 /**
  * Property keys from ${fileName}
+ * {@link #getValue()} gives the key for the entry, with {@link #getText()} the value for the key is given directly.
+ * Initializationis generated also.
  */
 @Generated(date = "${generation_date}", value = "${generator_name}")
 public enum ${classname} {