libinput/doc/page-hierarchy.dox

/**
@page touchpads Touchpads

- @subpage scrolling
- @subpage clickpad_softbuttons
- @subpage tapping
- @subpage gestures
- @subpage touchpad_pressure
- @subpage palm_detection
- @subpage t440_support
- @subpage touchpad_jumping_cursor
- @subpage absolute_coordinate_ranges

@page touchscreens Touchscreens

- @subpage absolute_axes

@page pointers Mice, Trackballs, etc.

- @subpage motion_normalization
- @subpage middle_button_emulation
- @subpage button_debouncing

@page tablets Graphics Tablets

- @subpage tablet-support

@page general General 

- @subpage udev_config
- @subpage seats
- @subpage timestamps

@page misc Users

- @subpage what_is_libinput
- @subpage faq
- @subpage tools
- @subpage reporting_bugs

@page developers Developers

Contributions to libinput are always welcome. See the links below for
specific documentation.

- @subpage what_is_libinput
- @subpage contributing
- @subpage building_libinput
- @subpage test-suite
- @subpage tools
- @subpage pointer-acceleration

*/
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00			`/**`
			`@page touchpads Touchpads`

			`- @subpage scrolling`
			`- @subpage clickpad_softbuttons`
			`- @subpage tapping`
			`- @subpage gestures`
doc: add documentation for touchpad pressure detection Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2017-04-19 14:11:45 +10:00			`- @subpage touchpad_pressure`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00			`- @subpage palm_detection`
			`- @subpage t440_support`
touchpad: detect and warn about kernel tracking pointer jumps If a touch moves by more than 20mm within a single frame, reset the motion history, effectively discarding the movement. This is a relatively common bug and almost always needs a kernel fix, so add an explanatory page to the docs. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Benjamin Tissoires <benjamin.tissoires@gmail.com> Reviewed-by: Hans de Goede <hdegoede@redhat.com> 2014-09-16 15:13:00 +10:00			`- @subpage touchpad_jumping_cursor`
touchpad: warn if we have invalid touchpad ranges Quite a few bugs are caused by touchpad ranges being out of whack. If we get input events significantly outside the expected range (5% width/height as error margin) print a warning to the log. And add a new doc page to explain what is happening and how to fix it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Hans de Goede <hdegoede@redhat.com> 2016-05-31 14:52:57 +10:00			`- @subpage absolute_coordinate_ranges`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00
			`@page touchscreens Touchscreens`

			`- @subpage absolute_axes`

			`@page pointers Mice, Trackballs, etc.`

			`- @subpage motion_normalization`
doc: split middle button emulation into a separate page Easier to link to from bug reports Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2016-08-15 07:59:29 +10:00			`- @subpage middle_button_emulation`
pointer: add button debouncing Some devices have worn-out switches or just cheap switches that trigger multiple button events for each press. These can be identified by unfeasably short time deltas between the release and the next press event. In the recordings I've seen so far, that timeout is 8ms. We have a two-stage behavior: by default, we do not delay any events but we monitor timestamps. The first time a bouncing button is detected we switch to debounce mode. From then on, release events are delayed slightly to check for subsequent button events. If one occurs, the releas and press are filtered. If none occurs, the release event is passed to the caller. https://bugs.freedesktop.org/show_bug.cgi?id=100057 Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2017-07-14 13:42:53 +10:00			`- @subpage button_debouncing`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00
doc: add the tablet support page to the related pages hierarchy Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2016-02-02 13:52:54 +10:00			`@page tablets Graphics Tablets`

			`- @subpage tablet-support`

doc: document the event timestamps Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2017-05-01 19:58:13 +10:00			`@page general General`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00
			`- @subpage udev_config`
			`- @subpage seats`
doc: document the event timestamps Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2017-05-01 19:58:13 +10:00			`- @subpage timestamps`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00
			`@page misc Users`

doc: add a page "what is libinput" This will eventually feature the architecture diagrams, etc. But for now it's mostly just a list of what will be and what won't be supported. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2017-01-31 09:45:44 +10:00			`- @subpage what_is_libinput`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00			`- @subpage faq`
doc: add a page about the available tools Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:56:55 +10:00			`- @subpage tools`
doc: add a page on how to report bugs Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-30 11:11:12 +10:00			`- @subpage reporting_bugs`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00
			`@page developers Developers`

doc: add a small page about contributing to libinput To be expanded at some future time... Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2016-10-14 14:22:14 +10:00			`Contributions to libinput are always welcome. See the links below for`
			`specific documentation.`

doc: add a page "what is libinput" This will eventually feature the architecture diagrams, etc. But for now it's mostly just a list of what will be and what won't be supported. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2017-01-31 09:45:44 +10:00			`- @subpage what_is_libinput`
doc: add a small page about contributing to libinput To be expanded at some future time... Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2016-10-14 14:22:14 +10:00			`- @subpage contributing`
doc: add build instructions Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2016-08-09 10:25:22 +10:00			`- @subpage building_libinput`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00			`- @subpage test-suite`
doc: add a page about the available tools Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:56:55 +10:00			`- @subpage tools`
doc: add pointer acceleration documentation Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Jonas Ådahl <jadahl@gmail.com> 2015-07-29 15:05:52 +10:00			`- @subpage pointer-acceleration`
doc: group the "related pages" by general topic Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> 2015-07-16 10:31:34 +10:00
			`*/`