Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(92)

Unified Diff: ppapi/api/ppb_input_event.idl

Issue 7701004: Fixed spelling errors and changed all references to PP_Resource to be the (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 9 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « ppapi/api/ppb_image_data.idl ('k') | ppapi/api/ppb_instance.idl » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ppapi/api/ppb_input_event.idl
===================================================================
--- ppapi/api/ppb_input_event.idl (revision 98665)
+++ ppapi/api/ppb_input_event.idl (working copy)
@@ -321,9 +321,10 @@
* IsInputEvent() returns true if the given resource is a valid input event
* resource.
*
- * @param[in] resource A <code>PP_Resource</code>.
+ * @param[in] resource A <code>PP_Resource</code> corresponding to a generic
+ * resource.
*
- * @return True if the given resource is a valid input event
+ * @return <code>PP_TRUE</code> if the given resource is a valid input event
* resource.
*/
PP_Bool IsInputEvent([in] PP_Resource resource);
@@ -332,7 +333,8 @@
* GetType() returns the type of input event for the given input event
* resource.
*
- * @param[in] resource A <code>PP_Resource</code> containing the input event.
+ * @param[in] resource A <code>PP_Resource</code> corresponding to an input
+ * event.
*
* @return A <code>PP_InputEvent_Type</code> if its a valid input event or
* <code>PP_INPUTEVENT_TYPE_UNDEFINED</code> if the resource is invalid.
@@ -345,7 +347,7 @@
* some overhead. Use this value to compare the times the user generated two
* events without being sensitive to variable processing time.
*
- * @param[in] resource A <code>PP_Resource</code> containing the event.
+ * @param[in] resource A <code>PP_Resource</code> corresponding to the event.
*
* @return The return value is in time ticks, which is a monotonically
* increasing clock not related to the wall clock time. It will not change
@@ -360,7 +362,8 @@
* at the time of the event. This is a combination of the flags in the
* <code>PP_InputEvent_Modifier</code> enum.
*
- * @param[in] resource A <code>PP_Resource</code> containing the input event.
+ * @param[in] resource A <code>PP_Resource</code> corresponding to an input
+ * event.
*
* @return The modifiers associated with the event, or 0 if the given
* resource is not a valid event resource.
@@ -412,7 +415,7 @@
/**
* IsMouseInputEvent() determines if a resource is a mouse event.
*
- * @param[in] resource A <code>PP_Resource</code> containing the event.
+ * @param[in] resource A <code>PP_Resource</code> corresponding to an event.
*
* @return <code>PP_TRUE</code> if the given resource is a valid mouse input
* event, otherwise <code>PP_FALSE</code>.
@@ -423,8 +426,8 @@
* GetButton() returns the mouse button that generated a mouse down or up
* event.
*
- * @param[in] mouse_event A <code>PP_Resource</code> containing the mouse
- * event.
+ * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a
+ * mouse event.
*
* @return The mouse button associated with mouse down and up events. This
* value will be <code>PP_EVENT_MOUSEBUTTON_NONE</code> for mouse move,
@@ -435,8 +438,8 @@
/**
* GetPosition() returns the pixel location of a mouse input event.
*
- * @param[in] mouse_event A <code>PP_Resource</code> containing the mouse
- * event.
+ * @param[in] mouse_event A <code>PP_Resource</code> corresponding to an
+ * mouse event.
*
* @return The point associated with the mouse event, relative to the upper-
* left of the instance receiving the event. These values can be negative for
@@ -492,7 +495,8 @@
/**
* IsWheelInputEvent() determines if a resource is a wheel event.
*
- * @param[in] wheel_event A <code>PP_Resource</code> containing the event.
+ * @param[in] wheel_event A <code>PP_Resource</code> corresponding to an
+ * event.
*
* @return <code>PP_TRUE</code> if the given resource is a valid wheel input
* event.
@@ -515,7 +519,7 @@
* possible, for example, on some trackpads and newer mice that don't have
* "clicks".
*
- * @param[in] wheel_event A <code>PP_Resource</code> containing the wheel
+ * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event.
*
* @return The vertical and horizontal scroll values. The units are either in
@@ -536,7 +540,7 @@
* want or pixel values. An example may be cycling between different items in
* a game.
*
- * @param[in] wheel_event A <code>PP_Resource</code> containing the wheel
+ * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event.
*
* @return The number of "clicks" of the scroll wheel. You may receive
@@ -553,7 +557,7 @@
* GetScrollByPage() indicates if the scroll delta x/y indicates pages or
* lines to scroll by.
*
- * @param[in] wheel_event A <code>PP_Resource</code> containing the wheel
+ * @param[in] wheel_event A <code>PP_Resource</code> corresponding to a wheel
* event.
*
* @return <code>PP_TRUE</code> if the event is a wheel event and the user is
@@ -606,7 +610,7 @@
/**
* IsKeyboardInputEvent() determines if a resource is a keyboard event.
*
- * @param[in] resource A <code>PP_Resource</code> containing the event.
+ * @param[in] resource A <code>PP_Resource</code> corresponding to an event.
*
* @return <code>PP_TRUE</code> if the given resource is a valid input event.
*/
@@ -616,8 +620,8 @@
* GetKeyCode() returns the DOM keyCode field for the keyboard event.
* Chrome populates this with the Windows-style Virtual Key code of the key.
*
- * @param[in] key_event A <code>PP_Resource</code> containing the keyboard
- * event.
+ * @param[in] key_event A <code>PP_Resource</code> corresponding to a
+ * keyboard event.
*
* @return The DOM keyCode field for the keyboard event.
*/
@@ -627,7 +631,7 @@
* GetCharacterText() returns the typed character as a UTF-8 string for the
* given character event.
*
- * @param[in] character_event A <code>PP_Resource</code> containing the
+ * @param[in] character_event A <code>PP_Resource</code> corresponding to a
* keyboard event.
*
* @return A string var representing a single typed character for character
« no previous file with comments | « ppapi/api/ppb_image_data.idl ('k') | ppapi/api/ppb_instance.idl » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698