From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Mon, 22 Dec 2014 00:08:13 +0000 (+1000)
Subject: doc: move relative motion normalization page over to doc/
X-Git-Tag: 0.8.0~49
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5c63a739708e48890aa931eaa55591ab08f96a82;p=platform%2Fupstream%2Flibinput.git

doc: move relative motion normalization page over to doc/

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 30f60895..3feeb07d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -9,6 +9,7 @@ header_files = \
 	$(top_srcdir)/README.txt \
 	$(srcdir)/absolute-axes.dox \
 	$(srcdir)/clickpad-softbuttons.dox \
+	$(srcdir)/normalization-of-relative-motion.dox \
 	$(srcdir)/seats.dox \
 	$(srcdir)/t440-support.dox
 
diff --git a/doc/normalization-of-relative-motion.dox b/doc/normalization-of-relative-motion.dox
new file mode 100644
index 00000000..ce266e3e
--- /dev/null
+++ b/doc/normalization-of-relative-motion.dox
@@ -0,0 +1,52 @@
+/**
+@page motion_normalization Normalization of relative motion
+
+Most relative input devices generate input in so-called "mickeys". A
+mickey is in device-specific units that depend on the resolution
+of the sensor. Most optical mice use sensors with 1000dpi resolution, but
+some devices range from 100dpi to well above 8000dpi.
+
+Without a physical reference point, a relative coordinate cannot be
+interpreted correctly. A delta of 10 mickeys may be a millimeter of
+physical movement or 10 millimeters, depending on the sensor. This
+affects pointer acceleration in libinput and interpretation of relative
+coordinates in callers.
+
+libinput normalizes all relative input to a physical resolution of
+1000dpi, the same delta from two different devices thus represents the
+same physical movement of those two devices (within sensor error
+margins).
+
+Devices usually do not advertise their resolution and libinput relies on
+the udev property MOUSE_DPI for this information.
+
+The format of the property for single-resolution mice is:
+@code
+     MOUSE_DPI=resolution@frequency
+@endcode
+
+The resolution is in dots per inch, the frequency in Hz.
+The format of the property for multi-resolution mice may list multiple
+resolutions and frequencies:
+@code
+     MOUSE_DPI=r1@f1 *r2@f2 r3@f3
+@endcode
+
+The default frequency must be pre-fixed with an asterisk.
+
+For example, these two properties are valid:
+@code
+     MOUSE_DPI=800@125
+     MOUSE_DPI=400@125 800@125 *1000@500 5500@500
+@endcode
+
+The behavior for a malformed property is undefined.
+
+If the property is unset, libinput assumes the resolution is 1000dpi.
+
+Note that HW does not usually provide information about run-time
+resolution changes, libinput will thus not detect when a resolution
+changes to the non-default value.
+
+*/
+
diff --git a/src/libinput.h b/src/libinput.h
index d62516d1..4adf2177 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -132,57 +132,6 @@ extern "C" {
  *
  */
 
-/**
- * @page motion_normalization Normalization of relative motion
- *
- * Most relative input devices generate input in so-called "mickeys". A
- * mickey is in device-specific units that depend on the resolution
- * of the sensor. Most optical mice use sensors with 1000dpi resolution, but
- * some devices range from 100dpi to well above 8000dpi.
- *
- * Without a physical reference point, a relative coordinate cannot be
- * interpreted correctly. A delta of 10 mickeys may be a millimeter of
- * physical movement or 10 millimeters, depending on the sensor. This
- * affects pointer acceleration in libinput and interpretation of relative
- * coordinates in callers.
- *
- * libinput normalizes all relative input to a physical resolution of
- * 1000dpi, the same delta from two different devices thus represents the
- * same physical movement of those two devices (within sensor error
- * margins).
- *
- * Devices usually do not advertise their resolution and libinput relies on
- * the udev property MOUSE_DPI for this information.
- *
- * The format of the property for single-resolution mice is:
- * @code
- *      MOUSE_DPI=resolution@frequency
- * @endcode
- *
- * The resolution is in dots per inch, the frequency in Hz.
- * The format of the property for multi-resolution mice may list multiple
- * resolutions and frequencies:
- * @code
- *      MOUSE_DPI=r1@f1 *r2@f2 r3@f3
- * @endcode
- *
- * The default frequency must be pre-fixed with an asterisk.
- *
- * For example, these two properties are valid:
- * @code
- *      MOUSE_DPI=800@125
- *      MOUSE_DPI=400@125 800@125 *1000@500 5500@500
- * @endcode
- *
- * The behavior for a malformed property is undefined.
- *
- * If the property is unset, libinput assumes the resolution is 1000dpi.
- *
- * Note that HW does not usually provide information about run-time
- * resolution changes, libinput will thus not detect when a resolution
- * changes to the non-default value.
- */
-
 /**
  * Log priority for internal logging messages.
  */