Skip to content

Commit af621ba

Browse files
TiLiedTiLied
committed
Updated generated docs.
1 parent 11c1f89 commit af621ba

File tree

992 files changed

+74172
-0
lines changed

Some content is hidden

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

992 files changed

+74172
-0
lines changed

‎CSharpToJavaScript/Utils/Docs/abortcontroller/abortcontroller.generated.xml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<docs>
2+
<AbortController>
3+
<summary>
4+
The <strong><c>AbortController</c></strong> interface represents a controller object that allows you to abort one or more Web requests as and when desired.
5+
</summary>
6+
<remarks>
7+
<para>You can create a new <c>AbortController</c> object using the <see cref="AbortController.AbortController"/> constructor. Communicating with an asynchronous operation is done using an <see cref="AbortSignal"/> object.</para>
8+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/>-<see href="https://developer.chrome.com/blog/abortable-fetch/">Abortable Fetch</see> by Jake Archibald<br/></para>
9+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController"> <em>See also on MDN</em> </seealso></para>
10+
</remarks>
11+
</AbortController>
12+
<AbortControllerAbortController>
13+
<summary>
14+
The <strong><c>AbortController()</c></strong> constructor creates a new <see cref="AbortController"/> object instance.
15+
</summary>
16+
<remarks>
17+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
18+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/AbortController"> <em>See also on MDN</em> </seealso></para>
19+
</remarks>
20+
</AbortControllerAbortController>
21+
<AbortControllerSignal>
22+
<summary>
23+
The <strong><c>signal</c></strong> read-only property of the <see cref="AbortController"/> interface returns an <see cref="AbortSignal"/> object instance, which can be used to communicate with/abort an asynchronous operation as desired.
24+
</summary>
25+
<remarks>
26+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
27+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal"> <em>See also on MDN</em> </seealso></para>
28+
</remarks>
29+
<value>An <see cref="AbortSignal"/> object instance.</value>
30+
</AbortControllerSignal>
31+
<AbortControllerAbort>
32+
<summary>
33+
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.
34+
</summary>
35+
<remarks>
36+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
37+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort"> <em>See also on MDN</em> </seealso></para>
38+
</remarks>
39+
<returns>None (<see cref="Undefined"/>).</returns>
40+
</AbortControllerAbort>
41+
</docs>

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<docs>
2+
<AbortSignal>
3+
<summary>
4+
The <strong><c>AbortSignal</c></strong> interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an <see cref="AbortController"/> object.
5+
</summary>
6+
<remarks>
7+
<para></para>
8+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/>-<see href="https://developer.chrome.com/blog/abortable-fetch/">Abortable Fetch</see> by Jake Archibald<br/></para>
9+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal"> <em>See also on MDN</em> </seealso></para>
10+
</remarks>
11+
</AbortSignal>
12+
<AbortSignalAborted>
13+
<summary>
14+
The <strong><c>aborted</c></strong> read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (<c>true</c>) or not (<c>false</c>).
15+
</summary>
16+
<remarks>
17+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
18+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/aborted"> <em>See also on MDN</em> </seealso></para>
19+
</remarks>
20+
<value><c>true</c> (aborted) or <c>false</c></value>
21+
</AbortSignalAborted>
22+
<AbortSignalAbort>
23+
<summary>
24+
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="AbortSignalabort"/> event).
25+
</summary>
26+
<remarks>
27+
<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>The method is similar in purpose to <see cref="PromiseReject"/>.</para></blockquote>
28+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort"> <em>See also on MDN</em> </seealso></para>
29+
</remarks>
30+
<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>
31+
</AbortSignalAbort>
32+
<AbortSignalAbort>
33+
<summary>
34+
The <strong><c>abort</c></strong> event of the <see cref="AbortSignal"/> is fired when the associated request is aborted, i.e., using <see cref="AbortController.Abort"/>.
35+
</summary>
36+
<remarks>
37+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort"> <em>See also on MDN</em> </seealso></para>
38+
</remarks>
39+
</AbortSignalAbort>
40+
<AbortSignalReason>
41+
<summary>
42+
The <strong><c>reason</c></strong> read-only property returns a JavaScript value that indicates the abort reason.
43+
</summary>
44+
<remarks>
45+
<para>The property is <c>undefined</c> when the signal has not been aborted.<br/>It can be set to a specific value when the signal is aborted, using <see cref="AbortController.Abort"/> or <see cref="AbortSignalabort"/>.<br/>If not explicitly set in those methods, it defaults to "AbortError" <see cref="DOMException"/>.</para>
46+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
47+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/reason"> <em>See also on MDN</em> </seealso></para>
48+
</remarks>
49+
<value>A JavaScript value that indicates the abort reason, or <c>undefined</c>, if not aborted.</value>
50+
</AbortSignalReason>
51+
<AbortSignalThrowIfAborted>
52+
<summary>
53+
The <strong><c>throwIfAborted()</c></strong> method throws the signal's abort <see cref="AbortSignal.Reason"/> if the signal has been aborted; otherwise it does nothing.
54+
</summary>
55+
<remarks>
56+
<para>An API that needs to support aborting can accept an <see cref="AbortSignal"/> object and use <c>throwIfAborted()</c> to test and throw when the <see href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/abort_event"><c>abort</c></see> event is signalled.</para><para>This method can also be used to abort operations at particular points in code, rather than passing to functions that take a signal.</para>
57+
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
58+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/throwIfAborted"> <em>See also on MDN</em> </seealso></para>
59+
</remarks>
60+
<returns>None (<see cref="Undefined"/>).</returns>
61+
</AbortSignalThrowIfAborted>
62+
<AbortSignalAny>
63+
<summary>
64+
The <strong><c>AbortSignal.any()</c></strong> static method takes an iterable of abort signals and returns an <see cref="AbortSignal"/>. The returned abort signal is aborted when any of the input iterable abort signals are aborted. The {{domxref("AbortSignal.reason", "abort reason",&amp;quot;&amp;quot;,"true")}} will be set to the reason of the first signal that is aborted. If any of the given abort signals are already aborted then so will be the returned <see cref="AbortSignal"/>.
65+
</summary>
66+
<remarks>
67+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any"> <em>See also on MDN</em> </seealso></para>
68+
</remarks>
69+
<returns>A <see cref="AbortSignal"/> that is:</returns>
70+
</AbortSignalAny>
71+
<AbortSignalTimeout>
72+
<summary>
73+
The <strong><c>AbortSignal.timeout()</c></strong> static method returns an <see cref="AbortSignal"/> that will automatically abort after a specified time.
74+
</summary>
75+
<remarks>
76+
<para>The signal aborts with a <c>TimeoutError</c> <see cref="DOMException"/> on timeout.</para><para>The timeout is based on active rather than elapsed time, and will effectively be paused if the code is running in a suspended worker, or while the document is in a back-forward cache (&amp;quot;<see href="https://web.dev/articles/bfcache">bfcache</see>&amp;quot;).</para><para>To combine multiple signals, you can use <see cref="AbortSignalany"/>, for example, to directly abort a download using either a timeout signal or by calling <see cref="AbortController.Abort"/>.</para>
77+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout"> <em>See also on MDN</em> </seealso></para>
78+
</remarks>
79+
<returns>An <see cref="AbortSignal"/>.The signal will abort with its <see cref="AbortSignal.Reason"/> property set to a <c>TimeoutError</c> <see cref="DOMException"/> on timeout, or an <c>AbortError</c> <see cref="DOMException"/> if the operation was user-triggered.</returns>
80+
</AbortSignalTimeout>
81+
</docs>

