Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Class docs for Datagram class are too brief and full of typos #33721

Closed
Hixie opened this issue Jul 1, 2018 · 4 comments
Closed

Class docs for Datagram class are too brief and full of typos #33721

Hixie opened this issue Jul 1, 2018 · 4 comments
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-io P2 A bug or feature request we're likely to work on triaged Issue has been triaged by sub team type-documentation A request to add or improve documentation

Comments

@Hixie
Copy link
Contributor

Hixie commented Jul 1, 2018

If you just search for "Datagram" in the docs and end up in the Datagram class, the documentation is impenetrable and unhelpful. It should at a minimum point you towards RawDatagramSocket. Ideally it would have sample code.

Datagram package.

This is misleading since it sounds like it's talking about a Dart package.

Data send to and received from datagram sockets

"sent"

contains the internet address and port of the destination or source

The data doesn't contain this stuff.

togeter

"together".

with the data.

The data contains the data? That makes no sense.

@Hixie
Copy link
Contributor Author

Hixie commented Jul 1, 2018

I should add that the RawDatagramSocket class docs are pretty anemic as well.

@Hixie
Copy link
Contributor Author

Hixie commented Jul 1, 2018

For example, look at the documentation for RawDatagramSocket.bind. What is the first argument? A hostname string? An integer containing an IP address? An InternetAddress object? There's absolutely no information there to answer even the most basic question about how to use this API.

@Hixie
Copy link
Contributor Author

Hixie commented Jul 1, 2018

There's also a number of completely undocumented members in this API, for example RawSocketEvent.write.

@lrhn lrhn added area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-io type-documentation A request to add or improve documentation labels Jul 2, 2018
dart-bot pushed a commit that referenced this issue Sep 9, 2020
Documentation on RawDatagramSocket were too brief.

This change also add documentation on SocketException, which previously
doesn't have any documents.

Bug: #33721
Bug: #35147

Change-Id: I6e33e5814c5af93ac7986de394ca1999f723091a
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/138886
Commit-Queue: Zichang Guo <zichangguo@google.com>
Reviewed-by: Lasse R.H. Nielsen <lrn@google.com>
Reviewed-by: Jonas Termansen <sortie@google.com>
@brianquinlan brianquinlan added triaged Issue has been triaged by sub team P2 A bug or feature request we're likely to work on labels Dec 28, 2022
@brianquinlan
Copy link
Contributor

brianquinlan commented Dec 28, 2022

copybara-service bot pushed a commit that referenced this issue Jan 10, 2023
Bug: #33721
Change-Id: I503c910f4a854dea0561687a06c760ad11ffc5dc
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/277663
Commit-Queue: Brian Quinlan <bquinlan@google.com>
Reviewed-by: Alexander Aprelev <aam@google.com>
Reviewed-by: Jonas Termansen <sortie@google.com>
copybara-service bot pushed a commit that referenced this issue Oct 30, 2023
Bug: #33721
Change-Id: I4e8f35cec8d3e689469a63826d118cfa2fe42218
CoreLibraryReviewExempt: Documentation-only change
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/277701
Reviewed-by: Alexander Aprelev <aam@google.com>
Commit-Queue: Brian Quinlan <bquinlan@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-io P2 A bug or feature request we're likely to work on triaged Issue has been triaged by sub team type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

3 participants