Skip to content

Commit

Permalink
Update doc comments for dart:js
Browse files Browse the repository at this point in the history
Fixes flutter#38280, Fixes flutter#24576

- Add "Low level" to the library doc comment and add a sentence about
  preferring to use `package:js`.
- Add doc comments on `allowInterop` and `allowInteropCaptureThis`.
- Remove the docs that discuss what dart2js "may" do in the future.
- Tweak some comments on classes to use a noun over a verb - "A proxy
  on" over "Proxies".

Cleanup:

- Use `///` consistently.
- Ensure the docs are identical between the two copies of the file, this
  minimizes the diff.

Change-Id: I7f904d77b2d9dd537201dd53a29d7ef74289aa86
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/116555
Reviewed-by: Kathy Walrath <kathyw@google.com>
Reviewed-by: Sigmund Cherem <sigmund@google.com>
Commit-Queue: Nate Bosch <nbosch@google.com>
  • Loading branch information
natebosch authored and commit-bot@chromium.org committed Sep 11, 2019
1 parent dd3d654 commit 2cc0c4f
Show file tree
Hide file tree
Showing 2 changed files with 305 additions and 350 deletions.
Loading

0 comments on commit 2cc0c4f

Please sign in to comment.