diff --git a/src/main/java/net/woggioni/jwo/JWO.java b/src/main/java/net/woggioni/jwo/JWO.java index 8316e0c..dbcd305 100644 --- a/src/main/java/net/woggioni/jwo/JWO.java +++ b/src/main/java/net/woggioni/jwo/JWO.java @@ -295,6 +295,10 @@ public class JWO { * @param reader the reader reading the template text * @param valuesMap a map containing the values to replace in the template * {@link #renderTemplate(String, Map)} + * @return The template text (String) with the variable names replaced by the values passed in the map.
+ * If any of the variable names is not contained in the map it will be replaced by an empty string.
+ * Example:
+ * "This template was created by John Doe." */ @SneakyThrows public static String renderTemplate(Reader reader, Map valuesMap) {