Skip to content

Commit 76307cd

Browse files
committed
Updated generated docs.
1 parent c462bf2 commit 76307cd

File tree

2,335 files changed

+10636
-2581
lines changed

Some content is hidden

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

2,335 files changed

+10636
-2581
lines changed

CSharpToJavaScript/Utils/Docs/AbortcontrollerAbort/AbortcontrollerAbort.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AbortControllerAbort>
33
<summary>
4-
The <strong><c>abort()</c></strong> method of the <see cref="AbortController"/> interface aborts an asynchronous operation before it has completed.<br/>This is able to abort <see href="https://developer.mozilla.org/en-US/docs/Web/API/fetch">fetch requests</see>, the consumption of any response bodies, or streams.
4+
The <strong><c>abort()</c></strong> method of the <see cref="AbortController"/> interface aborts an asynchronous operation before it has completed.<br/>This is able to abort <see href="https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch">fetch requests</see>, the consumption of any response bodies, or streams.
55
</summary>
66
<remarks>
77
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>

CSharpToJavaScript/Utils/Docs/AbortsignalAbort/AbortsignalAbort.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The <strong><c>AbortSignal.abort()</c></strong> static method returns an <see cref="AbortSignal"/> that is already set as aborted (and which does not trigger an <see cref="AbortSignal/abort_event"/> event).
55
</summary>
66
<remarks>
7-
<para>This is shorthand for the following code:</para><para>This could, for example, be passed to a fetch method in order to run its abort logic (i.e. it may be that code is organized such that the abort logic should be run even if the intended fetch operation has not been started).</para><blockquote class="NOTE"><h5>NOTE</h5><para><strong>Note:</strong> The method is similar in purpose to <see cref="PromiseReject"/>.</para></blockquote>
7+
<para>This is shorthand for the following code:</para><para>This could, for example, be passed to a fetch method in order to run its abort logic (i.e. it may be that code is organized such that the abort logic should be run even if the intended fetch operation has not been started).</para><blockquote><para>The method is similar in purpose to <see cref="PromiseReject"/>.</para></blockquote>
88
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort"> <em>See also on MDN</em> </seealso></para>
99
</remarks>
1010
<returns>An <c>AbortSignal</c> instance with the <see cref="AbortSignal.Aborted"/> property set to <c>true</c>, and <see cref="AbortSignal.Reason"/> set to the specified or default reason value.</returns>

CSharpToJavaScript/Utils/Docs/Abstractrange/Abstractrange.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The <strong><c>AbstractRange</c></strong> abstract interface is the base class upon which all <see href="https://developer.mozilla.org/en-US/docs/Glossary/DOM">DOM</see> range types are defined. A <strong>range</strong> is an object that indicates the start and end points of a section of content within the document.
55
</summary>
66
<remarks>
7-
<blockquote class="NOTE"><h5>NOTE</h5><para><strong>Note:</strong> As an abstract interface, you will not directly instantiate an object of type <c>AbstractRange</c>. Instead, you will use the <see cref="Range"/> or <see cref="StaticRange"/> interfaces. To understand the difference between those two interfaces, and how to choose which is appropriate for your needs, consult each interface's documentation.</para></blockquote><para></para>
7+
<blockquote><para>As an abstract interface, you will not directly instantiate an object of type <c>AbstractRange</c>. Instead, you will use the <see cref="Range"/> or <see cref="StaticRange"/> interfaces. To understand the difference between those two interfaces, and how to choose which is appropriate for your needs, consult each interface's documentation.</para></blockquote><para></para>
88
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange"> <em>See also on MDN</em> </seealso></para>
99
</remarks>
1010
</AbstractRange>

CSharpToJavaScript/Utils/Docs/Aesctrparams/Aesctrparams.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The <strong><c>AesCtrParams</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>algorithm</c> parameter into <see cref="SubtleCrypto.Encrypt"/>, <see cref="SubtleCrypto.Decrypt"/>, <see cref="SubtleCrypto.WrapKey"/>, or <see cref="SubtleCrypto.UnwrapKey"/>, when using the <see href="https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt#aes-ctr">AES-CTR</see> algorithm.
55
</summary>
66
<remarks>
7-
<para>AES is a block cipher, meaning that it splits the message into blocks and encrypts it a block at a time. In CTR mode, every time a block of the message is encrypted, an extra block of data is mixed in. This extra block is called the &amp;quot;counter block&amp;quot;.</para><para>A given counter block value must never be used more than once with the same key:</para><para>Typically this is achieved by splitting the initial counter block value into two concatenated parts:</para><para>Essentially: the nonce should ensure that counter blocks are not reused from one message to the next, while the counter should ensure that counter blocks are not reused within a single message.</para><blockquote class="NOTE"><h5>NOTE</h5><para><strong>Note:</strong> See <see href="https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf#%5B%7B%22num%22%3A70%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22Fit%22%7D%5D">Appendix B of the NIST SP800-38A standard</see> for more information.</para></blockquote>
7+
<para>AES is a block cipher, meaning that it splits the message into blocks and encrypts it a block at a time. In CTR mode, every time a block of the message is encrypted, an extra block of data is mixed in. This extra block is called the &amp;quot;counter block&amp;quot;.</para><para>A given counter block value must never be used more than once with the same key:</para><para>Typically this is achieved by splitting the initial counter block value into two concatenated parts:</para><para>Essentially: the nonce should ensure that counter blocks are not reused from one message to the next, while the counter should ensure that counter blocks are not reused within a single message.</para><blockquote><para>See <see href="https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf#%5B%7B%22num%22%3A70%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22Fit%22%7D%5D">Appendix B of the NIST SP800-38A standard</see> for more information.</para></blockquote>
88
<para>-CTR mode is defined in section 6.5 of the <see href="https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38a.pdf#%5B%7B%22num%22%3A70%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22Fit%22%7D%5D">NIST SP800-38A standard</see>.<br/>-<see cref="SubtleCrypto.Encrypt"/>.<br/>-<see cref="SubtleCrypto.Decrypt"/>.<br/>-<see cref="SubtleCrypto.WrapKey"/>.<br/>-<see cref="SubtleCrypto.UnwrapKey"/>.<br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AesCtrParams"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

