Skip to content

Commit 911a50a

Browse files
committed
Updated generated docs.
See GenDocsLib.
1 parent 7bef6ad commit 911a50a

File tree

2,011 files changed

+2341
-2092
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,011 files changed

+2341
-2092
lines changed

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><para>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 class="NOTE"><h5>NOTE</h5><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><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>
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>
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/Accelerometer/Accelerometer.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<Accelerometer>
33
<summary>
4-
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.
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.
55
</summary>
66
<remarks>
77
<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/Permissions_Policy">Permissions Policy</see> set on your server.</para><para></para>

CSharpToJavaScript/Utils/Docs/AccelerometerAccelerometer/AccelerometerAccelerometer.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AccelerometerAccelerometer>
33
<summary>
4-
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.
4+
<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.
55
</summary>
66
<remarks>
77
<para>-<see cref="'sensor.Reading_event'"/> event<br/></para>

CSharpToJavaScript/Utils/Docs/AccelerometerX/AccelerometerX.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AccelerometerX>
33
<summary>
4-
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.
4+
<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.
55
</summary>
66
<remarks>
77
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/x"> <em>See also on MDN</em> </seealso></para>

CSharpToJavaScript/Utils/Docs/AccelerometerY/AccelerometerY.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AccelerometerY>
33
<summary>
4-
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.
4+
<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.
55
</summary>
66
<remarks>
77
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/y"> <em>See also on MDN</em> </seealso></para>

CSharpToJavaScript/Utils/Docs/AccelerometerZ/AccelerometerZ.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AccelerometerZ>
33
<summary>
4-
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.
4+
<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.
55
</summary>
66
<remarks>
77
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/Accelerometer/z"> <em>See also on MDN</em> </seealso></para>

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><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>
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>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/Ambientlightsensor/Ambientlightsensor.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AmbientLightSensor>
33
<summary>
4-
The <strong><c>AmbientLightSensor</c></strong> interface of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Sensor_APIs">Sensor APIs</see> returns the current light level or illuminance of the ambient light around the hosting device.
4+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>AmbientLightSensor</c></strong> interface of the <see href="https://developer.mozilla.org/en-US/docs/Web/API/Sensor_APIs">Sensor APIs</see> returns the current light level or illuminance of the ambient light around the hosting device.
55
</summary>
66
<remarks>
77
<para>To use this sensor, the user must grant permission to the <c>&amp;apos;ambient-light-sensor&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/Permissions_Policy">Permissions Policy</see> set on your server.</para><para></para>

CSharpToJavaScript/Utils/Docs/AmbientlightsensorAmbientlightsensor/AmbientlightsensorAmbientlightsensor.generated.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AmbientLightSensorAmbientLightSensor>
33
<summary>
4-
The <strong><c>AmbientLightSensor()</c></strong> constructor creates a new <see cref="AmbientLightSensor"/> object, which returns the current light level or illuminance of the ambient light around the hosting device.
4+
<div class="NOTE"><h5>NOTE</h5> <strong>Experimental</strong></div> The <strong><c>AmbientLightSensor()</c></strong> constructor creates a new <see cref="AmbientLightSensor"/> object, which returns the current light level or illuminance of the ambient light around the hosting device.
55
</summary>
66
<remarks>
77
<para>-<see cref="'sensor.Reading_event'"/> event<br/></para>

0 commit comments

Comments
 (0)