Skip to content

Commit 6a25f12

Browse files
srawlinsCommit Queue
authored and
Commit Queue
committed
SDK: replace unsupported [this] comment references with this.
Work towards dart-lang/dartdoc#3761 The analyzer has never recognized `[this]` as a valid doc comment reference (and the `comment_references` lint rule has similarly reported such reference attempts). dartdoc has its own algorithms for resolving comment references, which we are dismantling in favor of a single resolution, provided by the analyzer. We've also decided against adding support in the analyzer (see https://github.com/dart-lang/linter/issues/2079), so these reference attempts should be re-written. CoreLibraryReviewExempt: Comments only. Change-Id: I6cc85115186527820bdd38dcfda8f61e35ae3fe9 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/365204 Reviewed-by: Nate Bosch <[email protected]> Commit-Queue: Samuel Rawlins <[email protected]> Reviewed-by: Lasse Nielsen <[email protected]>
1 parent 219b2b0 commit 6a25f12

21 files changed

+149
-134
lines changed

sdk/lib/_internal/js_dev_runtime/patch/bigint_patch.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1940,7 +1940,7 @@ class _BigIntImpl implements BigInt {
19401940
return _a + digit - 10;
19411941
}
19421942

1943-
/// Converts [this] to a string representation in the given [radix].
1943+
/// Converts this [BigInt] to a string representation in the given [radix].
19441944
///
19451945
/// In the string representation, lower-case letters are used for digits above
19461946
/// '9', with 'a' being 10 an 'z' being 35.

sdk/lib/_internal/js_dev_runtime/private/js_array.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ class JSArray<E> extends JavaScriptObject
143143
return false;
144144
}
145145

146-
/// Removes elements matching [test] from [this] List.
146+
/// Removes elements matching [test] from this [JSArray].
147147
void removeWhere(bool Function(E) test) {
148148
checkGrowable('removeWhere');
149149
_removeWhere(test, true);

sdk/lib/_internal/js_dev_runtime/private/native_typed_data.dart

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1272,7 +1272,7 @@ final class NativeFloat32x4 implements Float32x4 {
12721272
_cx ? -1 : 0, _cy ? -1 : 0, _cz ? -1 : 0, _cw ? -1 : 0);
12731273
}
12741274