CSharpToJavaScript/Utils/Docs/AnalysernodeGetfloatfrequencydata/AnalysernodeGetfloatfrequencydata.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AnalyserNodeGetFloatFrequencyData>
33
<summary>
4-
The <strong><c>getFloatFrequencyData()</c></strong> method of the <see cref="AnalyserNode"/> Interface copies the current frequency data into a {{jsxref("Float32Array")}} array passed into it. Each array value is a <strong>sample</strong>, the magnitude of the signal at a particular time.
4+
The <strong><c>getFloatFrequencyData()</c></strong> method of the <see cref="AnalyserNode"/> Interface copies the current frequency data into a {{jsxref("Float32Array")}} array passed into it.
55
</summary>
66
<remarks>
77
<para>Each item in the array represents the decibel value for a specific frequency. The frequencies are spread linearly from 0 to 1/2 of the sample rate. For example, for a <c>48000</c> Hz sample rate, the last item of the array will represent the decibel value for <c>24000</c> Hz.</para><para>If you need higher performance and don't care about precision, you can use <see cref="AnalyserNode.GetByteFrequencyData"/> instead, which works on a {{jsxref("Uint8Array")}}.</para>

CSharpToJavaScript/Utils/Docs/AnalysernodeMindecibels/AnalysernodeMindecibels.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ The <strong><c>minDecibels</c></strong> property of the <see cref="AnalyserNode"
77
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">Using the Web Audio API</see><br/></para>
88
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/minDecibels"> <em>See also on MDN</em> </seealso></para>
99
</remarks>
10-
<value>A double, representing the minimum <see href="https://en.wikipedia.org/wiki/Decibel">decibel</see> value for scaling the FFT analysis data, where <c>0</c> dB is the loudest possible sound, <c>-10</c> dB is a 10th of that, etc. The default value is <c>-100</c> dB.When getting data from <c>getByteFrequencyData()</c>, any frequencies with an amplitude of <c>minDecibels</c> or lower will be returned as <c>0</c>.<blockquote class="NOTE"><h5>NOTE</h5><strong>Note:</strong> If a value greater than <c>AnalyserNode.maxDecibels</c> is set, an <c>INDEX_SIZE_ERR</c> exception is thrown.</blockquote></value>
10+
<value>A double, representing the minimum <see href="https://en.wikipedia.org/wiki/Decibel">decibel</see> value for scaling the FFT analysis data, where <c>0</c> dB is the loudest possible sound, <c>-10</c> dB is a 10th of that, etc. The default value is <c>-100</c> dB.When getting data from <c>getByteFrequencyData()</c>, any frequencies with an amplitude of <c>minDecibels</c> or lower will be returned as <c>0</c>.<blockquote>If a value greater than <c>AnalyserNode.maxDecibels</c> is set, an <c>INDEX_SIZE_ERR</c> exception is thrown.</blockquote></value>
1111
</AnalyserNodeMinDecibels>
1212
</docs>

