Updated comments for gcdPrivate API.

Updated comments for gcdPrivate API.

Committed: https://crrev.com/4676bab3b2817d305ade99f3e56966b3119995bf
Cr-Commit-Position: refs/heads/master@{#302771}

[Vitaly Buka (NO REVIEWS), 2014-11-04 20:20:12]

vitalybuka@chromium.org changed reviewers:
+ kalman@chromium.org, mednik@chromium.org, zentaro@chromium.org

[mednik, 2014-11-04 20:27:42]

https://codereview.chromium.org/699123004/diff/40001/chrome/common/extensions...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/40001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:134: // Start pairing with selected
method. Shoulbe be called after
Typo "shouldbe"

https://codereview.chromium.org/699123004/diff/40001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:143: // Confirm pairing code.
Shoulbe be called after |startPairing|.
Typo "shoulbe"

[Vitaly Buka (NO REVIEWS), 2014-11-04 20:37:06]

https://codereview.chromium.org/699123004/diff/40001/chrome/common/extensions...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/40001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:134: // Start pairing with selected
method. Shoulbe be called after
On 2014/11/04 20:27:41, mednik wrote:
> Typo "shouldbe"

Done.

https://codereview.chromium.org/699123004/diff/40001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:143: // Confirm pairing code.
Shoulbe be called after |startPairing|.
On 2014/11/04 20:27:42, mednik wrote:
> Typo "shoulbe"

Done.

[mednik, 2014-11-04 20:56:54]

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:95: // |response| : The response
object or null on some error.
Can this actually be null? Or will it just be an empty object?

Are there are other callbacks here that can return null that we should be aware
of?

[not at google - send to devlin, 2014-11-04 21:13:40]

rs lgtm

[mednik, 2014-11-04 22:08:35]

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:55: // Setup error.
What does "Setup error" refer to (how is it different from other error
statuses)?

[mednik, 2014-11-04 22:11:03]

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:52: // Bad pairing code. Ask user
to retype.
I would also remove the "Ask user to retype" comment (or say "Possibly ask") as
this is likely a product decision; it's acceptable for an app to just decide to
fail and stop the set-up process in this case and let the user start set-up
again from scratch.

[Vitaly Buka (NO REVIEWS), 2014-11-04 23:19:04]

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:52: // Bad pairing code. Ask user
to retype.
On 2014/11/04 22:11:02, mednik wrote:
> I would also remove the "Ask user to retype" comment (or say "Possibly ask")
as
> this is likely a product decision; it's acceptable for an app to just decide
to
> fail and stop the set-up process in this case and let the user start set-up
> again from scratch.

Done.

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:55: // Setup error.
On 2014/11/04 22:08:35, mednik wrote:
> What does "Setup error" refer to (how is it different from other error
> statuses)?

It's errors returned by device itself.
All above are related to session or HTTP.

https://codereview.chromium.org/699123004/diff/60001/chrome/common/extensions...
chrome/common/extensions/api/gcd_private.idl:95: // |response| : The response
object or null on some error.
On 2014/11/04 20:56:54, mednik wrote:
> Can this actually be null? Or will it just be an empty object?
> 
> Are there are other callbacks here that can return null that we should be
aware
> of?

Done.
Let's assume there are no nulls if it's not documented.

[mednik, 2014-11-04 23:22:56]

LGTM w/ nit. Thanks for addressing my questions and comments!

https://codereview.chromium.org/699123004/diff/140001/chrome/common/extension...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/140001/chrome/common/extension...
chrome/common/extensions/api/gcd_private.idl:55: // Device error with details in
responce object.
Nit: Typo "response"

[Vitaly Buka (NO REVIEWS), 2014-11-05 08:44:56]

https://codereview.chromium.org/699123004/diff/140001/chrome/common/extension...
File chrome/common/extensions/api/gcd_private.idl (right):

https://codereview.chromium.org/699123004/diff/140001/chrome/common/extension...
chrome/common/extensions/api/gcd_private.idl:55: // Device error with details in
responce object.
On 2014/11/04 23:22:56, mednik wrote:
> Nit: Typo "response"

Done.

[Vitaly Buka (NO REVIEWS), 2014-11-05 08:45:03]

The CQ bit was checked by vitalybuka@chromium.org

[commit-bot: I haz the power, 2014-11-05 08:45:25]

CQ is trying da patch. Follow status at
 https://chromium-cq-status.appspot.com/patch-status/699123004/180001

[commit-bot: I haz the power, 2014-11-05 09:33:50]

Committed patchset #10 (id:180001)

[commit-bot: I haz the power, 2014-11-05 09:34:30]

Patchset 10 (id:??) landed as
https://crrev.com/4676bab3b2817d305ade99f3e56966b3119995bf
Cr-Commit-Position: refs/heads/master@{#302771}