diff options
| author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2020-03-15 20:29:11 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-15 20:29:11 -0700 |
| commit | b272c035ba7fa8555a88c922b3e94c3f3817c4ff (patch) | |
| tree | a5c9a1f6e4a1d9c02b72a12e33b2f9e69b5bf85b /docs/feature_pointing_device.md | |
| parent | 5f1f370463d818a5283a17001ad832073efc45a4 (diff) | |
| download | qmk_firmware-b272c035ba7fa8555a88c922b3e94c3f3817c4ff.tar.gz qmk_firmware-b272c035ba7fa8555a88c922b3e94c3f3817c4ff.zip | |
[Docs] Random Fixes (#8340)
* fix CLI section links in the Summary
* fix heading in Pointing Device doc
* fix headings in PS/2 Mouse Support doc
* add explicit section ids to I2C Master Driver doc
* reformat GPIO Controls table
Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.)
Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function.
* migrate changes from I2C Master Driver doc to Japanese translation
* add explicit anchors to I2C Master Driver docs
* fix code block language markers
The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work.
Good: ```c
Bad: ```C
* restore Japanese I2C Master Driver doc to current master
Can't update the internal tracking references accurately until the changes to the English doc are committed to master.
* add explicit anchors to edited files
* change ChibiOS/ARM to ARM/ChibiOS
Because ARM/ATSAM is also a thing that exists.
* fix code block language markers again
Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase.
* add section anchors to cli.md
* restore table formatting on GPIO Control doc
* remove changes to _summary.md
Diffstat (limited to 'docs/feature_pointing_device.md')
| -rw-r--r-- | docs/feature_pointing_device.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md index 8ad428939..b90c341d5 100644 --- a/docs/feature_pointing_device.md +++ b/docs/feature_pointing_device.md | |||
| @@ -1,10 +1,10 @@ | |||
| 1 | ## Pointing Device | 1 | # Pointing Device :id=pointing-device |
| 2 | 2 | ||
| 3 | Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around. There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and lightweight. You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you. | 3 | Pointing Device is a generic name for a feature intended to be generic: moving the system pointer around. There are certainly other options for it - like mousekeys - but this aims to be easily modifiable and lightweight. You can implement custom keys to control functionality, or you can gather information from other peripherals and insert it directly here - let QMK handle the processing for you. |
| 4 | 4 | ||
| 5 | To enable Pointing Device, uncomment the following line in your rules.mk: | 5 | To enable Pointing Device, uncomment the following line in your rules.mk: |
| 6 | 6 | ||
| 7 | ``` | 7 | ```makefile |
| 8 | POINTING_DEVICE_ENABLE = yes | 8 | POINTING_DEVICE_ENABLE = yes |
| 9 | ``` | 9 | ``` |
| 10 | 10 | ||
| @@ -25,7 +25,7 @@ When the mouse report is sent, the x, y, v, and h values are set to 0 (this is d | |||
| 25 | 25 | ||
| 26 | In the following example, a custom key is used to click the mouse and scroll 127 units vertically and horizontally, then undo all of that when released - because that's a totally useful function. Listen, this is an example: | 26 | In the following example, a custom key is used to click the mouse and scroll 127 units vertically and horizontally, then undo all of that when released - because that's a totally useful function. Listen, this is an example: |
| 27 | 27 | ||
| 28 | ``` | 28 | ```c |
| 29 | case MS_SPECIAL: | 29 | case MS_SPECIAL: |
| 30 | report_mouse_t currentReport = pointing_device_get_report(); | 30 | report_mouse_t currentReport = pointing_device_get_report(); |
| 31 | if (record->event.pressed) | 31 | if (record->event.pressed) |
