elput: Document how keyboard events are processed
authorBryce Harrington <bryce@osg.samsung.com>
Fri, 9 Jun 2017 18:35:51 +0000 (14:35 -0400)
committerMike Blumenkrantz <zmike@osg.samsung.com>
Fri, 9 Jun 2017 18:35:51 +0000 (14:35 -0400)
commit6a5695b465fe7496e0ee10d9a473053d76180c54
tree486fed3b3f6ee3cbccb8bb1efe38ee5dd40b0453
parentca66a9fa0de567086fc2c1405ca1980357a88db1
elput: Document how keyboard events are processed

Summary:
Add some light function docs and code comments to explain the steps
followed in processing hardware events for keyboard hits into actual
printable characters.  While this is internal functionality, the process
is important and involves a couple external dependencies (libinput and
libxkbcommon) so documenting this flow may help future developers avoid
introducing bugs.

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
Reviewers: zmike

Subscribers: cedric, jpeg

Differential Revision: https://phab.enlightenment.org/D4953
src/lib/elput/elput_evdev.c