1275-
/// Returns a copy of [this] each lane being scaled by [s].
1275+
/// Returns a copy of this [Float32x4] each lane being scaled by [s].
12761276
Float32x4 scale(double s) {
12771277
double _x = s * x;
12781278
double _y = s * y;
@@ -1290,7 +1290,7 @@ final class NativeFloat32x4 implements Float32x4 {
12901290
return NativeFloat32x4._truncated(_x, _y, _z, _w);
12911291
}
12921292

1293-
/// Clamps [this] to be in the range [lowerLimit]-[upperLimit].
1293+
/// Clamps this [Float32x4] to be in the range [lowerLimit]-[upperLimit].
12941294
Float32x4 clamp(Float32x4 lowerLimit, Float32x4 upperLimit) {
12951295
double _lx = lowerLimit.x;
12961296
double _ly = lowerLimit.y;
@@ -1349,9 +1349,9 @@ final class NativeFloat32x4 implements Float32x4 {
13491349
return NativeFloat32x4._truncated(_x, _y, _z, _w);
13501350
}
13511351

1352-
/// Shuffle the lane values in [this] and [other]. The returned
1353-
/// Float32x4 will have XY lanes from [this] and ZW lanes from [other].
1354-
/// Uses the same [mask] as [shuffle].
1352+
/// Shuffle the lane values in this [Float32x4] and [other]. The returned
1353+
/// Float32x4 will have XY lanes from this [Float32x4] and ZW lanes from
1354+
/// [other]. Uses the same [mask] as [shuffle].
13551355
Float32x4 shuffleMix(Float32x4 other, int mask) {
13561356
if ((mask < 0) || (mask > 255)) {
13571357
throw RangeError.range(mask, 0, 255, "mask");
@@ -1372,31 +1372,31 @@ final class NativeFloat32x4 implements Float32x4 {
13721372
return NativeFloat32x4._truncated(_x, _y, _z, _w);
13731373
}
13741374

1375-
/// Copy [this] and replace the [x] lane.
1375+
/// Copy this [Float32x4] and replace the [x] lane.
13761376
Float32x4 withX(double newX) {
13771377
ArgumentError.checkNotNull(newX);
13781378
return NativeFloat32x4._truncated(_truncate(newX), y, z, w);
13791379
}
13801380

1381-
/// Copy [this] and replace the [y] lane.
1381+
/// Copy this [Float32x4] and replace the [y] lane.
13821382
Float32x4 withY(double newY) {
13831383
ArgumentError.checkNotNull(newY);
13841384
return NativeFloat32x4._truncated(x, _truncate(newY), z, w);
13851385
}
13861386

1387-
/// Copy [this] and replace the [z] lane.
1387+
/// Copy this [Float32x4] and replace the [z] lane.
13881388
Float32x4 withZ(double newZ) {
13891389
ArgumentError.checkNotNull(newZ);
13901390
return NativeFloat32x4._truncated(x, y, _truncate(newZ), w);
13911391
}
13921392

1393-
/// Copy [this] and replace the [w] lane.
1393+
/// Copy this [Float32x4] and replace the [w] lane.
13941394
Float32x4 withW(double newW) {
13951395
ArgumentError.checkNotNull(newW);
13961396
return NativeFloat32x4._truncated(x, y, z, _truncate(newW));
13971397
}
13981398

1399-
/// Returns the lane-wise minimum value in [this] or [other].
1399+
/// Returns the lane-wise minimum value in this [Float32x4] or [other].
14001400
Float32x4 min(Float32x4 other) {
14011401
double _x = x < other.x ? x : other.x;
14021402
double _y = y < other.y ? y : other.y;
@@ -1405,7 +1405,7 @@ final class NativeFloat32x4 implements Float32x4 {
14051405
return NativeFloat32x4._truncated(_x, _y, _z, _w);
14061406
}
14071407

1408-
/// Returns the lane-wise maximum value in [this] or [other].
1408+
/// Returns the lane-wise maximum value in this [Float32x4] or [other].
14091409
Float32x4 max(Float32x4 other) {
14101410
double _x = x > other.x ? x : other.x;
14111411
double _y = y > other.y ? y : other.y;
@@ -1414,7 +1414,7 @@ final class NativeFloat32x4 implements Float32x4 {
14141414
return NativeFloat32x4._truncated(_x, _y, _z, _w);
14151415
}
14161416

1417-
/// Returns the square root of [this].
1417+
/// Returns the square root of this [Float32x4].
14181418
Float32x4 sqrt() {
14191419
double _x = Math.sqrt(x);
14201420
double _y = Math.sqrt(y);
@@ -1423,7 +1423,7 @@ final class NativeFloat32x4 implements Float32x4 {
14231423
return NativeFloat32x4._doubles(_x, _y, _z, _w);
14241424
}
14251425

1426-
/// Returns the reciprocal of [this].
1426+
/// Returns the reciprocal of this [Float32x4].
14271427
Float32x4 reciprocal() {
14281428
double _x = 1.0 / x;
14291429
double _y = 1.0 / y;
@@ -1432,7 +1432,7 @@ final class NativeFloat32x4 implements Float32x4 {
14321432
return NativeFloat32x4._doubles(_x, _y, _z, _w);
14331433
}
14341434

1435-
/// Returns the square root of the reciprocal of [this].
1435+
/// Returns the square root of the reciprocal of this [Float32x4].
14361436
Float32x4 reciprocalSqrt() {
14371437
double _x = Math.sqrt(1.0 / x);
14381438
double _y = Math.sqrt(1.0 / y);
@@ -1577,8 +1577,8 @@ final class NativeInt32x4 implements Int32x4 {
15771577
return NativeInt32x4._truncated(_x, _y, _z, _w);
15781578
}
15791579

1580-
/// Shuffle the lane values in [this] and [other]. The returned
1581-
/// Int32x4 will have XY lanes from [this] and ZW lanes from [other].
1580+
/// Shuffle the lane values in this [Int32x4] and [other]. The returned
1581+
/// Int32x4 will have XY lanes from this [Int32x4] and ZW lanes from [other].
15821582
/// Uses the same [mask] as [shuffle].
15831583
Int32x4 shuffleMix(Int32x4 other, int mask) {
15841584
if ((mask < 0) || (mask > 255)) {
@@ -1600,28 +1600,28 @@ final class NativeInt32x4 implements Int32x4 {
16001600
return NativeInt32x4._truncated(_x, _y, _z, _w);
16011601
}
16021602

1603-
/// Returns a new [Int32x4] copied from [this] with a new x value.
1603+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new x value.
16041604
Int32x4 withX(int x) {
16051605
ArgumentError.checkNotNull(x);
16061606
int _x = _truncate(x);
16071607
return NativeInt32x4._truncated(_x, y, z, w);
16081608
}
16091609

1610-
/// Returns a new [Int32x4] copied from [this] with a new y value.
1610+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new y value.
16111611
Int32x4 withY(int y) {
16121612
ArgumentError.checkNotNull(y);
16131613
int _y = _truncate(y);
16141614
return NativeInt32x4._truncated(x, _y, z, w);
16151615
}
16161616

1617-
/// Returns a new [Int32x4] copied from [this] with a new z value.
1617+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new z value.
16181618
Int32x4 withZ(int z) {
16191619
ArgumentError.checkNotNull(z);
16201620
int _z = _truncate(z);
16211621
return NativeInt32x4._truncated(x, y, _z, w);
16221622
}
16231623

1624-
/// Returns a new [Int32x4] copied from [this] with a new w value.
1624+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new w value.
16251625
Int32x4 withW(int w) {
16261626
ArgumentError.checkNotNull(w);
16271627
int _w = _truncate(w);
@@ -1640,33 +1640,33 @@ final class NativeInt32x4 implements Int32x4 {
16401640
/// Extracted w value. Returns `false` for 0, `true` for any other value.
16411641
bool get flagW => w != 0;
16421642

1643-
/// Returns a new [Int32x4] copied from [this] with a new x value.
1643+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new x value.
16441644
Int32x4 withFlagX(bool flagX) {
16451645
int _x = flagX ? -1 : 0;
16461646
return NativeInt32x4._truncated(_x, y, z, w);
16471647
}
16481648

1649-
/// Returns a new [Int32x4] copied from [this] with a new y value.
1649+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new y value.
16501650
Int32x4 withFlagY(bool flagY) {
16511651
int _y = flagY ? -1 : 0;
16521652
return NativeInt32x4._truncated(x, _y, z, w);
16531653
}
16541654

1655-
/// Returns a new [Int32x4] copied from [this] with a new z value.
1655+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new z value.
16561656
Int32x4 withFlagZ(bool flagZ) {
16571657
int _z = flagZ ? -1 : 0;
16581658
return NativeInt32x4._truncated(x, y, _z, w);
16591659
}
16601660

1661-
/// Returns a new [Int32x4] copied from [this] with a new w value.
1661+
/// Returns a new [Int32x4] copied from this [Int32x4] with a new w value.
16621662
Int32x4 withFlagW(bool flagW) {
16631663
int _w = flagW ? -1 : 0;
16641664
return NativeInt32x4._truncated(x, y, z, _w);
16651665
}
16661666

1667-
/// Merge [trueValue] and [falseValue] based on [this]' bit mask:
1668-
/// Select bit from [trueValue] when bit in [this] is on.
1669-
/// Select bit from [falseValue] when bit in [this] is off.
1667+
/// Merge [trueValue] and [falseValue] based on this [Int32x4] bit mask:
1668+
/// Select bit from [trueValue] when bit in this [Int32x4] is on.
1669+
/// Select bit from [falseValue] when bit in this [Int32x4] is off.
16701670
Float32x4 select(Float32x4 trueValue, Float32x4 falseValue) {
16711671
var floatList = NativeFloat32x4._list;
16721672
var intView = NativeFloat32x4._uint32view;
@@ -1749,7 +1749,7 @@ final class NativeFloat64x2 implements Float64x2 {
17491749
return NativeFloat64x2._doubles(x / other.x, y / other.y);
17501750
}
17511751

1752-
/// Returns a copy of [this] each lane being scaled by [s].
1752+
/// Returns a copy of this [Float64x2] each lane being scaled by [s].
17531753
Float64x2 scale(double s) {
17541754
return NativeFloat64x2._doubles(x * s, y * s);
17551755
}
@@ -1759,7 +1759,7 @@ final class NativeFloat64x2 implements Float64x2 {
17591759
return NativeFloat64x2._doubles(x.abs(), y.abs());
17601760
}
17611761

1762-
/// Clamps [this] to be in the range [lowerLimit]-[upperLimit].
1762+
/// Clamps this [Float64x2] to be in the range [lowerLimit]-[upperLimit].
17631763
Float64x2 clamp(Float64x2 lowerLimit, Float64x2 upperLimit) {
17641764
double _lx = lowerLimit.x;
17651765
double _ly = lowerLimit.y;
@@ -1785,31 +1785,33 @@ final class NativeFloat64x2 implements Float64x2 {
17851785
return mx | my << 1;
17861786
}
17871787

1788-
/// Returns a new [Float64x2] copied from [this] with a new x value.
1788+
/// Returns a new [Float64x2] copied from this [Float64x2] with a new x
1789+
/// value.
17891790
Float64x2 withX(double x) {
17901791
if (x is! num) throw ArgumentError(x);
17911792
return NativeFloat64x2._doubles(x, y);
17921793
}
17931794

1794-
/// Returns a new [Float64x2] copied from [this] with a new y value.
1795+
/// Returns a new [Float64x2] copied from this [Float64x2] with a new y
1796+
/// value.
17951797
Float64x2 withY(double y) {
17961798
if (y is! num) throw ArgumentError(y);
17971799
return NativeFloat64x2._doubles(x, y);
17981800
}
17991801

1800-
/// Returns the lane-wise minimum value in [this] or [other].
1802+
/// Returns the lane-wise minimum value in this [Float64x2] or [other].
18011803
Float64x2 min(Float64x2 other) {
18021804
return NativeFloat64x2._doubles(
18031805
x < other.x ? x : other.x, y < other.y ? y : other.y);
18041806
}
18051807

1806-
/// Returns the lane-wise maximum value in [this] or [other].
1808+
/// Returns the lane-wise maximum value in this [Float64x2] or [other].
18071809
Float64x2 max(Float64x2 other) {
18081810
return NativeFloat64x2._doubles(
18091811
x > other.x ? x : other.x, y > other.y ? y : other.y);
18101812
}
18111813

1812-
/// Returns the lane-wise square root of [this].
1814+
/// Returns the lane-wise square root of this [Float64x2].
18131815
Float64x2 sqrt() {
18141816
return NativeFloat64x2._doubles(Math.sqrt(x), Math.sqrt(y));
18151817
}

sdk/lib/_internal/js_runtime/lib/async_patch.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ class _SyncStarIterator<T> implements Iterator<T> {
556556
// statements. For non-sync* iterators, [_nestedIterator] contains the
557557
// iterator. We delegate to [_nestedIterator] when it is not `null`.
558558
//
559-
// For nested sync* iterators, [this] iterator acts on behalf of the innermost
559+
// For nested sync* iterators, this [Iterator] acts on behalf of the innermost
560560
// nested sync* iterator. The current state machine is suspended on a stack
561561
// until the inner state machine ends.
562562

sdk/lib/_internal/js_runtime/lib/bigint_patch.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1959,7 +1959,7 @@ class _BigIntImpl implements BigInt {
19591959
return _a + digit - 10;
19601960
}
19611961

1962-
/// Converts [this] to a string representation in the given [radix].
1962+
/// Converts this [BigInt] to a string representation in the given [radix].
19631963
///
19641964
/// In the string representation, lower-case letters are used for digits above
19651965
/// '9', with 'a' being 10 an 'z' being 35.

sdk/lib/_internal/js_runtime/lib/js_array.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ class JSArray<E> extends JavaScriptObject implements List<E>, JSIndexable<E> {
225225
return false;
226226
}
227227

228-
/// Removes elements matching [test] from [this] List.
228+
/// Removes elements matching [test] from this [JSArray].
229229
void removeWhere(bool test(E element)) {
230230
checkGrowable('removeWhere');
231231
_removeWhere(test, true);

0 commit comments

Comments
 (0)