summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre Le Marre <dev@wismill.eu>2023-07-19 18:50:20 +0200
committerPierre Le Marre <dev@wismill.eu>2023-07-19 18:50:20 +0200
commit7bc51781397394d8b5a0cdd46b6f3affd3f5f8af (patch)
tree217d4075c0335814a3b56ca0eb74718c5ff2b596
parent4b673589d6a8f8cf2a693210cca8ca17c43f334c (diff)
keysymdef.h: Improve doc on deprecated keysyms
The documentation on deprecated keysyms lacks precision for two cases, which are fixed by this commit: - Explicit aliases (comment: “alias for XXX”) are not deprecated. - A keysym can be explicitly deprecated by starting its comment with “deprecated”.
-rw-r--r--include/X11/keysymdef.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/include/X11/keysymdef.h b/include/X11/keysymdef.h
index 118290d..d920e5b 100644
--- a/include/X11/keysymdef.h
+++ b/include/X11/keysymdef.h
@@ -81,8 +81,15 @@ SOFTWARE.
* existing legacy keysym values in the range 0x0100 to 0x20ff.
*
* Where several mnemonic names are defined for the same keysym in this
- * file, all but the first one listed should be considered deprecated.
+ * file, all but the first one listed should be considered deprecated,
+ * unless the comment explicitly states the alias, e.g.:
+ *
+ * #define XK_dead_tilde 0xfe53
+ * #define XK_dead_perispomeni 0xfe53 // alias for dead_tilde
*
+ * Additionally, a keysym can be explicitly deprecated by starting the
+ * comment with "deprecated".
+ *
* Mnemonic names for keysyms are defined in this file with lines
* that match one of these Perl regular expressions:
*