Skip to content

Commit cac4b3d

Browse files
committed
Updated generated docs.
1 parent 8ebe780 commit cac4b3d

File tree

321 files changed

+2685
-1197
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

321 files changed

+2685
-1197
lines changed

CSharpToJavaScript/Utils/Docs/abortsignal/abortsignal.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The <strong><c>AbortSignal.any()</c></strong> static method takes an iterable of
4444
<remarks>
4545
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any"> <em>See also on MDN</em> </seealso></para>
4646
</remarks>
47-
<returns>A <see cref="AbortSignal"/> that is:</returns>
47+
<returns>An <see cref="AbortSignal"/> that is:</returns>
4848
</AbortSignalAny>
4949
<AbortSignalReason>
5050
<summary>

CSharpToJavaScript/Utils/Docs/abstractrange/abstractrange.generated.xml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The <strong><c>AbstractRange</c></strong> abstract interface is the base class u
1313
The read-only <strong><c>collapsed</c></strong> property of the <see cref="AbstractRange"/> interface returns <c>true</c> if the range&amp;apos;s start position and end position are the same.
1414
</summary>
1515
<remarks>
16+
<para>A collapsed range is empty (containing no content), and specifies a single point in a DOM tree. To collapse a range, see the <see cref="Range.Collapse"/> method.</para>
1617
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/collapsed"> <em>See also on MDN</em> </seealso></para>
1718
</remarks>
1819
<value>A boolean value which is <c>true</c> if the range is <strong>collapsed</strong>. A collapsed range is one in which the start and end positions are the same, resulting in a zero-character-long range.</value>
@@ -22,6 +23,7 @@ The read-only <strong><c>collapsed</c></strong> property of the <see cref="Abstr
2223
The read-only <strong><c>endContainer</c></strong> property of the <see cref="AbstractRange"/> interface returns the <see cref="Node"/> in which the end of the range is located.
2324
</summary>
2425
<remarks>
26+
<para>To change the end position, use the <see cref="Range.SetEnd"/> method or a similar one.</para>
2527
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/endContainer"> <em>See also on MDN</em> </seealso></para>
2628
</remarks>
2729
<value>The <see cref="Node"/> which contains the last character of the range.</value>
@@ -31,15 +33,17 @@ The read-only <strong><c>endContainer</c></strong> property of the <see cref="Ab
3133
The <strong><c>endOffset</c></strong> property of the <see cref="AbstractRange"/> interface returns the offset into the end node of the range's end position.
3234
</summary>
3335
<remarks>
36+
<para>To change the end position, use the <see cref="Range.SetEnd"/> method or a similar one.</para>
3437
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/endOffset"> <em>See also on MDN</em> </seealso></para>
3538
</remarks>
36-
<value>An integer value indicating the number of characters into the <see cref="Node"/> indicated by <see cref="AbstractRange.EndContainer"/> at which the final character of the range is located.</value>
39+
<value>An integer value indicating the number of characters into the <see cref="Node"/> indicated by <see cref="AbstractRange.EndContainer"/> at which the final character of the range is located.If the <c>endContainer</c> is a <see cref="Node"/> of type <see cref="Text"/>, <see cref="Comment"/>, or <see cref="CDATASection"/>, then the offset is the number of characters from the start of the <c>endContainer</c> to the boundary point of the range. For other <see cref="Node"/> types, the <c>endOffset</c> is the number of child nodes between the start of the <c>endContainer</c> and the boundary point of the range.</value>
3740
</AbstractRangeEndOffset>
3841
<AbstractRangeStartContainer>
3942
<summary>
40-
The read-only <strong><c>startContainer</c></strong> property of the <see cref="AbstractRange"/> interface returns the start <see cref="Node"/> for the range.
43+
The read-only <strong><c>startContainer</c></strong> property of the <see cref="AbstractRange"/> interface returns the <see cref="Node"/> in which the start of the range is located.
4144
</summary>
4245
<remarks>
46+
<para>To change the start position, use the <see cref="Range.SetStart"/> method or a similar one.</para>
4347
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/startContainer"> <em>See also on MDN</em> </seealso></para>
4448
</remarks>
4549
<value>The <see cref="Node"/> inside which the start position of the range is found.</value>
@@ -49,8 +53,9 @@ The read-only <strong><c>startContainer</c></strong> property of the <see cref="
4953
The read-only <strong><c>startOffset</c></strong> property of the <see cref="AbstractRange"/> interface returns the offset into the start node of the range's start position.
5054
</summary>
5155
<remarks>
56+
<para>To change the start position, use the <see cref="Range.SetStart"/> method or a similar one.</para>
5257
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/startOffset"> <em>See also on MDN</em> </seealso></para>
5358
</remarks>
54-
<value>An integer value indicating the number of characters into the <see cref="Node"/> indicated by <see cref="AbstractRange.StartContainer"/> at which the first character of the range is located.</value>
59+
<value>An integer value indicating the number of characters into the <see cref="Node"/> indicated by <see cref="AbstractRange.StartContainer"/> at which the first character of the range is located.If the <c>startContainer</c> is a <see cref="Node"/> of type <see cref="Text"/>, <see cref="Comment"/>, or <see cref="CDATASection"/>, then the offset is the number of characters from the start of the <c>startContainer</c> to the boundary point of the range. For other <see cref="Node"/> types, the <c>startOffset</c> is the number of child nodes between the start of the <c>startContainer</c> and the boundary point of the range.</value>
5560
</AbstractRangeStartOffset>
5661
</docs>
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<docs>
2+
<AesDerivedKeyParams>
3+
<summary>
4+
The <strong><c>AesDerivedKeyParams</c></strong> dictionary of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API">Web Crypto API</see> represents the object that should be passed as the <c>derivedKeyType</c> parameter into <see cref="SubtleCrypto.DeriveKey"/>, when deriving an AES key: that is, when the algorithm is identified as any of <see href="https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-cbc">AES-CBC</see>, <see href="https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-ctr">AES-CTR</see>, <see href="https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-gcm">AES-GCM</see>, or <see href="https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/wrapKey#aes-kw">AES-KW</see>.
5+
</summary>
6+
<remarks>
7+
<para>-<see cref="SubtleCrypto.GenerateKey"/>.<br/></para>
8+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AesDerivedKeyParams"> <em>See also on MDN</em> </seealso></para>
9+
</remarks>
10+
</AesDerivedKeyParams>
11+
</docs>

