Formatting changes

Fixes to some of the C documentation in the IDL.
Review URL: http://codereview.chromium.org/7308010

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@96561 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 22 insertions, 5 deletions

diff --git a/ppapi/api/pp_input_event.idl b/ppapi/api/pp_input_event.idl
index 7e43b8f..1afcac7 100644
--- a/ppapi/api/pp_input_event.idl
+++ b/ppapi/api/pp_input_event.idl
@@ -128,10 +128,9 @@ struct PP_InputEvent_Mouse {
   uint32_t modifier;
 
   /**
-   * Indicates the amount vertically and horizontally the user has requested
-   * to scroll by with their mouse wheel. A scroll down or to the right (where
-   * the content moves up or left) is represented as positive values, and
-   * a scroll up or to the left (where the content moves down or right) is
+   * The mouse wheel's horizontal scroll amount. A scroll to the right
+   * (where the content moves left) is represented as positive values,
+   * and a scroll to the left (where the content moves right) is
    * represented as negative values.
    *
    * The units are either in pixels (when scroll_by_page is false) or pages
@@ -150,7 +149,25 @@ struct PP_InputEvent_Mouse {
    */
   float_t delta_x;
 
-  /** This value represents */
+  /**
+   * The mouse wheel's vertical scroll amount. A scroll down (where the
+   * content moves up) is represented as positive values, and a scroll up
+   * (where the content moves down) is represented as negative values.
+   *
+   * The units are either in pixels (when scroll_by_page is false) or pages
+   * (when scroll_by_page is true). For example, delta_y = -3 means scroll up 3
+   * pixels when scroll_by_page is false, and scroll up 3 pages when
+   * scroll_by_page is true.
+   *
+   * This amount is system dependent and will take into account the user's
+   * preferred scroll sensitivity and potentially also nonlinear acceleration
+   * based on the speed of the scrolling.
+   *
+   * Devices will be of varying resolution. Some mice with large detents will
+   * only generate integer scroll amounts. But fractional values are also
+   * possible, for example, on some trackpads and newer mice that don't have
+   * "clicks".
+   */
   float_t delta_y;
 
   /**