Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various dl api #8484

Merged
merged 2 commits into from
Aug 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions files/en-us/web/api/analysernode/analysernode/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,16 @@ <h3 id="Parameters">Parameters</h3>
<dd>A reference to an {{domxref("AudioContext")}} or {{domxref("OfflineAudioContext")}}.</dd>
<dt><em>options</em> {{optional_inline}}</dt>
<dd>
<ul>
<li><strong><code>fftSize</code></strong>: The desired initial size of the <a href="https://en.wikipedia.org/wiki/Fast_Fourier_transform">FFT</a> for <a href="https://en.wikipedia.org/wiki/Frequency_domain">frequency-domain</a> analysis. <br>
The default is <code>2048</code>.</li>
<li><strong><code>maxDecibels</code></strong>: The desired initial maximum power in <a href="https://en.wikipedia.org/wiki/Decibel">dB</a> for FFT analysis.<br>
The default is <code>-30</code>.</li>
<li><strong><code>minDecibels</code></strong>: The desired initial minimum power in dB for FFT analysis.<br>
The default is <code>-100</code>.</li>
<li><strong><code>smoothingTimeConstant</code></strong>: The desired initial smoothing constant for the FFT analysis. The default is <code>0.8</code>.</li>
</ul>
<p>An object with the following properties, all optional:</p>
<ul>
<li><strong><code>fftSize</code></strong>: The desired initial size of the <a href="https://en.wikipedia.org/wiki/Fast_Fourier_transform">FFT</a> for <a href="https://en.wikipedia.org/wiki/Frequency_domain">frequency-domain</a> analysis. <br>
The default is <code>2048</code>.</li>
<li><strong><code>maxDecibels</code></strong>: The desired initial maximum power in <a href="https://en.wikipedia.org/wiki/Decibel">dB</a> for FFT analysis.<br>
The default is <code>-30</code>.</li>
<li><strong><code>minDecibels</code></strong>: The desired initial minimum power in dB for FFT analysis.<br>
The default is <code>-100</code>.</li>
<li><strong><code>smoothingTimeConstant</code></strong>: The desired initial smoothing constant for the FFT analysis. The default is <code>0.8</code>.</li>
</ul>
</dd>
</dl>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,19 @@ <h3 id="Exceptions">Exceptions</h3>
<dl>
<dt><code>NotSupportedError</code></dt>
<dd>
<p>Thrown under the following conditions:</p>
<ul>
<li>The <em>name</em> is an empty string, or</li>
<li>a constructor under the given <em>name</em> is already registered. Registering
<li>The <em>name</em> is an empty string.</li>
<li>A constructor under the given <em>name</em> is already registered. Registering
the same name twice is not allowed.</li>
</ul>
</dd>
<dt><code>TypeError</code></dt>
<dd>
<p>Thrown under the following conditions:</p>
<ul>
<li>The <em>processorCtor</em> is not a callable constructor, or</li>
<li>the {{domxref("AudioWorkletProcessor.parameterDescriptors",
<li>The <em>processorCtor</em> is not a callable constructor.</li>
<li>The {{domxref("AudioWorkletProcessor.parameterDescriptors",
"parameterDescriptors")}} property of the constructor exists and doesn't return an
array of {{domxref("AudioParamDescriptor")}}-based objects.</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/caretposition/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ <h2 id="Methods">Methods</h2>

<dl>
<dt>{{domxref("CaretPosition.getClientRect")}}</dt>
<dd></dd>
<dd>Returns the client rectangle for the caret range.</dd>
</dl>

<h2 id="Specifications">Specifications</h2>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/cssgroupingrule/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h2 id="Properties">Properties</h2>
<p><em>This interface also inherits properties from {{domxref("CSSRule")}}.</em></p>

<dl>
<dt">{{domxref("CSSGroupingRule.cssRules")}}{{readonlyinline}}</dt>
<dt>{{domxref("CSSGroupingRule.cssRules")}}{{readonlyinline}}</dt>
<dd>Returns a {{domxref("CSSRuleList")}} of the CSS rules in the media rule.</dd>
</dl>

Expand Down
7 changes: 2 additions & 5 deletions files/en-us/web/api/datatransfer/mozcleardataat/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,7 @@ <h3 id="Arguments">Arguments</h3>

<h3 id="Return_Value">Return value</h3>

<dl>
<dt>void</dt>
<dd></dd>
</dl>
<p>None.</p>

<h2 id="Example">Example</h2>

Expand Down Expand Up @@ -79,4 +76,4 @@ <h2 id="See_also">See also</h2>
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types">Recommended Drag Types</a></li>
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Multiple_items">Dragging and Dropping Multiple Items</a></li>
<li><a href="https://codepen.io/tech_query/pen/MqGgap">DataTransfer test - Paste or Drag</a></li>
</ul>
</ul>
7 changes: 2 additions & 5 deletions files/en-us/web/api/datatransfer/mozsetdataat/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,7 @@ <h3 id="Arguments">Arguments</h3>

<h3 id="Return_Value">Return value</h3>

<dl>
<dt>void</dt>
<dd></dd>
</dl>
<p>None.</p>

<h2 id="Example">Example</h2>

Expand Down Expand Up @@ -93,4 +90,4 @@ <h2 id="See_also">See also</h2>
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types">Recommended Drag Types</a></li>
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Multiple_items">Dragging and Dropping Multiple Items</a></li>
<li><a href="https://codepen.io/tech_query/pen/MqGgap">DataTransfer test - Paste or Drag</a></li>
</ul>
</ul>
7 changes: 2 additions & 5 deletions files/en-us/web/api/datatransfer/setdata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,7 @@ <h3 id="Arguments">Arguments</h3>

<h3 id="Return_value">Return value</h3>

<dl>
<dt>void</dt>
<dd></dd>
</dl>
<p>None.</p>

<h2 id="Example">Example</h2>

Expand Down Expand Up @@ -120,4 +117,4 @@ <h2 id="See_also">See also</h2>
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types">Recommended Drag Types</a></li>
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Multiple_items">Dragging and Dropping Multiple Items</a></li>
<li><a href="https://codepen.io/tech_query/pen/MqGgap">DataTransfer test - Paste or Drag</a></li>
</ul>
</ul>
5 changes: 1 addition & 4 deletions files/en-us/web/api/datatransfer/setdragimage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,7 @@ <h3 id="Arguments">Arguments</h3>

<h3 id="Return_Value">Return value</h3>

<dl>
<dt>void</dt>
<dd></dd>
</dl>
<p>None.</p>

<h2 id="Example">Example</h2>

Expand Down
6 changes: 2 additions & 4 deletions files/en-us/web/api/elementinternals/setvalidity/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h3 id="Parameters">Parameters</h3>
<dl>
<dt><code>flags</code>{{Optional_Inline}}</dt>
<dd>A dictionary object containing one or more flags indicating the validity state of the element:
<ul>
<dl>
<dt><code>valueMissing</code></dt>
<dd>A boolean value that is <code>true</code> if the element has a {{htmlattrxref("required", "input")}} attribute, but no value, or <code>false</code> otherwise. If <code>true</code>, the element matches the {{cssxref(":invalid")}} CSS pseudo-class.</dd>
<dt><code>typeMismatch</code></dt>
Expand All @@ -45,7 +45,7 @@ <h3 id="Parameters">Parameters</h3>
<dd>A boolean value that is <code>true</code> if the user has provided input that the browser is unable to convert.</dd>
<dt><code>customError</code></dt>
<dd>A boolean value indicating whether the element's custom validity message has been set to a non-empty string by calling the element's {{domxref('HTMLObjectElement.setCustomValidity', 'setCustomValidity()')}} method.</dd>
</ul>
</dl>

<div class="notecard note">
<p><strong>Note:</strong> To set all flags to <code>false</code>, indicating that this element passes all constraints validation, pass in an empty object <code>{}</code>. In this case, you do not need to also pass a <code>message</code>.</p>
Expand Down Expand Up @@ -89,5 +89,3 @@ <h2 id="Specifications">Specifications</h2>
<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat}}</p>


16 changes: 5 additions & 11 deletions files/en-us/web/api/fileentrysync/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,15 @@ <h3 id="createWriter">createWriter()</h3>
<pre>void createWriter (
) raises (<a href="/en-US/docs/Web/API/FileException">FileException</a>);</pre>

<h5 id="Parameter">Parameter</h5>
<h4 id="Parameter">Parameter</h4>

<p>None.</p>

<h5 id="Returns">Returns</h5>
<h4 id="Returns">Returns</h4>

<dl>
<dt><code>FileWriterSync</code></dt>
<dd></dd>
</dl>
<p>A <code>FileWriterSync</code> object.</p>

<h5 id="Exceptions">Exceptions</h5>
<h4 id="Exceptions">Exceptions</h4>

<p>This method can raise a <a href="/en-US/docs/Web/API/FileException">FileException</a> with the following codes:</p>

Expand Down Expand Up @@ -95,10 +92,7 @@ <h5 id="Parameter_2">Parameter</h5>

<h5 id="Returns_2">Returns</h5>

<dl>
<dt><code>File</code></dt>
<dd></dd>
</dl>
<p>A <code>File</code> object.</p>

<h5 id="Exceptions_2">Exceptions</h5>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ <h3 id="Parameters">Parameters</h3>
the file you wish to retrieve.</dd>
<dt><em>options</em> {{optional_inline}}</dt>
<dd>
<p>An object with the following properties:</p>
<ul>
<li><code>create</code>: A {{jsxref('Boolean')}}. Default <code>false</code>. When
set to <code>true</code> if the file is not found, one with the specified name
Expand Down
61 changes: 23 additions & 38 deletions files/en-us/web/api/filesystementrysync/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,15 @@ <h3 id="getMetadata">getMetadata()</h3>
<pre>Metadata getMetada ()
raises <code>(<a href="/en-US/docs/Web/API/FileException">FileException</a>)</code>;</pre>

<h5 id="Parameter">Parameter</h5>
<h4 id="Parameter">Parameter</h4>

<p>None</p>

<h5 id="Returns">Returns</h5>
<h4 id="Returns">Returns</h4>

<dl>
<dt><code>Metadata</code></dt>
<dd></dd>
</dl>
<p>A <code>Metadata</code> object.</p>

<h5 id="Exceptions">Exceptions</h5>
<h4 id="Exceptions">Exceptions</h4>

<p>This method can raise a <a href="/en-US/docs/Web/API/FileException">FileException</a> with the following codes:</p>

Expand Down Expand Up @@ -161,7 +158,7 @@ <h3 id="moveTo">moveTo()</h3>
in DirectoryEntrySync <em>parent</em>, optional DOMString <em>newName</em>
) raises (<a href="/en-US/docs/Web/API/FileException">FileException</a>);</pre>

