mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-04 18:26:39 +02:00
Devdocs reorganisation (#913)
* docs: split usage and dev docs * # This is a combination of 2 commits. # This is the 1st commit message: docs: split usage and dev docs # The commit message #2 will be skipped: # fixup add docs * docs: add runner documentation and move hooks documentation to devdocs * docs: add stubs for modules technical description * docs: add paragraph about event thread-safety * docs: add 'Current modules' section header
This commit is contained in:
@@ -24,23 +24,3 @@ These configurations can be edited from the PowerToys Settings screen:
|
||||
|
||||
# Backlog
|
||||
The backlog for the utility can be found [here](https://github.com/Microsoft/PowerToys/tree/master/doc/planning/ShortcutGuideBacklog.md) and the source code is [here](https://github.com/Microsoft/PowerToys/tree/master/src/modules/shortcut_guide).
|
||||
|
||||
# Code organization
|
||||
|
||||
#### [`dllmain.cpp`](./dllmain.cpp)
|
||||
Contains DLL boilerplate code.
|
||||
|
||||
#### [`shortcut_guide.cpp`](./shortcut_guide.cpp)
|
||||
Contains the module interface code. It initializes the settings values and the keyboard event listener.
|
||||
|
||||
#### [`overlay_window.cpp`](./overlay_window.cpp)
|
||||
Contains the code for loading the SVGs, creating and rendering of the overlay window.
|
||||
|
||||
#### [`keyboard_state.cpp`](./keyboard_state.cpp)
|
||||
Contains helper methods for checking the current state of the keyboard.
|
||||
|
||||
#### [`target_state.cpp`](./target_state.cpp)
|
||||
State machine that handles the keyboard events. It’s responsible for deciding when to show the overlay, when to suppress the Start menu (if the overlay is displayed long enough), etc.
|
||||
|
||||
#### [`trace.cpp`](./trace.cpp)
|
||||
Contains code for telemetry.
|
||||
|
||||
Reference in New Issue
Block a user