‎CSharpToJavaScript/Utils/Docs/absoluteorientationsensor/absoluteorientationsensor.generated.xml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<docs>
2+
<AbsoluteOrientationSensor>
3+
<summary>
4+
The <strong><c>AbsoluteOrientationSensor</c></strong> interface of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Sensor_APIs">Sensor APIs</see> describes the device&amp;apos;s physical orientation in relation to the Earth&amp;apos;s reference coordinate system.
5+
</summary>
6+
<remarks>
7+
<para>To use this sensor, the user must grant permission to the <c>&amp;apos;accelerometer&amp;apos;</c>, <c>&amp;apos;gyroscope&amp;apos;</c>, and <c>&amp;apos;magnetometer&amp;apos;</c> device sensors through the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API">Permissions API</see>.</para><para>This feature may be blocked by a <see href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Permissions_Policy">Permissions Policy</see> set on your server.</para><para></para>
8+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbsoluteOrientationSensor"> <em>See also on MDN</em> </seealso></para>
9+
</remarks>
10+
</AbsoluteOrientationSensor>
11+
<AbsoluteOrientationSensorAbsoluteOrientationSensor>
12+
<summary>
13+
The <strong><c>AbsoluteOrientationSensor()</c></strong> constructor creates a new <see cref="AbsoluteOrientationSensor"/> object which describes the device's physical orientation in relation to the Earth's reference coordinate system.
14+
</summary>
15+
<remarks>
16+
<para>-<see cref="'sensor.Reading'"/> event<br/></para>
17+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbsoluteOrientationSensor/AbsoluteOrientationSensor"> <em>See also on MDN</em> </seealso></para>
18+
</remarks>
19+
</AbsoluteOrientationSensorAbsoluteOrientationSensor>
20+
</docs>

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<docs>
2+
<AbstractRange>
3+
<summary>
4+
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.
5+
</summary>
6+
<remarks>
7+
<blockquote class="NOTE"><h5>NOTE</h5><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>
8+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange"> <em>See also on MDN</em> </seealso></para>
9+
</remarks>
10+
</AbstractRange>
11+
<AbstractRangeEndContainer>
12+
<summary>
13+
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.
14+
</summary>
15+
<remarks>
16+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/endContainer"> <em>See also on MDN</em> </seealso></para>
17+
</remarks>
18+
<value>The <see cref="Node"/> which contains the last character of the range.</value>
19+
</AbstractRangeEndContainer>
20+
<AbstractRangeStartContainer>
21+
<summary>
22+
The read-only <strong><c>startContainer</c></strong> property of the <see cref="AbstractRange"/> interface returns the start <see cref="Node"/> for the range.
23+
</summary>
24+
<remarks>
25+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/startContainer"> <em>See also on MDN</em> </seealso></para>
26+
</remarks>
27+
<value>The <see cref="Node"/> inside which the start position of the range is found.</value>
28+
</AbstractRangeStartContainer>
29+
<AbstractRangeEndOffset>
30+
<summary>
31+
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.
32+
</summary>
33+
<remarks>
34+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/endOffset"> <em>See also on MDN</em> </seealso></para>
35+
</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>
37+
</AbstractRangeEndOffset>
38+
<AbstractRangeCollapsed>
39+
<summary>
40+
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.
41+
</summary>
42+
<remarks>
43+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/collapsed"> <em>See also on MDN</em> </seealso></para>
44+
</remarks>
45+
<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>
46+
</AbstractRangeCollapsed>
47+
<AbstractRangeStartOffset>
48+
<summary>
49+
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.
50+
</summary>
51+
<remarks>
52+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbstractRange/startOffset"> <em>See also on MDN</em> </seealso></para>
53+
</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>
55+
</AbstractRangeStartOffset>
56+
</docs>

