From 1f1535ac1033ab98e7b9ae4fc8a125660c977d99 Mon Sep 17 00:00:00 2001
From: JFronny <git@akbvopenfl1.hopto.org>
Date: Fri, 28 Jan 2022 15:49:45 +0100
Subject: [PATCH] Document libjf-translate-v0

---
 docs/libjf-translate-v0.md                             |  6 ++++++
 .../io/gitlab/jfronny/libjf/translate/Language.java    | 10 +++++-----
 .../jfronny/libjf/translate/TranslateService.java      |  4 ++--
 mkdocs.yml                                             |  1 +
 4 files changed, 14 insertions(+), 7 deletions(-)
 create mode 100644 docs/libjf-translate-v0.md

diff --git a/docs/libjf-translate-v0.md b/docs/libjf-translate-v0.md
new file mode 100644
index 0000000..0c4829e
--- /dev/null
+++ b/docs/libjf-translate-v0.md
@@ -0,0 +1,6 @@
+# libjf-translate-v0
+libjf-translate-v0 provides a util class for translating strings through Google Translate.
+
+To translate a string, just call `TranslateService.translate("Text to translate", Language.AUTO_DETECT, Language.ENGLISH)`
+
+To obtain allow configuring languages, you may use the `Language` enum itself or `Language.byId("en")`
\ No newline at end of file
diff --git a/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/Language.java b/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/Language.java
index 5b6164a..d8e00b9 100644
--- a/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/Language.java
+++ b/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/Language.java
@@ -16,20 +16,20 @@ public enum Language {
 
     static {
         for (Language language : Language.values()) {
-            LANGUAGE_BY_VALUE.put(language.value, language);
+            LANGUAGE_BY_VALUE.put(language.id, language);
         }
     }
 
-    public static Language byValue(String value) {
+    public static Language byId(String value) {
         return LANGUAGE_BY_VALUE.getOrDefault(value, AUTO_DETECT);
     }
 
     public final String name;
-    public final String value;
+    public final String id;
 
-    Language(String name, String value) {
+    Language(String name, String id) {
         this.name = name;
-        this.value = value;
+        this.id = id;
     }
 
     @Override
diff --git a/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/TranslateService.java b/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/TranslateService.java
index 2978711..ae94e1c 100644
--- a/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/TranslateService.java
+++ b/libjf-translate-v0/src/main/java/io/gitlab/jfronny/libjf/translate/TranslateService.java
@@ -21,12 +21,12 @@ public class TranslateService {
         if (textToTranslate == null) throw new TranslateException("textToTranslate must not be null");
         String pageSource = "";
         try {
-            pageSource = getPageSource(textToTranslate, translateFrom.value, translateTo.value);
+            pageSource = getPageSource(textToTranslate, translateFrom.id, translateTo.id);
             Matcher matcher = TRANSLATION_RESULT.matcher(pageSource);
             if (matcher.find()) {
                 String match = matcher.group(1);
                 if (match != null && !match.isEmpty()) {
-                    return StringEscapeUtils.unescapeHtml4(match);
+                    return StringEscapeUtils.unescapeHtml4(match); //TODO use commons-text once that is shipped with Minecraft
                 }
             }
             throw new TranslateException("Could not translate \"" + textToTranslate + "\": result page couldn't be parsed");
diff --git a/mkdocs.yml b/mkdocs.yml
index 6cf2a62..da52510 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -14,5 +14,6 @@ nav:
       - 'libjf-devutil-v0.md'
       - 'libjf-data-v0.md'
       - 'libjf-data-manipulation-v0.md'
+      - 'libjf-translate-v0.md'
       - 'libjf-unsafe-v0.md'
       - 'libjf-web-v0.md'