Skip to content

Commit 2f13cd5

Browse files
authored
fix unresolved dartdoc links (#200)
* fix unresolved dartdoc links * update after merge * review feedback
1 parent 686827a commit 2f13cd5

30 files changed

+2180
-1807
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
treated like non-object literal `external` constructors.
77
- Update the docs for generated interface types to reference the MDN Web Docs
88
project.
9+
- Address several broken links in API documentation.
910

1011
## 0.5.1
1112

lib/src/dom/clipboard_apis.dart

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ extension type ClipboardEventInit._(JSObject _) implements EventInit, JSObject {
3636
/// The **`ClipboardEvent`** interface of the
3737
/// [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API)
3838
/// represents events providing information related to modification of the
39-
/// clipboard, that is [Element/cut_event], [Element/copy_event], and
40-
/// [Element/paste_event] events.
39+
/// clipboard, that is [Element.cut_event], [Element.copy_event], and
40+
/// [Element.paste_event] events.
4141
///
4242
/// ---
4343
///

lib/src/dom/credential_management.dart

+5-5
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ extension type CredentialsContainer._(JSObject _) implements JSObject {
6868
/// uses `get()` to authenticate or provide additional factors during MFA
6969
/// with public key credentials (based on asymmetric cryptography).
7070
/// - The [Federated Credential Management (FedCM)
71-
/// API](/en-US/docs/Web/API/FedCM_API) uses `get()` to authenticate with
72-
/// federated identity providers (IdPs).
71+
/// API](https://developer.mozilla.org/en-US/docs/Web/API/FedCM_API) uses
72+
/// `get()` to authenticate with federated identity providers (IdPs).
7373
/// - The
7474
/// [WebOTP API](https://developer.mozilla.org/en-US/docs/Web/API/WebOTP_API)
7575
/// uses `get()` to request retrieval of a one-time password (OTP) from a
@@ -229,9 +229,9 @@ extension type PasswordCredentialData._(JSObject _)
229229
/// federated identity provider framework.
230230
///
231231
/// > **Note:** The [Federated Credential Management API
232-
/// > (FedCM)](/en-US/docs/Web/API/FedCM_API) provides a more complete solution
233-
/// > for handling identity federation in the browser, and uses the
234-
/// > [IdentityCredential] type.
232+
/// > (FedCM)](https://developer.mozilla.org/en-US/docs/Web/API/FedCM_API)
233+
/// > provides a more complete solution for handling identity federation in the
234+
/// > browser, and uses the [IdentityCredential] type.
235235
///
236236
/// In browsers that support it, an instance of this interface may be passed in
237237
/// the `credential` member of the `init` object for global [fetch].

lib/src/dom/css_font_loading.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ extension type FontFace._(JSObject _) implements JSObject {
8181
/// resolves with the current `FontFace` object.
8282
///
8383
/// If the `source` for the font face was specified as binary data, or the
84-
/// font [FontFace/status] property of the font face is anything other than
84+
/// font [FontFace.status] property of the font face is anything other than
8585
/// `unloaded`, then this method does nothing.
8686
external JSPromise<FontFace> load();
8787
external set family(String value);

lib/src/dom/css_typed_om.dart

+32-29
Original file line numberDiff line numberDiff line change
@@ -303,9 +303,9 @@ extension type CSSMathValue._(JSObject _) implements CSSNumericValue, JSObject {
303303
/// [CSSNumericValue.toSum] on [CSSNumericValue].
304304
///
305305
/// A CSSMathSum is the object type returned when the
306-
/// [`StylePropertyMapReadOnly.get()`](/en-US/docs/Web/API/StylePropertyMapReadOnly/get)
306+
/// [`StylePropertyMapReadOnly.get()`](https://developer.mozilla.org/en-US/docs/Web/API/StylePropertyMapReadOnly/get)
307307
/// method is used on a CSS property whose value is created with a
308-
/// [`calc()`](/en-US/docs/Web/CSS/calc) function.
308+
/// [`calc()`](https://developer.mozilla.org/en-US/docs/Web/CSS/calc) function.
309309
///
310310
/// ---
311311
///
@@ -452,9 +452,9 @@ extension type CSSTransformComponent._(JSObject _) implements JSObject {
452452
}
453453

454454
/// The **`CSSTranslate`** interface of the represents the
455-
/// [translate()](/en-US/docs/Web/CSS/transform-function/translate) value of the
456-
/// individual `transform` property in CSS. It inherits properties and methods
457-
/// from its parent [CSSTransformValue].
455+
/// [translate()](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/translate)
456+
/// value of the individual `transform` property in CSS. It inherits properties
457+
/// and methods from its parent [CSSTransformValue].
458458
///
459459
/// ---
460460
///
@@ -504,10 +504,11 @@ extension type CSSRotate._(JSObject _)
504504
}
505505

506506
/// The **`CSSScale`** interface of the represents the
507-
/// [scale()](/en-US/docs/Web/CSS/transform-function/scale) and
508-
/// [scale3d()](/en-US/docs/Web/CSS/transform-function/scale3d) values of the
509-
/// individual `transform` property in CSS. It inherits properties and methods
510-
/// from its parent [CSSTransformValue].
507+
/// [scale()](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/scale)
508+
/// and
509+
/// [scale3d()](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/scale3d)
510+
/// values of the individual `transform` property in CSS. It inherits properties
511+
/// and methods from its parent [CSSTransformValue].
511512
///
512513
/// ---
513514
///
@@ -531,8 +532,8 @@ extension type CSSScale._(JSObject _)
531532

532533
/// The **`CSSSkew`** interface of the is part of the [CSSTransformValue]
533534
/// interface. It represents the
534-
/// [`skew()`](/en-US/docs/Web/CSS/transform-function/skew) value of the
535-
/// individual `transform` property in CSS.
535+
/// [`skew()`](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/skew)
536+
/// value of the individual `transform` property in CSS.
536537
///
537538
/// ---
538539
///
@@ -552,9 +553,9 @@ extension type CSSSkew._(JSObject _)
552553
}
553554

554555
/// The **`CSSSkewX`** interface of the represents the
555-
/// [`skewX()`](/en-US/docs/Web/CSS/transform-function/skewX) value of the
556-
/// individual `transform` property in CSS. It inherits properties and methods
557-
/// from its parent [CSSTransformValue].
556+
/// [`skewX()`](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/skewX)
557+
/// value of the individual `transform` property in CSS. It inherits properties
558+
/// and methods from its parent [CSSTransformValue].
558559
///
559560
/// ---
560561
///
@@ -569,9 +570,9 @@ extension type CSSSkewX._(JSObject _)
569570
}
570571

571572
/// The **`CSSSkewY`** interface of the represents the
572-
/// [`skewY()`](/en-US/docs/Web/CSS/transform-function/skewY) value of the
573-
/// individual `transform` property in CSS. It inherits properties and methods
574-
/// from its parent [CSSTransformValue].
573+
/// [`skewY()`](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/skewY)
574+
/// value of the individual `transform` property in CSS. It inherits properties
575+
/// and methods from its parent [CSSTransformValue].
575576
///
576577
/// ---
577578
///
@@ -586,9 +587,9 @@ extension type CSSSkewY._(JSObject _)
586587
}
587588

588589
/// The **`CSSPerspective`** interface of the represents the
589-
/// [perspective()](/en-US/docs/Web/CSS/transform-function/perspective) value of
590-
/// the individual `transform` property in CSS. It inherits properties and
591-
/// methods from its parent [CSSTransformValue].
590+
/// [perspective()](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/perspective)
591+
/// value of the individual `transform` property in CSS. It inherits properties
592+
/// and methods from its parent [CSSTransformValue].
592593
///
593594
/// ---
594595
///
@@ -603,10 +604,11 @@ extension type CSSPerspective._(JSObject _)
603604
}
604605