<h5 id="Parameters">Parameters</h5>
<h4 id="Parameters">Parameters</h4>

<dl>
<dt>parent</dt>
Expand All @@ -170,14 +167,11 @@ <h5 id="Parameters">Parameters</h5>
<dd>The new name of the entry. If you do not specify a name, the browser preserves the entry's current name.</dd>
</dl>

<h5 id="Returns_2">Returns</h5>
<h4 id="Returns_2">Returns</h4>

<dl>
<dt><code>FileSystemEntrySync</code></dt>
<dd>An object that represents an entry in the file system.</dd>
</dl>
<p>A <code>FileSystemEntrySync</code> object.</p>

<h5 id="Exceptions_2">Exceptions</h5>
<h4 id="Exceptions_2">Exceptions</h4>

<p>This method can raise a <a href="/en-US/docs/Web/API/FileException">FileException</a> with the following codes:</p>

Expand Down Expand Up @@ -223,7 +217,7 @@ <h3 id="copyTo">copyTo()</h3>
in DirectoryEntrySync <em>parent</em>, optional DOMString <em>newName</em>
) raises (<a href="/en-US/docs/Web/API/FileException">FileException</a>);</pre>

<h5 id="Parameters_2">Parameters</h5>
<h4 id="Parameters_2">Parameters</h4>

