Formatting changes

Formatting changes
Fixes to some of the C documentation in the IDL.
Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=96561

[der Springer, 2011-08-09 20:40:40]

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
File ppapi/c/pp_completion_callback.h (right):

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:24: * This typedef defines the signature that
you implement to
Nit: join this line with the next and re-format to 80-cols.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:29: * values (other than -1) indicate error and
are specified in pp_errors.h.
Maybe mention that -1 is the same as PP_OK_COMPLETIONPENDING.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:85: * method will complete asynchronously and
will always be invoked from the main
..."complete asynchronously and notify the caller of its completion by calling
|func|.  The callback to |func| will always occur on the main thread of Pepper
execution."

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:92: * The result parameter passes an int32_t
that, if negative or equal to 0,
"...parameter passed to |func| is an int32_t that,..."

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:95: * information such as bytes read.
I think |result| is actually an error or result code in all cases.  By the time
|func| is called with |result|, the original method has already completed, so
it's incorrect to say that a negative value means the callback will be
asynchronous.  Maybe:

"The |result| parameter passed to |func| is an int32_t that indicates either an
error value or some other value specific to the calling method.  If |result| is
less than 0, then it is an error code (see pp_errors.h for more info).  If
|result| is 0 or positive, it is a value specific to the calling method such as
number of bytes read."

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h
File ppapi/c/pp_input_event.h (right):

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:241: * This value indicates the amount vertically and
horizontally the user has
Horizontal only.  And this sentence is pretty awkward.  Maybe: "The mouse
wheel's horizontal scroll amount."

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:244: * values, and a scroll up or to the left (where
the content moves down or
Remove references to "up/down" in this section.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:264: * This value indicates the amount vertically and
horizontally the user has
Vertical only.  Also, this sentence is awkward (see above);.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:266: * right (where the content moves up or left) is
represented as positive
Remove references to "left/right" in this section.

[jond, 2011-08-10 21:05:59]

I need to rebuild and upload the .h files (using the IDL). These changes were
made in the IDL. Give me a day...

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
File ppapi/c/pp_completion_callback.h (right):

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:24: * This typedef defines the signature that
you implement to
On 2011/08/09 20:40:40, der Springer wrote:
> Nit: join this line with the next and re-format to 80-cols.

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:24: * This typedef defines the signature that
you implement to
On 2011/08/09 20:40:40, der Springer wrote:
> Nit: join this line with the next and re-format to 80-cols.

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:29: * values (other than -1) indicate error and
are specified in pp_errors.h.
On 2011/08/09 20:40:40, der Springer wrote:
> Maybe mention that -1 is the same as PP_OK_COMPLETIONPENDING.

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:85: * method will complete asynchronously and
will always be invoked from the main
On 2011/08/09 20:40:40, der Springer wrote:
> ..."complete asynchronously and notify the caller of its completion by calling
> |func|.  The callback to |func| will always occur on the main thread of Pepper
> execution."

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:85: * method will complete asynchronously and
will always be invoked from the main
On 2011/08/09 20:40:40, der Springer wrote:
> ..."complete asynchronously and notify the caller of its completion by calling
> |func|.  The callback to |func| will always occur on the main thread of Pepper
> execution."

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:92: * The result parameter passes an int32_t
that, if negative or equal to 0,
On 2011/08/09 20:40:40, der Springer wrote:
> "...parameter passed to |func| is an int32_t that,..."

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:92: * The result parameter passes an int32_t
that, if negative or equal to 0,
On 2011/08/09 20:40:40, der Springer wrote:
> "...parameter passed to |func| is an int32_t that,..."

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_completion_callba...
ppapi/c/pp_completion_callback.h:95: * information such as bytes read.
On 2011/08/09 20:40:40, der Springer wrote:
> I think |result| is actually an error or result code in all cases.  By the
time
> |func| is called with |result|, the original method has already completed, so
> it's incorrect to say that a negative value means the callback will be
> asynchronous.  Maybe:
> 
> "The |result| parameter passed to |func| is an int32_t that indicates either
an
> error value or some other value specific to the calling method.  If |result|
is
> less than 0, then it is an error code (see pp_errors.h for more info).  If
> |result| is 0 or positive, it is a value specific to the calling method such
as
> number of bytes read."

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h
File ppapi/c/pp_input_event.h (right):

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:241: * This value indicates the amount vertically and
horizontally the user has
On 2011/08/09 20:40:40, der Springer wrote:
> Horizontal only.  And this sentence is pretty awkward.  Maybe: "The mouse
> wheel's horizontal scroll amount."

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:244: * values, and a scroll up or to the left (where
the content moves down or
On 2011/08/09 20:40:40, der Springer wrote:
> Remove references to "up/down" in this section.

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:264: * This value indicates the amount vertically and
horizontally the user has
On 2011/08/09 20:40:40, der Springer wrote:
> Vertical only.  Also, this sentence is awkward (see above);.

Done.

http://codereview.chromium.org/7308010/diff/5001/ppapi/c/pp_input_event.h#new...
ppapi/c/pp_input_event.h:266: * right (where the content moves up or left) is
represented as positive
On 2011/08/09 20:40:40, der Springer wrote:
> Remove references to "left/right" in this section.

Done.

[jond, 2011-08-10 21:20:34]

New IDL uploaded as are the new headers that were generated.

[der Springer, 2011-08-10 21:35:42]

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_completion_cal...
File ppapi/api/pp_completion_callback.idl (right):

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_completion_cal...
ppapi/api/pp_completion_callback.idl:65: * negative or equal to 0, indicate if
the call will complete asynchronously
indicates ?

Also, I think |func| is called only *after* the call has completed - that is,
regardless of whether the original call ran asynchronously or not.  So |result}|
does *not* indicate if the call will complete async.  Instead, a negative value
is an error code whose meaning is specific to the calling method (see
pp_error.h).  A positive or 0 value is a return result whose meaning depends on
the calling method (e.g. number of bytes read).

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_input_event.idl
File ppapi/api/pp_input_event.idl (right):

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_input_event.id...
ppapi/api/pp_input_event.idl:153: * The mouse whee's vertical scroll amount. A
scroll to the right
whee -> wheel

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_input_event.id...
ppapi/api/pp_input_event.idl:154: * (where the content moves left) is
represented as positive values,
Replace (left/right) with (down/up):

A scroll down (where the content moves up) is represented as a positive value,
...

[jond, 2011-08-11 19:12:27]

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_completion_cal...
File ppapi/api/pp_completion_callback.idl (right):

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_completion_cal...
ppapi/api/pp_completion_callback.idl:65: * negative or equal to 0, indicate if
the call will complete asynchronously
On 2011/08/10 21:35:43, der Springer wrote:
> indicates ?
> 
> Also, I think |func| is called only *after* the call has completed - that is,
> regardless of whether the original call ran asynchronously or not.  So
|result}|
> does *not* indicate if the call will complete async.  Instead, a negative
value
> is an error code whose meaning is specific to the calling method (see
> pp_error.h).  A positive or 0 value is a return result whose meaning depends
on
> the calling method (e.g. number of bytes read).

