Kaleidoscope/doc/glossary.md

# Glossary

This document is intended to name and describe the concepts, functions and data structures inside Kaleidoscope.

It is, as yet, incredibly incomplete.

Entries should be included in dictionary order. When describing an identifier of any kind from the codebase, it should be 
written using identical capitalization to its use in the code and surrounded by backticks: `identifierName`


Event handler

: A function, usually provided by a `Plugin` that is run by a `Hook`
Major redesign of the plugin and hooking interface With this redesign, we introduce a new way to create plugins, which is easier to extend with new hook points, provides a better interface, uses less memory, less program space, and is a tiny bit faster too. It all begins with `kaleidoscope::Plugin` being the base class, which provides the hook methods plugins can implement. Plugins should be declared with `KALEIDOSCOPE_INIT_PLUGINS` instead of `Kaleidoscope.use()`. Behind this macro is a bit of magic (see the in-code documentation) that allows us to unroll the hook method calls, avoid vtables, and so on. It creates an override for `kaleidoscope::Hooks::*` methods, each of which will call the respective methods of each initialized plugin. With the new API come new names: all of the methods plugins can implement received new, more descriptive names that all follow a similar pattern. The old (dubbed V1) API still remains in place, although deprecated. One can turn it off by setting the `KALEIDOSCOPE_ENABLE_V1_PLUGIN_API` define to zero, while compiling the firmware. This work is based on #276, written by @noseglasses. @obra and @algernon did some cleaning up and applied a little naming treatment. Signed-off-by: noseglasses <shinynoseglasses@gmail.com> Signed-off-by: Jesse Vincent <jesse@keyboard.io> Signed-off-by: Gergely Nagy <algernon@keyboard.io> 7 years ago			`# Glossary`

			`This document is intended to name and describe the concepts, functions and data structures inside Kaleidoscope.`

			`It is, as yet, incredibly incomplete.`

			`Entries should be included in dictionary order. When describing an identifier of any kind from the codebase, it should be`
			written using identical capitalization to its use in the code and surrounded by backticks: `identifierName`


			`Event handler`

			: A function, usually provided by a `Plugin` that is run by a `Hook`