<dl>
<dt>parent</dt>
Expand All @@ -232,14 +226,11 @@ <h5 id="Parameters_2">Parameters</h5>
<dd>The new name of the entry. If you do not specify a name, the browser preserves the FileSystemEntrySync's current name.</dd>
</dl>

<h5 id="Returns_3">Returns</h5>
<h4 id="Returns_3">Returns</h4>

<dl>
<dt><code>FileSystemEntrySync</code></dt>
<dd>An object that represents an entry in the file system.</dd>
</dl>
<p>A <code>FileSystemEntrySync</code> object.</p>

<h5 id="Exceptions_3">Exceptions</h5>
<h4 id="Exceptions_3">Exceptions</h4>

<p>This method can raise a <a href="/en-US/docs/Web/API/FileException">FileException</a> with the following codes:</p>

Expand Down Expand Up @@ -291,18 +282,15 @@ <h3 id="toURL">toURL()</h3>

<pre>DOMString toURL ();</pre>

<h5 id="Parameter_2">Parameter</h5>
<h4 id="Parameter_2">Parameter</h4>

<p>None.</p>

<h5 id="Returns_4">Returns</h5>
<h4 id="Returns_4">Returns</h4>

<dl>
<dt><code>DOMString</code></dt>
<dd></dd>
</dl>
<p>A <code>DOMString</code> object.</p>

