Clarify that IGNORE_DIACRITICS_CTL is not only CTL, despite its name

Change-Id: I5954094131debb7cdf0fc44a9db3a3609b356baf

1 files changed, 10 insertions, 1 deletions

diff --git a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl
index be82cf74821a..5a67714ba640 100644
--- a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl
+++ b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl
@@ -50,8 +50,17 @@ constants TransliterationModulesExtra
      */
     const short TOGGLE_CASE = 202;
 
-    /// because we cannot extend TransliterationModule we used TranslationModuleExtra and it will act the same way
+    /** Ignore diacritics. Despite the _CTL name suffix this is not only
+        about CTL/Arabic diacritic characters, though these are handled
+        as well, but the transliteration decomposes and removes any
+        diacritic from characters.
+
+        Because we cannot extend the TransliterationModules enum we use
+        TranslationModuleExtra and it will act the same way.
+     */
     const long IGNORE_DIACRITICS_CTL   = 0x40000000;
+
+    /** Ignore Kashida mark. */
     const long IGNORE_KASHIDA_CTL      = 0x00000800;
 
     const long END_OF_MODULE    = 0;