Done.

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_input_event.idl
File ppapi/api/pp_input_event.idl (right):

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_input_event.id...
ppapi/api/pp_input_event.idl:153: * The mouse whee's vertical scroll amount. A
scroll to the right
On 2011/08/10 21:35:43, der Springer wrote:
> whee -> wheel

Done.

http://codereview.chromium.org/7308010/diff/11001/ppapi/api/pp_input_event.id...
ppapi/api/pp_input_event.idl:154: * (where the content moves left) is
represented as positive values,
On 2011/08/10 21:35:43, der Springer wrote:
> Replace (left/right) with (down/up):
> 
> A scroll down (where the content moves up) is represented as a positive value,
> ...

Done.

[der Springer, 2011-08-11 19:20:51]

http://codereview.chromium.org/7308010/diff/16001/ppapi/api/pp_completion_cal...
File ppapi/api/pp_completion_callback.idl (right):

http://codereview.chromium.org/7308010/diff/16001/ppapi/api/pp_completion_cal...
ppapi/api/pp_completion_callback.idl:67: * positive or 0 value is a return
result whose meaning depends on
Nit: "...a return result indicating success whose meaning..."

http://codereview.chromium.org/7308010/diff/16001/ppapi/api/pp_input_event.idl
File ppapi/api/pp_input_event.idl (right):

http://codereview.chromium.org/7308010/diff/16001/ppapi/api/pp_input_event.id...
ppapi/api/pp_input_event.idl:155: * and a scroll to the left (where the content
moves right) is
"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."

[jond, 2011-08-11 20:49:44]

http://codereview.chromium.org/7308010/diff/16001/ppapi/api/pp_completion_cal...
File ppapi/api/pp_completion_callback.idl (right):

http://codereview.chromium.org/7308010/diff/16001/ppapi/api/pp_completion_cal...
ppapi/api/pp_completion_callback.idl:67: * positive or 0 value is a return
result whose meaning depends on
On 2011/08/11 19:20:51, der Springer wrote:
> Nit: "...a return result indicating success whose meaning..."

Done.

[der Springer, 2011-08-11 20:53:33]

LGTM.

[noelallen_use_chromium, 2011-08-11 21:10:53]

I'm just along to verify the generator is doing the correct thing, so LGTM.
In the future it's enough to just CC, instead of adding me as a reviewer.  That
way I can look at the change and make sure we aren't having generation issues
without affecting your LGTM.

[dmichael (off chromium), 2011-08-12 15:57:45]

rubber-stamp LGTM