<h5 id="Exceptions_4">Exceptions</h5>
<h4 id="Exceptions_4">Exceptions</h4>

<p>None</p>

Expand All @@ -313,18 +301,15 @@ <h3 id="remove">remove()</h3>
<pre>void remove (
) raises (<a href="/en-US/docs/Web/API/FileException">FileException</a>);</pre>

<h5 id="Parameter_3">Parameter</h5>
<h4 id="Parameter_3">Parameter</h4>

<p>None</p>

<h5 id="Returns_5">Returns</h5>
<h4 id="Returns_5">Returns</h4>

<dl>
<dt><code>void</code></dt>
<dd></dd>
</dl>
<p>None.</p>

<h5 id="Exceptions_5">Exceptions</h5>
<h4 id="Exceptions_5">Exceptions</h4>

<p>This method can raise a <a href="/en-US/docs/Web/API/FileException">FileException</a> with the following codes:</p>

Expand Down Expand Up @@ -359,18 +344,18 @@ <h3 id="getParent">getParent()</h3>

<pre>void getParent ();</pre>

<h5 id="Parameter_4">Parameter</h5>
<h4 id="Parameter_4">Parameter</h4>

<p>None</p>

<h5 id="Returns_6">Returns</h5>
<h4 id="Returns_6">Returns</h4>

<dl>
<dt><code><a href="/en-US/docs/Web/API/DirectoryEntrySync">DirectoryEntrySync</a></code></dt>
<dd>An object that represents a directory in the file system.</dd>
</dl>

<h5 id="Exceptions_6">Exceptions</h5>
<h4 id="Exceptions_6">Exceptions</h4>

<p>None.</p>

Expand Down
21 changes: 9 additions & 12 deletions files/en-us/web/api/html_dom_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -439,21 +439,18 @@ <h2 id="Browser_compatibility">Browser compatibility</h2>

<h2 id="See_also">See also</h2>

<dl>
<dt>References</dt>
<dd>
<ul>
<h3>References</h3>

<ul>
<li><a href="/en-US/docs/Web/HTML/Element">HTML elements reference</a></li>
<li><a href="/en-US/docs/Web/HTML/Attributes">HTML attribute reference</a></li>
<li>{{DOMxRef("Document_Object_Model", "Document Object Model (DOM)", "", "1")}} reference</li>
</ul>
</dd>
<dt>Guides</dt>
<dd>
<ul>
</ul>

<h3>Guides</h3>

<ul>
<li>
<p><a href="/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Manipulating_documents">Manipulating documents</a>: A beginner's guide to manipulating the DOM.</p>
</li>
</ul>
</dd>
</dl>
</ul>
Loading