Add documentation to ALPN functionality in dart:io

Add documentation to ALPN functionality in dart:io

R=floitsch@google.com

Committed: https://github.com/dart-lang/sdk/commit/fac6cda661cdc088e75cf97adc66a4c8608cca14

[kustermann, 2017-03-22 14:54:12]

kustermann@google.com changed reviewers:
+ lrn@google.com

[kustermann, 2017-03-24 11:48:28]

kustermann@google.com changed reviewers:
+ floitsch@google.com

[kustermann, 2017-03-24 11:48:28]

@Florian: Could you take a look?

[floitsch, 2017-03-24 14:03:26]

LGTM.

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.dart
File sdk/lib/io/secure_socket.dart (right):

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:137: * Gets the protocol which was selected during
ALPN protocol negotiation.
The protocol ...
(drop the "Gets")

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:139: * If one of the peers does not have support
for ALPN, did not specify a
Returns null if ...

Or
Is set to null if ...

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:141: * client and server then this will return
null.
If you don't want to reshuffle the whole sentence, then "then this returns
null".
That said, we try to use "this" in dartdoc to imply "this instance".

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:317: * Gets the protocol which was selected during
protocol negotiation.
Same as above.

[kustermann, 2017-03-25 11:38:32]

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.dart
File sdk/lib/io/secure_socket.dart (right):

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:137: * Gets the protocol which was selected during
ALPN protocol negotiation.
On 2017/03/24 14:03:26, floitsch wrote:
> The protocol ...
> (drop the "Gets")

Done.

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:139: * If one of the peers does not have support
for ALPN, did not specify a
On 2017/03/24 14:03:26, floitsch wrote:
> Returns null if ...
> 
> Or
> Is set to null if ...

Done.

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:141: * client and server then this will return
null.
On 2017/03/24 14:03:26, floitsch wrote:
> If you don't want to reshuffle the whole sentence, then "then this returns
> null".
> That said, we try to use "this" in dartdoc to imply "this instance".

Reshuffled the sentence.

https://codereview.chromium.org/2770573003/diff/1/sdk/lib/io/secure_socket.da...
sdk/lib/io/secure_socket.dart:317: * Gets the protocol which was selected during
protocol negotiation.
On 2017/03/24 14:03:26, floitsch wrote:
> Same as above.

Done.

[kustermann, 2017-03-25 11:38:43]

Description was changed from

==========
Add documentation to ALPN functionality in dart:io
==========

to

==========
Add documentation to ALPN functionality in dart:io

R=floitsch@google.com

Committed:
https://github.com/dart-lang/sdk/commit/fac6cda661cdc088e75cf97adc66a4c8608cca14
==========

[kustermann, 2017-03-25 11:38:44]

Committed patchset #2 (id:20001) manually as
fac6cda661cdc088e75cf97adc66a4c8608cca14 (presubmit successful).