drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774)

Browse source 
* Remove unused UNICODE(n) macro, update docs

* Add note about max length of unicode_map to docs

* QK_UNICODE_MAP → QK_UNICODEMAP

* Refactor process_unicode_map

* process_unicode_map → process_unicodemap

This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself.

* Update references and ordering in docs/understanding_qmk

* Add additional note to docs/understanding_qmk

* &unicode_map[index] → unicode_map + index

This avoids the issue of the compiler sometimes complaining about the array index being out of range

* Update docs/getting_started_make_guide

* Update method sections in docs/feature_unicode
This commit is contained in:
Konstantin Đorđević 2019-01-07 21:56:57 +01:00 • committed by Drashna Jaelre
parent 6e984a8b5e
commit cd9262d7b2
8 changed files with 88 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/keycodes.md
View file

@ -454,7 +454,7 @@ This is a reference only. Each group of keys links to the page documenting their
## [Unicode Support](feature_unicode.md)
|Key |Aliases| |
|------------|-------|-------------------------------------------------|
|`UNICODE(n)`|`UC(n)`|Send Unicode character `n` |
|`X(n)` | |Send Unicode character `n` via a different method|
|Key |Description |
|-------|---------------------------------------------------------------------------|
|`UC(c)`|Send Unicode code point `c` (`UNICODE_ENABLE`) |
|`X(i)` |Send Unicode code point at index `i` in `unicode_map` (`UNICODEMAP_ENABLE`)|