Fix bug 3904

[lyx.git] / src / support / lstrings.h

diff --git a/src/support/lstrings.h b/src/support/lstrings.h
index 9c9dbf4d7396881fe7eb71c289aaf805256ae246..7a0cbd5b5f16df85954765b7bde4250cc0f6619b 100644 (file)
--- a/src/support/lstrings.h
+++ b/src/support/lstrings.h
@@ -72,12 +72,22 @@ int hexToInt(lyx::docstring const & str);
 /// is \p str pure ascii?
 bool isAscii(docstring const & str);
 
-/// Changes the case of \p c to lowercase.
-/// Caution: Depends on the locale
+/**
+ * Changes the case of \p c to lowercase.
+ * Don't use this for non-ASCII characters, since it depends on the locale.
+ * This overloaded function is only implemented because the char_type variant
+ * would be used otherwise, and we assert in this function that \p c is in
+ * the ASCII range.
+ */
 char lowercase(char c);
 
-/// Changes the case of \p c to uppercase.
-/// Caution: Depends on the locale
+/**
+ * Changes the case of \p c to uppercase.
+ * Don't use this for non-ASCII characters, since it depends on the locale.
+ * This overloaded function is only implemented because the char_type variant
+ * would be used otherwise, and we assert in this function that \p c is in
+ * the ASCII range.
+ */
 char uppercase(char c);
 
 /// Changes the case of \p c to lowercase.