‎CSharpToJavaScript/Utils/Docs/accelerometer/accelerometer.generated.xml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<docs>
2+
<Accelerometer>
3+
<summary>
4+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>Accelerometer</c></strong> interface of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Sensor_APIs">Sensor APIs</see> provides on each reading the acceleration applied to the device along all three axes.
5+
</summary>
6+
<remarks>
7+
<para>To use this sensor, the user must grant permission to the <c>&amp;apos;accelerometer&amp;apos;</c>, device sensor through the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API">Permissions API</see>.</para><para>This feature may be blocked by a <see href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Permissions_Policy">Permissions Policy</see> set on your server.</para><para></para>
8+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer"> <em>See also on MDN</em> </seealso></para>
9+
</remarks>
10+
</Accelerometer>
11+
<AccelerometerAccelerometer>
12+
<summary>
13+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>Accelerometer()</c></strong> constructor creates a new <see cref="Accelerometer"/> object which returns the acceleration of the device along all three axes at the time it is read.
14+
</summary>
15+
<remarks>
16+
<para>-<see cref="'sensor.Reading'"/> event<br/></para>
17+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/Accelerometer"> <em>See also on MDN</em> </seealso></para>
18+
</remarks>
19+
</AccelerometerAccelerometer>
20+
<AccelerometerX>
21+
<summary>
22+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>x</c></strong> read-only property of the <see cref="Accelerometer"/> interface returns a number specifying the acceleration of the device along its x-axis.
23+
</summary>
24+
<remarks>
25+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/x"> <em>See also on MDN</em> </seealso></para>
26+
</remarks>
27+
<value>A <see cref="'Number'"/>.</value>
28+
</AccelerometerX>
29+
<AccelerometerZ>
30+
<summary>
31+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>z</c></strong> read-only property of the <see cref="Accelerometer"/> interface returns a number specifying the acceleration of the device along its z-axis.
32+
</summary>
33+
<remarks>
34+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/z"> <em>See also on MDN</em> </seealso></para>
35+
</remarks>
36+
<value>A <see cref="'Number'"/>.</value>
37+
</AccelerometerZ>
38+
<AccelerometerY>
39+
<summary>
40+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>y</c></strong> read-only property of the <see cref="Accelerometer"/> interface returns a number specifying the acceleration of the device along its y-axis.
41+
</summary>
42+
<remarks>
43+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/y"> <em>See also on MDN</em> </seealso></para>
44+
</remarks>
45+
<value>A <see cref="'Number'"/>.</value>
46+
</AccelerometerY>
47+
</docs>

‎CSharpToJavaScript/Utils/Docs/aescbcparams/aescbcparams.generated.xml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<docs>
2+
<AesCbcParams>
3+
<summary>
4+
The <strong><c>AesCbcParams</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-cbc">AES-CBC</see> algorithm.
5+
</summary>
6+
<remarks>
7+
<para>-CBC mode is defined in section 6.2 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>
8+
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AesCbcParams"> <em>See also on MDN</em> </seealso></para>
9+
</remarks>
10+
</AesCbcParams>
11+
</docs>

0 commit comments

Comments
 (0)