diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/features/community_modules.md | 33 |
1 files changed, 21 insertions, 12 deletions
diff --git a/docs/features/community_modules.md b/docs/features/community_modules.md index 52526c9fe8..69fc47f617 100644 --- a/docs/features/community_modules.md +++ b/docs/features/community_modules.md | |||
| @@ -127,18 +127,27 @@ Introspection is a relatively advanced topic within QMK, and existing patterns s | |||
| 127 | 127 | ||
| 128 | Community Modules may provide specializations for the following APIs: | 128 | Community Modules may provide specializations for the following APIs: |
| 129 | 129 | ||
| 130 | | Base API | API Format | Example (`hello_world` module) | API Version | | 130 | | Base API | API Format | Example (`hello_world` module) | API Version | |
| 131 | |----------------------------|-------------------------------------|----------------------------------------|-------------| | 131 | |----------------------------------|-------------------------------------------|---------------------------------------------|-------------| |
| 132 | | `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` | | 132 | | `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` | |
| 133 | | `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` | | 133 | | `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` | |
| 134 | | `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` | | 134 | | `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` | |
| 135 | | `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` | | 135 | | `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` | |
| 136 | | `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` | | 136 | | `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` | |
| 137 | | `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` | | 137 | | `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` | |
| 138 | | `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` | | 138 | | `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` | |
| 139 | | `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` | | 139 | | `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` | |
| 140 | | `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` | | 140 | | `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` | |
| 141 | | `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` | | 141 | | `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` | |
| 142 | | `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` | | ||
| 143 | | `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` | | ||
| 144 | | `led_matrix_indicators` | `led_matrix_indicators_<module>` | `led_matrix_indicators_hello_word` | `1.1.0` | | ||
| 145 | | `led_matrix_indicators_advanced` | `led_matrix_indicators_advanced_<module>` | `led_matrix_indicators_advanced_hello_word` | `1.1.0` | | ||
| 146 | | `rgb_matrix_indicators` | `rgb_matrix_indicators_<module>` | `rgb_matrix_indicators_hello_word` | `1.1.0` | | ||
| 147 | | `rgb_matrix_indicators_advanced` | `rgb_matrix_indicators_advanced_<module>` | `rgb_matrix_indicators_advanced_hello_word` | `1.1.0` | | ||
| 148 | | `pointing_device_init` | `pointing_device_init_<module>` | `pointing_device_init_hello_word` | `1.1.0` | | ||
| 149 | | `pointing_device_task` | `pointing_device_task_<module>` | `pointing_device_task_hello_word` | `1.1.0` | | ||
| 150 | |||
| 142 | 151 | ||
| 143 | ::: info | 152 | ::: info |
| 144 | An unspecified API is disregarded if a Community Module does not provide a specialization for it. | 153 | An unspecified API is disregarded if a Community Module does not provide a specialization for it. |
