New documentation for ppb_input_event.h

New documentation for ppb_input_event.h
Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=96988

[dmichael (off chromium), 2011-08-16 15:46:00]

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl
File ppapi/api/ppb_input_event.idl (right):

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:333: * resource. This is valid for all input
events.
The last sentence doesn't really help anymore, please delete it.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:372: * The <code>PPB_InputEvent</code> interface
contains pointers to several
PPB_InputEvent->PPB_MouseInputEvent

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:400: * position of the mouse when the eent
occurred.
eent->event

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:484: * @return A <code>PP_Resource</code>
containing the new wheel input event.
You have an extra @return line

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:496: * @param[in] wheel_event A
<code>PP_Resource</code> containing the wheel
I would delete 'wheel' from here; you can pass any kind of event, and the
function tells you whether it is a wheel event.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:611: * @param[in] resource A
<code>PP_Resource</code> containing the keyboard
I would remove 'keyboard' from here.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:620: * GetKeyCode returns the DOM keyCode field
for the keyboard event.
GetKeyCode()
(missing parens)

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:632: * event.
maybe add ' as a UTF-8 string.'

[jond, 2011-08-16 15:53:23]

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl
File ppapi/api/ppb_input_event.idl (right):

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:333: * resource. This is valid for all input
events.
On 2011/08/16 15:46:00, dmichael wrote:
> The last sentence doesn't really help anymore, please delete it.

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:372: * The <code>PPB_InputEvent</code> interface
contains pointers to several
On 2011/08/16 15:46:00, dmichael wrote:
> PPB_InputEvent->PPB_MouseInputEvent

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:372: * The <code>PPB_InputEvent</code> interface
contains pointers to several
On 2011/08/16 15:46:00, dmichael wrote:
> PPB_InputEvent->PPB_MouseInputEvent

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:400: * position of the mouse when the eent
occurred.
On 2011/08/16 15:46:00, dmichael wrote:
> eent->event

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:484: * @return A <code>PP_Resource</code>
containing the new wheel input event.
On 2011/08/16 15:46:00, dmichael wrote:
> You have an extra @return line

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:496: * @param[in] wheel_event A
<code>PP_Resource</code> containing the wheel
On 2011/08/16 15:46:00, dmichael wrote:
> I would delete 'wheel' from here; you can pass any kind of event, and the
> function tells you whether it is a wheel event.

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:611: * @param[in] resource A
<code>PP_Resource</code> containing the keyboard
On 2011/08/16 15:46:00, dmichael wrote:
> I would remove 'keyboard' from here.

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:620: * GetKeyCode returns the DOM keyCode field
for the keyboard event.
On 2011/08/16 15:46:00, dmichael wrote:
> GetKeyCode()
> (missing parens)

Done.

http://codereview.chromium.org/7647034/diff/1/ppapi/api/ppb_input_event.idl#n...
ppapi/api/ppb_input_event.idl:632: * event.
On 2011/08/16 15:46:00, dmichael wrote:
> maybe add ' as a UTF-8 string.'

Done.

[dmichael (off chromium), 2011-08-16 15:55:48]

Missed one thing, otherwise LGTM.

http://codereview.chromium.org/7647034/diff/5001/ppapi/api/ppb_input_event.idl
File ppapi/api/ppb_input_event.idl (right):

http://codereview.chromium.org/7647034/diff/5001/ppapi/api/ppb_input_event.id...
ppapi/api/ppb_input_event.idl:609: * @param[in] resource A
<code>PP_Resource</code> containing the keyboard
Oops, 'keyboard' is still here.

[jond, 2011-08-16 15:57:27]

http://codereview.chromium.org/7647034/diff/5001/ppapi/api/ppb_input_event.idl
File ppapi/api/ppb_input_event.idl (right):

http://codereview.chromium.org/7647034/diff/5001/ppapi/api/ppb_input_event.id...
ppapi/api/ppb_input_event.idl:609: * @param[in] resource A
<code>PP_Resource</code> containing the keyboard
On 2011/08/16 15:55:48, dmichael wrote:
> Oops, 'keyboard' is still here.

Done.