CSharpToJavaScript/Utils/Docs/animation/animation.generated.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The <strong><c>Animation()</c></strong> constructor of the <see href="https://de
2020
</AnimationAnimation>
2121
<AnimationCancel>
2222
<summary>
23-
The Web Animations API&amp;apos;s <strong><c>cancel()</c></strong> method of the <see cref="Animation"/> interface clears all <see cref="KeyframeEffect"/>s caused by this animation and aborts its playback.
23+
The <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see>&amp;apos;s <strong><c>cancel()</c></strong> method of the <see cref="Animation"/> interface clears all <see cref="KeyframeEffect"/>s caused by this animation and aborts its playback.
2424
</summary>
2525
<remarks>
2626
<blockquote class="NOTE"><h5>NOTE</h5><para>When an animation is cancelled, its <see cref="Animation.StartTime"/> and <see cref="Animation.CurrentTime"/> are set to <c>null</c>.</para></blockquote>
@@ -41,7 +41,7 @@ The <strong><c>cancel</c></strong> event of the <see cref="Animation"/> interfac
4141
</AnimationCancel>
4242
<AnimationCommitStyles>
4343
<summary>
44-
The <c>commitStyles()</c> method of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see>'s <see cref="Animation"/> interface writes the <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_cascade/Value_processing#computed_value">computed values</see> of the animation&amp;apos;s current styles into its target element&amp;apos;s <see href="https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/style"><c>style</c></see> attribute.
44+
The <c>commitStyles()</c> method of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see>'s <see cref="Animation"/> interface writes the <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Cascade/Property_value_processing#computed_value">computed values</see> of the animation&amp;apos;s current styles into its target element&amp;apos;s <see href="https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/style"><c>style</c></see> attribute.
4545
</summary>
4646
<remarks>
4747
<para>It is primarily used to write the styles for the final state of an animation into the target element, so that the styling persists after the animation ends.</para>
@@ -69,7 +69,7 @@ The <strong><c>Animation.effect</c></strong> property of the <see href="https://
6969
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see><br/>-<see cref="AnimationEffect"/><br/>-<see cref="Animation"/><br/></para>
7070
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Animation/effect"> <em>See also on MDN</em> </seealso></para>
7171
</remarks>
72-
<value>A <see cref="AnimationEffect"/> object describing the target animation effect for the animation, or <c>null</c> to indicate no active effect.</value>
72+
<value>An <see cref="AnimationEffect"/> object describing the target animation effect for the animation, or <c>null</c> to indicate no active effect.</value>
7373
</AnimationEffect>
7474
<AnimationFinish>
7575
<summary>

CSharpToJavaScript/Utils/Docs/animationeffect/animationeffect.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The <c>AnimationEffect</c> interface of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see> is an interface representing animation effects.
55
</summary>
66
<remarks>
7-
<para><c>AnimationEffect</c> is an abstract interface and so isn't directly instantiable. However, concrete interfaces such as <see cref="KeyframeEffect"/> inherit from it, and instances of these interfaces can be passed to <see cref="Animation"/> objects for playing, and may also be used by <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_animations">CSS Animations</see> and <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions">Transitions</see>.</para>
7+
<para><c>AnimationEffect</c> is an abstract interface and so isn't directly instantiable. However, concrete interfaces such as <see cref="KeyframeEffect"/> inherit from it, and instances of these interfaces can be passed to <see cref="Animation"/> objects for playing, and may also be used by <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Animations">CSS Animations</see> and <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Transitions">Transitions</see>.</para>
88
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see><br/>-<see cref="Animation.Effect"/><br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AnimationEffect"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

0 commit comments

Comments
 (0)