CSharpToJavaScript/Utils/Docs/AnalysernodeSmoothingtimeconstant/AnalysernodeSmoothingtimeconstant.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ The <strong><c>smoothingTimeConstant</c></strong> property of the <see cref="Ana
77
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">Using the Web Audio API</see><br/></para>
88
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/smoothingTimeConstant"> <em>See also on MDN</em> </seealso></para>
99
</remarks>
10-
<value>A double within the range <c>0</c> to <c>1</c> (<c>0</c> meaning no time averaging). The default value is <c>0.8</c>.If 0 is set, there is no averaging done, whereas a value of 1 means "overlap the previous and current buffer quite a lot while computing the value", which essentially smooths the changes across <see cref="AnalyserNode.GetFloatFrequencyData"/>/<see cref="AnalyserNode.GetByteFrequencyData"/> calls.In technical terms, we apply a <see href="https://webaudio.github.io/web-audio-api/#blackman-window">Blackman window</see> and smooth the values over time. The default value is good enough for most cases.<blockquote class="NOTE"><h5>NOTE</h5><strong>Note:</strong> If a value outside the range 0–1 is set, an <c>INDEX_SIZE_ERR</c> exception is thrown.</blockquote></value>
10+
<value>A double within the range <c>0</c> to <c>1</c> (<c>0</c> meaning no time averaging). The default value is <c>0.8</c>.If 0 is set, there is no averaging done, whereas a value of 1 means "overlap the previous and current buffer quite a lot while computing the value", which essentially smooths the changes across <see cref="AnalyserNode.GetFloatFrequencyData"/>/<see cref="AnalyserNode.GetByteFrequencyData"/> calls.In technical terms, we apply a <see href="https://webaudio.github.io/web-audio-api/#blackman-window">Blackman window</see> and smooth the values over time. The default value is good enough for most cases.<blockquote>If a value outside the range 0–1 is set, an <c>INDEX_SIZE_ERR</c> exception is thrown.</blockquote></value>
1111
</AnalyserNodeSmoothingTimeConstant>
1212
</docs>

CSharpToJavaScript/Utils/Docs/AnimationCancel/AnimationCancel.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
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.
55
</summary>
66
<remarks>
7-
<blockquote class="NOTE"><h5>NOTE</h5><para><strong>Note:</strong> When an animation is cancelled, its <see cref="Animation.StartTime"/> and <see cref="Animation.CurrentTime"/> are set to <c>null</c>.</para></blockquote>
7+
<blockquote><para>When an animation is cancelled, its <see cref="Animation.StartTime"/> and <see cref="Animation.CurrentTime"/> are set to <c>null</c>.</para></blockquote>
88
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see><br/>-<see cref="KeyframeEffect"/><br/>-<see cref="Animation"/><br/>-<see cref="Animation.PlayState"/><br/>-<see cref="Animation.Finished"/> returns the promise this action will reject if the animation's <c>playState</c> is not <c>&amp;quot;idle&amp;quot;</c>.<br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Animation/cancel"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

CSharpToJavaScript/Utils/Docs/AnimationCommitstyles/AnimationCommitstyles.generated.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<docs>
22
<AnimationCommitStyles>
33
<summary>
4-
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/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/Global_attributes#style"><c>style</c></see> attribute. <c>commitStyles()</c> works even if the animation has been <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API#automatically_removing_filling_animations">automatically removed</see>.
4+
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/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/Global_attributes/style"><c>style</c></see> attribute. <c>commitStyles()</c> works even if the animation has been <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API#automatically_removing_filling_animations">automatically removed</see>.
55
</summary>
66
<remarks>
7-
<para><c>commitStyles()</c> can be used in combination with <c>fill</c> to cause the final state of an animation to persist after the animation ends. The same effect could be achieved with <c>fill</c> alone, but <see href="https://drafts.csswg.org/web-animations-1/#fill-behavior">using indefinitely filling animations is discouraged</see>. Animations <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade#cascading_order">take precedence over all static styles</see>, so an indefinite filling animation can prevent the target element from ever being styled normally.</para><para>Using <c>commitStyles()</c> writes the styling state into the element&amp;apos;s <see href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#style"><c>style</c></see> attribute, where they can be modified and replaced as normal.</para>
7+
<para><c>commitStyles()</c> can be used in combination with <c>fill</c> to cause the final state of an animation to persist after the animation ends. The same effect could be achieved with <c>fill</c> alone, but <see href="https://drafts.csswg.org/web-animations-1/#fill-behavior">using indefinitely filling animations is discouraged</see>. Animations <see href="https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade#cascading_order">take precedence over all static styles</see>, so an indefinite filling animation can prevent the target element from ever being styled normally.</para><para>Using <c>commitStyles()</c> writes the styling state into the element&amp;apos;s <see href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/style"><c>style</c></see> attribute, where they can be modified and replaced as normal.</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"/> for other methods and properties you can use to control web page animation.<br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Animation/commitStyles"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

CSharpToJavaScript/Utils/Docs/AnimationFinished/AnimationFinished.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The <strong><c>Animation.finished</c></strong> read-only property of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see> returns a <see cref="Promise"/> which resolves once the animation has finished playing.
55
</summary>
66
<remarks>
7-
<blockquote class="NOTE"><h5>NOTE</h5><para><strong>Note:</strong> Every time the animation leaves the <c>finished</c> play state (that is, when it starts playing again), a new <c>Promise</c> is created for this property. The new <c>Promise</c> will resolve once the new animation sequence has completed.</para></blockquote>
7+
<blockquote><para>Every time the animation leaves the <c>finished</c> play state (that is, when it starts playing again), a new <c>Promise</c> is created for this property. The new <c>Promise</c> will resolve once the new animation sequence has completed.</para></blockquote>
88
<para>-<see cref="KeyframeEffect"/><br/>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API">Web Animations API</see><br/>-<see cref="Animation"/><br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Animation/finished"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

0 commit comments

Comments
 (0)