From d480a6321f0888effdfd73b8c341f94b35923800 Mon Sep 17 00:00:00 2001
From: Helium314 <helium314@mailbox.org>
Date: Fri, 11 Aug 2023 09:03:16 +0200
Subject: [PATCH] add comments

---
 .../inputmethod/latin/DictionaryFacilitatorImpl.java        | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/app/src/main/java/org/dslul/openboard/inputmethod/latin/DictionaryFacilitatorImpl.java b/app/src/main/java/org/dslul/openboard/inputmethod/latin/DictionaryFacilitatorImpl.java
index 5280ac35..c3a1ea3b 100644
--- a/app/src/main/java/org/dslul/openboard/inputmethod/latin/DictionaryFacilitatorImpl.java
+++ b/app/src/main/java/org/dslul/openboard/inputmethod/latin/DictionaryFacilitatorImpl.java
@@ -110,6 +110,7 @@ public class DictionaryFacilitatorImpl implements DictionaryFacilitator {
         mValidSpellingWordWriteCache = cache;
     }
 
+    // judging by usage, this should check primary locale only
     @Override
     public boolean isForLocale(final Locale locale) {
         return locale != null && locale.equals(mDictionaryGroups.get(0).mLocale);
@@ -290,6 +291,11 @@ public class DictionaryFacilitatorImpl implements DictionaryFacilitator {
         return mDictionaryGroups.get(0).mLocale != null;
     }
 
+    // used in
+    //  putWordIntoValidSpellingWordCache -> should probably return most confidence locale, but the cache is not used anyway
+    //  LatinIME.resetSuggestMainDict -> should return primary locale
+    //  Suggest.getSuggestedWordsFor... -> should not matter if suggestions have a word locale, todo: check whether they do!
+    //  InputLogic.getDictionaryFacilitatorLocale -> not sure, but probably doesn't matter
     @Override
     public Locale getLocale() {
         return mDictionaryGroups.get(0).mLocale;