From 20b5df20d05ca225074de1a572f2bba9b40425da Mon Sep 17 00:00:00 2001
From: Walter Oggioni <oggioni.walter@gmail.com>
Date: Thu, 17 Jun 2021 08:24:39 +0100
Subject: [PATCH] improved javadoc

---
 src/main/java/net/woggioni/jwo/JWO.java | 4 ++++
 1 file changed, 4 insertions(+)

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. <br>
+     * If any of the variable names is not contained in the map it will be replaced by an empty string. <br>
+     * Example: <br>
+     * "This template was created by John Doe."
      */
     @SneakyThrows
     public static String renderTemplate(Reader reader, Map<String, Object> valuesMap) {