Skip to content

Commit 242962e

Browse files
TiLiedTiLied
committed
Updated generated xml docs with a fixed bug.
See: TiLied/GenDocsLib@258677e
1 parent 6715097 commit 242962e

File tree

5,261 files changed

+9352
-9352
lines changed

Some content is hidden

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

5,261 files changed

+9352
-9352
lines changed

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AbortControllerAbortController>
33
<summary>
4-
The <strong><c>AbortController()</c></strong> constructor creates a new <see cref="AbortController."/> object instance.
4+
The <strong><c>AbortController()</c></strong> constructor creates a new <see cref="AbortController"/> object instance.
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/AbortcontrollerSignal/AbortcontrollerSignal.generated.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<docs>
22
<AbortControllerSignal>
33
<summary>
4-
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.
4+
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.
55
</summary>
66
<remarks>
77
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
88
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal"> <em>See also on MDN</em> </seealso></para>
99
</remarks>
10-
<value>An <see cref="AbortSignal."/> object instance.</value>
10+
<value>An <see cref="AbortSignal"/> object instance.</value>
1111
</AbortControllerSignal>
1212
</docs>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<docs>
22
<AbortSignal>
33
<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.
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.
55
</summary>
66
<remarks>
77
<para></para>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<docs>
22
<AbortSignalAbort>
33
<summary>
4-
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).
4+
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>
77
<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>
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>
10-
<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>
10+
<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>
1111
</AbortSignalAbort>
1212
</docs>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<docs>
22
<AbortSignalAny>
33
<summary>
4-
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."/>.
4+
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"/>.
55
</summary>
66
<remarks>
77
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/any"> <em>See also on MDN</em> </seealso></para>
88
</remarks>
9-
<returns>A <see cref="AbortSignal."/> that is:</returns>
9+
<returns>A <see cref="AbortSignal"/> that is:</returns>
1010
</AbortSignalAny>
1111
</docs>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The <strong><c>reason</c></strong> read-only property returns a JavaScript value that indicates the abort reason.
55
</summary>
66
<remarks>
7-
<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="AbortSignal/abort_static."/>.<br/>If not explicitly set in those methods, it defaults to "AbortError" <see cref="DOMException."/>.</para>
7+
<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="AbortSignal/abort_static"/>.<br/>If not explicitly set in those methods, it defaults to "AbortError" <see cref="DOMException"/>.</para>
88
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/reason"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<docs>
22
<AbortSignalThrowIfAborted>
33
<summary>
4-
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.
4+
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.
55
</summary>
66
<remarks>
7-
<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>
7+
<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>
88
<para>-<see href="https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API">Fetch API</see><br/></para>
99
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/throwIfAborted"> <em>See also on MDN</em> </seealso></para>
1010
</remarks>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<docs>
22
<AbortSignalTimeout>
33
<summary>
4-
The <strong><c>AbortSignal.timeout()</c></strong> static method returns an <see cref="AbortSignal."/> that will automatically abort after a specified time.
4+
The <strong><c>AbortSignal.timeout()</c></strong> static method returns an <see cref="AbortSignal"/> that will automatically abort after a specified time.
55
</summary>
66
<remarks>
7-
<para>The signal aborts with a <c>TimeoutError</c> <see cref="DOMException."/> on timeout, or with <c>AbortError</c> <see cref="DOMException."/> due to pressing a browser stop button (or some other inbuilt "stop" operation).<br/>This allows UIs to differentiate timeout errors, which typically require user notification, from user-triggered aborts that do not.</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="AbortSignal/any_static."/>, for example, to directly abort a download using either a timeout signal or by calling <see cref="AbortController.Abort."/>.</para>
7+
<para>The signal aborts with a <c>TimeoutError</c> <see cref="DOMException"/> on timeout, or with <c>AbortError</c> <see cref="DOMException"/> due to pressing a browser stop button (or some other inbuilt "stop" operation).<br/>This allows UIs to differentiate timeout errors, which typically require user notification, from user-triggered aborts that do not.</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="AbortSignal/any_static"/>, for example, to directly abort a download using either a timeout signal or by calling <see cref="AbortController.Abort"/>.</para>
88
<para><seealso href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout"> <em>See also on MDN</em> </seealso></para>
99
</remarks>
10-
<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>
10+
<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>
1111
</AbortSignalTimeout>
1212
</docs>

0 commit comments

Comments
 (0)