605606
/// The **`CSSMatrixComponent`** interface of the represents the
606-
/// [matrix()](/en-US/docs/Web/CSS/transform-function/matrix) and
607-
/// [matrix3d()](/en-US/docs/Web/CSS/transform-function/matrix3d) values of the
608-
/// individual `transform` property in CSS. It inherits properties and methods
609-
/// from its parent [CSSTransformValue].
607+
/// [matrix()](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/matrix)
608+
/// and
609+
/// [matrix3d()](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/matrix3d)
610+
/// values of the individual `transform` property in CSS. It inherits properties
611+
/// and methods from its parent [CSSTransformValue].
610612
///
611613
/// ---
612614
///
@@ -634,11 +636,12 @@ extension type CSSMatrixComponentOptions._(JSObject _) implements JSObject {
634636
/// represents values for properties that take an image, for example , , or .
635637
///
636638
/// The CSSImageValue object represents an
637-
/// [`<image>`](/en-US/docs/Web/CSS/image) that involves a URL, such as
638-
/// [`url()`](/en-US/docs/Web/CSS/url) or
639-
/// [`image()`](/en-US/docs/Web/CSS/image), but not
640-
/// [`linear-gradient()`](/en-US/docs/Web/CSS/gradient/linear-gradient) or
641-
/// [`element()`](/en-US/docs/Web/CSS/element).
639+
/// [`<image>`](https://developer.mozilla.org/en-US/docs/Web/CSS/image) that
640+
/// involves a URL, such as
641+
/// [`url()`](https://developer.mozilla.org/en-US/docs/Web/CSS/url) or
642+
/// [`image()`](https://developer.mozilla.org/en-US/docs/Web/CSS/image), but not
643+
/// [`linear-gradient()`](https://developer.mozilla.org/en-US/docs/Web/CSS/gradient/linear-gradient)
644+
/// or [`element()`](https://developer.mozilla.org/en-US/docs/Web/CSS/element).
642645
///
643646
/// ---
644647
///

lib/src/dom/dom.dart

+27-25
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,17 @@ typedef XPathNSResolver = JSFunction;
3131
typedef ShadowRootMode = String;
3232
typedef SlotAssignmentMode = String;
3333

34-
/// The **`Event`** interface represents an event which takes place in the DOM.
34+
/// The **`Event`** interface represents an event which takes place on an
35+
/// [`EventTarget`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget).
3536
///
3637
/// An event can be triggered by the user action e.g. clicking the mouse button
3738
/// or tapping keyboard, or generated by APIs to represent the progress of an
3839
/// asynchronous task. It can also be triggered programmatically, such as by
39-
/// calling the [`HTMLElement.click()`](/en-US/docs/Web/API/HTMLElement/click)
40+
/// calling the
41+
/// [`HTMLElement.click()`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click)
4042
/// method of an element, or by defining the event, then sending it to a
4143
/// specified target using
42-
/// [`EventTarget.dispatchEvent()`](/en-US/docs/Web/API/EventTarget/dispatchEvent).
44+
/// [`EventTarget.dispatchEvent()`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent).
4345
///
4446
/// There are many types of events, some of which use other interfaces based on
4547
/// the main `Event` interface. `Event` itself contains the properties and
@@ -50,12 +52,12 @@ typedef SlotAssignmentMode = String;
5052
/// are usually connected (or "attached") to various
5153
/// [HTML elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)
5254
/// (such as `<button>`, `<div>`, `<span>`, etc.) using
53-
/// [`EventTarget.addEventListener()`](/en-US/docs/Web/API/EventTarget/addEventListener),
55+
/// [`EventTarget.addEventListener()`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener),
5456
/// and this generally replaces using the old HTML
5557
/// [event handler attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes).
5658
/// Further, when properly added, such handlers can also be disconnected if
5759
/// needed using
58-
/// [`removeEventListener()`](/en-US/docs/Web/API/EventTarget/removeEventListener).
60+
/// [`removeEventListener()`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener).
5961
///
6062
/// > **Note:** One element can have several such handlers, even for the exact
6163
/// > same event—particularly if separate, independent code modules attach them,
@@ -343,8 +345,8 @@ extension type EventTarget._(JSObject _) implements JSObject {
343345
/// > same listener, and vice versa.
344346
///
345347
/// Event listeners can also be removed by passing an [AbortSignal] to an
346-
/// [EventTarget/addEventListener] and then later calling
347-
/// [AbortController/abort] on the controller owning the signal.
348+
/// [EventTarget.addEventListener] and then later calling
349+
/// [AbortController.abort] on the controller owning the signal.
348350
external void removeEventListener(
349351
String type,
350352
EventListener? callback, [
@@ -359,7 +361,7 @@ extension type EventTarget._(JSObject _) implements JSObject {
359361
/// dispatched manually with `dispatchEvent()`.
360362
///
361363
/// Calling `dispatchEvent()` is the last step to _firing an event_. The event
362-
/// should have already been created and initialized using an [Event/Event]
364+
/// should have already been created and initialized using an [Event.Event]
363365
/// constructor.
364366
///
365367
/// > **Note:** When calling this method, the [Event.target] property is
@@ -696,7 +698,7 @@ extension type Node._(JSObject _) implements EventTarget, JSObject {
696698
/// including intrinsic (inline) listeners. It does _not_ copy event listeners
697699
/// added
698700
/// using
699-
/// [`addEventListener()`](/en-US/docs/Web/API/EventTarget/addEventListener)
701+
/// [`addEventListener()`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
700702
/// or
701703
/// those assigned to element properties (e.g., `node.onclick =
702704
/// someFunction`).
@@ -730,7 +732,7 @@ extension type Node._(JSObject _) implements EventTarget, JSObject {
730732

731733
/// The **`isSameNode()`** method of the [Node] interface
732734
/// is a legacy alias the [for the `===` strict equality
733-
/// operator](/en-US/docs/Web/JavaScript/Reference/Operators/Strict_equality).
735+
/// operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Strict_equality).
734736
/// That is, it tests whether two nodes are the same
735737
/// (in other words, whether they reference the same object).
736738
///
@@ -973,8 +975,8 @@ extension type Document._(JSObject _) implements Node, JSObject {
973975
/// When called on
974976
/// the [document] object, the complete document is searched, including the
975977
/// root node. You may also call [Element.getElementsByClassName] on any
976-
/// element; it will return only elements which are
977-
/// descendants of the specified root element with the given class name(s).
978+
/// element; it will return only elements which are descendants of the
979+
/// specified root element with the given class name(s).
978980
///
979981
/// > **Warning:** This is a live [HTMLCollection]. Changes in the DOM will
980982
/// > reflect in the array as the changes occur. If an element selected by
@@ -1048,11 +1050,11 @@ extension type Document._(JSObject _) implements Node, JSObject {
10481050
]);
10491051

10501052
/// **`Document.adoptNode()`** transfers a from another [Document] into the
1051-
/// method's
1052-
/// document. The adopted node and its subtree are removed from their original
1053-
/// document (if
1054-
/// any), and their [Node.ownerDocument] is changed to the
1055-
/// current document. The node can then be inserted into the current document.
1053+
/// method's document.
1054+
/// The adopted node and its subtree are removed from their original document
1055+
/// (if any), and their [Node.ownerDocument] is changed to the current
1056+
/// document.
1057+
/// The node can then be inserted into the current document.
10561058
external Node adoptNode(Node node);
10571059

10581060
/// The **`Document.createAttribute()`** method creates a new
@@ -1226,7 +1228,7 @@ extension type Document._(JSObject _) implements Node, JSObject {
12261228
/// `copy`) can work without an editable element.
12271229
///
12281230
/// > **Note:** Modifications performed by `execCommand()` may or may not
1229-
/// > trigger [Element/beforeinput_event] and [Element/input_event] events,
1231+
/// > trigger [Element.beforeinput_event] and [Element.input_event] events,
12301232
/// > depending on the browser and configuration. If triggered, the handlers
12311233
/// > for the events will run before `execCommand()` returns. Authors need to
12321234
/// > be careful about such recursive calls, especially if they call
@@ -2164,7 +2166,7 @@ extension type Element._(JSObject _) implements Node, JSObject {
21642166
/// lower-cases the argument before searching for it. This is undesirable when
21652167
/// trying to
21662168
/// match SVG elements (such as
2167-
/// [`<linearGradient>`](/en-US/docs/Web/SVG/Element/linearGradient))
2169+
/// [`<linearGradient>`](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/linearGradient))
21682170
/// in an HTML document. Instead, use [Element.getElementsByTagNameNS],
21692171
/// which preserves the capitalization of the tag name.
21702172
///
@@ -2216,7 +2218,7 @@ extension type Element._(JSObject _) implements Node, JSObject {
22162218
/// pointer will
22172219
/// be targeted at the capture element until capture is released (via
22182220
/// [Element.releasePointerCapture] or the
2219-
/// [Element/pointerup_event] event is fired).
2221+
/// [Element.pointerup_event] event is fired).
22202222
///
22212223
/// > **Note:** Pointer capture will cause the target to capture all
22222224
/// > subsequent pointer events as if they were occurring over the capturing
@@ -2581,23 +2583,23 @@ extension type CharacterData._(JSObject _) implements Node, JSObject {
25812583
/// `CharacterData` node.
25822584
///
25832585
/// Strings are inserted as [Text] nodes; the string is being passed as
2584-
/// argument to the [Text/Text] constructor.
2586+
/// argument to the [Text.Text] constructor.
25852587
external void before(JSAny nodes);
25862588

25872589
/// The **`after()`** method of the [CharacterData] interface
25882590
/// inserts a set of [Node] objects or strings in the children list of the
25892591
/// object's parent, just after the object itself.
25902592
///
25912593
/// Strings are inserted as [Text] nodes; the string is being passed as
2592-
/// argument to the [Text/Text] constructor.
2594+
/// argument to the [Text.Text] constructor.
25932595
external void after(JSAny nodes);
25942596

25952597
/// The **`replaceWith()`** method of the [CharacterData] interface
25962598
/// replaces this node in the children list of its parent
25972599
/// with a set of [Node] objects or string.
25982600
///
25992601
/// Strings are inserted as [Text] nodes; the string is being passed as
2600-
/// argument to the [Text/Text] constructor.
2602+
/// argument to the [Text.Text] constructor.
26012603
external void replaceWith(JSAny nodes);
26022604

26032605
/// The **`remove()`** method of the [CharacterData] removes the text
@@ -2828,8 +2830,8 @@ extension type StaticRange._(JSObject _) implements AbstractRange, JSObject {
28282830
/// contain nodes and parts of text nodes.
28292831
///
28302832
/// A range can be created by using the [Document.createRange] method. Range
2831-
/// objects can also be retrieved by using the [Selection/getRangeAt] method of
2832-
/// the [Selection] object or the [Document/caretRangeFromPoint] method of the
2833+
/// objects can also be retrieved by using the [Selection.getRangeAt] method of
2834+
/// the [Selection] object or the [Document.caretRangeFromPoint] method of the
28332835
/// [Document] object.
28342836
///
28352837
/// There also is the [Range.Range] constructor available.

lib/src/dom/encrypted_media.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ extension type MediaKeyMessageEventInit._(JSObject _)
229229
/// The **`MediaEncryptedEvent`** interface of the
230230
/// [Encrypted Media Extensions API](https://developer.mozilla.org/en-US/docs/Web/API/Encrypted_Media_Extensions_API)
231231
/// contains the information associated with an
232-
/// [HTMLMediaElement/encrypted_event] event sent to a [HTMLMediaElement] when
232+
/// [HTMLMediaElement.encrypted_event] event sent to a [HTMLMediaElement] when
233233
/// some initialization data is encountered in the media.
234234
///
235235
/// ---

0 commit comments

Comments
 (0)