Skip to content

Commit 80db592

Browse files
wbambergwbamberg
authored
Fix various dl api (#8484)
* Fix various unconvertible dl elements in Web/API * Fix a few stragglers
1 parent aae7f23 commit 80db592

File tree

25 files changed

+102
-152
lines changed

25 files changed

+102
-152
lines changed

‎files/en-us/web/api/analysernode/analysernode/index.html

+10-9
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,16 @@ <h3 id="Parameters">Parameters</h3>
2828
<dd>A reference to an {{domxref("AudioContext")}} or {{domxref("OfflineAudioContext")}}.</dd>
2929
<dt><em>options</em> {{optional_inline}}</dt>
3030
<dd>
31-
<ul>
32-
<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>
33-
The default is <code>2048</code>.</li>
34-
<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>
35-
The default is <code>-30</code>.</li>
36-
<li><strong><code>minDecibels</code></strong>: The desired initial minimum power in dB for FFT analysis.<br>
37-
The default is <code>-100</code>.</li>
38-
<li><strong><code>smoothingTimeConstant</code></strong>: The desired initial smoothing constant for the FFT analysis. The default is <code>0.8</code>.</li>
39-
</ul>
31+
<p>An object with the following properties, all optional:</p>
32+
<ul>
33+
<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>
34+
The default is <code>2048</code>.</li>
35+
<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>
36+
The default is <code>-30</code>.</li>
37+
<li><strong><code>minDecibels</code></strong>: The desired initial minimum power in dB for FFT analysis.<br>
38+
The default is <code>-100</code>.</li>
39+
<li><strong><code>smoothingTimeConstant</code></strong>: The desired initial smoothing constant for the FFT analysis. The default is <code>0.8</code>.</li>
40+
</ul>
4041
</dd>
4142
</dl>
4243

‎files/en-us/web/api/audioworkletglobalscope/registerprocessor/index.html

+6-4
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,19 @@ <h3 id="Exceptions">Exceptions</h3>
4848
<dl>
4949
<dt><code>NotSupportedError</code></dt>
5050
<dd>
51+
<p>Thrown under the following conditions:</p>
5152
<ul>
52-
<li>The <em>name</em> is an empty string, or</li>
53-
<li>a constructor under the given <em>name</em> is already registered. Registering
53+
<li>The <em>name</em> is an empty string.</li>
54+
<li>A constructor under the given <em>name</em> is already registered. Registering
5455
the same name twice is not allowed.</li>
5556
</ul>
5657
</dd>
5758
<dt><code>TypeError</code></dt>
5859
<dd>
60+
<p>Thrown under the following conditions:</p>
5961
<ul>
60-
<li>The <em>processorCtor</em> is not a callable constructor, or</li>
61-
<li>the {{domxref("AudioWorkletProcessor.parameterDescriptors",
62+
<li>The <em>processorCtor</em> is not a callable constructor.</li>
63+
<li>The {{domxref("AudioWorkletProcessor.parameterDescriptors",
6264
"parameterDescriptors")}} property of the constructor exists and doesn't return an
6365
array of {{domxref("AudioParamDescriptor")}}-based objects.</li>
6466
</ul>

‎files/en-us/web/api/caretposition/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h2 id="Methods">Methods</h2>
2828

2929
<dl>
3030
<dt>{{domxref("CaretPosition.getClientRect")}}</dt>
31-
<dd></dd>
31+
<dd>Returns the client rectangle for the caret range.</dd>
3232
</dl>
3333

3434
<h2 id="Specifications">Specifications</h2>

‎files/en-us/web/api/cssgroupingrule/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ <h2 id="Properties">Properties</h2>
1717
<p><em>This interface also inherits properties from {{domxref("CSSRule")}}.</em></p>
1818

1919
<dl>
20-
<dt">{{domxref("CSSGroupingRule.cssRules")}}{{readonlyinline}}</dt>
20+
<dt>{{domxref("CSSGroupingRule.cssRules")}}{{readonlyinline}}</dt>
2121
<dd>Returns a {{domxref("CSSRuleList")}} of the CSS rules in the media rule.</dd>
2222
</dl>
2323

‎files/en-us/web/api/datatransfer/mozcleardataat/index.html

+2-5
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,7 @@ <h3 id="Arguments">Arguments</h3>
4545

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

48-
<dl>
49-
<dt>void</dt>
50-
<dd></dd>
51-
</dl>
48+
<p>None.</p>
5249

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

@@ -79,4 +76,4 @@ <h2 id="See_also">See also</h2>
7976
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types">Recommended Drag Types</a></li>
8077
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Multiple_items">Dragging and Dropping Multiple Items</a></li>
8178
<li><a href="https://codepen.io/tech_query/pen/MqGgap">DataTransfer test - Paste or Drag</a></li>
82-
</ul>
79+
</ul>

‎files/en-us/web/api/datatransfer/mozsetdataat/index.html

+2-5
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@ <h3 id="Arguments">Arguments</h3>
5555

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

58-
<dl>
59-
<dt>void</dt>
60-
<dd></dd>
61-
</dl>
58+
<p>None.</p>
6259

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

@@ -93,4 +90,4 @@ <h2 id="See_also">See also</h2>
9390
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types">Recommended Drag Types</a></li>
9491
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Multiple_items">Dragging and Dropping Multiple Items</a></li>
9592
<li><a href="https://codepen.io/tech_query/pen/MqGgap">DataTransfer test - Paste or Drag</a></li>
96-
</ul>
93+
</ul>

‎files/en-us/web/api/datatransfer/setdata/index.html

+2-5
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,7 @@ <h3 id="Arguments">Arguments</h3>
4040

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

43-
<dl>
44-
<dt>void</dt>
45-
<dd></dd>
46-
</dl>
43+
<p>None.</p>
4744

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

@@ -120,4 +117,4 @@ <h2 id="See_also">See also</h2>
120117
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Recommended_drag_types">Recommended Drag Types</a></li>
121118
<li><a href="/en-US/docs/Web/API/HTML_Drag_and_Drop_API/Multiple_items">Dragging and Dropping Multiple Items</a></li>
122119
<li><a href="https://codepen.io/tech_query/pen/MqGgap">DataTransfer test - Paste or Drag</a></li>
123-
</ul>
120+
</ul>

‎files/en-us/web/api/datatransfer/setdragimage/index.html

+1-4
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,7 @@ <h3 id="Arguments">Arguments</h3>
4949

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

52-
<dl>
53-
<dt>void</dt>
54-
<dd></dd>
55-
</dl>
52+
<p>None.</p>
5653

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

‎files/en-us/web/api/elementinternals/setvalidity/index.html

+2-4
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h3 id="Parameters">Parameters</h3>
2424
<dl>
2525
<dt><code>flags</code>{{Optional_Inline}}</dt>
2626
<dd>A dictionary object containing one or more flags indicating the validity state of the element:
27-
<ul>
27+
<dl>
2828
<dt><code>valueMissing</code></dt>
2929
<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>
3030
<dt><code>typeMismatch</code></dt>
@@ -45,7 +45,7 @@ <h3 id="Parameters">Parameters</h3>
4545
<dd>A boolean value that is <code>true</code> if the user has provided input that the browser is unable to convert.</dd>
4646
<dt><code>customError</code></dt>
4747
<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>
48-
</ul>
48+
</dl>
4949

5050
<div class="notecard note">
5151
<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>
@@ -89,5 +89,3 @@ <h2 id="Specifications">Specifications</h2>
8989
<h2 id="Browser_compatibility">Browser compatibility</h2>
9090

9191
<p>{{Compat}}</p>
92-
93-

‎files/en-us/web/api/fileentrysync/index.html

+5-11
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,15 @@ <h3 id="createWriter">createWriter()</h3>
4848
<pre>void createWriter (
4949
) raises (<a href="/en-US/docs/Web/API/FileException">FileException</a>);</pre>
5050

51-
<h5 id="Parameter">Parameter</h5>
51+
<h4 id="Parameter">Parameter</h4>
5252

5353
<p>None.</p>
5454

55-
<h5 id="Returns">Returns</h5>
55+
<h4 id="Returns">Returns</h4>
5656

57-
<dl>
58-
<dt><code>FileWriterSync</code></dt>
59-
<dd></dd>
60-
</dl>
57+
<p>A <code>FileWriterSync</code> object.</p>
6158

62-
<h5 id="Exceptions">Exceptions</h5>
59+
<h4 id="Exceptions">Exceptions</h4>
6360

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

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

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

98-
<dl>
99-
<dt><code>File</code></dt>
100-
<dd></dd>
101-
</dl>
95+
<p>A <code>File</code> object.</p>
10296

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

‎files/en-us/web/api/filesystemdirectoryhandle/getfilehandle/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ <h3 id="Parameters">Parameters</h3>
3030
the file you wish to retrieve.</dd>
3131
<dt><em>options</em> {{optional_inline}}</dt>
3232
<dd>
33+
<p>An object with the following properties:</p>
3334
<ul>
3435
<li><code>create</code>: A {{jsxref('Boolean')}}. Default <code>false</code>. When
3536
set to <code>true</code> if the file is not found, one with the specified name

‎files/en-us/web/api/filesystementrysync/index.html

+23-38
Original file line numberDiff line numberDiff line change
@@ -108,18 +108,15 @@ <h3 id="getMetadata">getMetadata()</h3>
108108
<pre>Metadata getMetada ()
109109
raises <code>(<a href="/en-US/docs/Web/API/FileException">FileException</a>)</code>;</pre>
110110

111-
<h5 id="Parameter">Parameter</h5>
111+
<h4 id="Parameter">Parameter</h4>
112112

113113
<p>None</p>
114114

115-
<h5 id="Returns">Returns</h5>
115+
<h4 id="Returns">Returns</h4>
116116

117-
<dl>
118-
<dt><code>Metadata</code></dt>
119-
<dd></dd>
120-
</dl>
117+
<p>A <code>Metadata</code> object.</p>
121118

122-
<h5 id="Exceptions">Exceptions</h5>
119+
<h4 id="Exceptions">Exceptions</h4>
123120

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

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

164-
<h5 id="Parameters">Parameters</h5>
161+
<h4 id="Parameters">Parameters</h4>
165162

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

173-
<h5 id="Returns_2">Returns</h5>
170+
<h4 id="Returns_2">Returns</h4>
174171

175-
<dl>
176-
<dt><code>FileSystemEntrySync</code></dt>
177-
<dd>An object that represents an entry in the file system.</dd>
178-
</dl>
172+
<p>A <code>FileSystemEntrySync</code> object.</p>
179173

180-
<h5 id="Exceptions_2">Exceptions</h5>
174+
<h4 id="Exceptions_2">Exceptions</h4>
181175

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

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

226-
<h5 id="Parameters_2">Parameters</h5>
220+
<h4 id="Parameters_2">Parameters</h4>
227221

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

235-
<h5 id="Returns_3">Returns</h5>
229+
<h4 id="Returns_3">Returns</h4>
236230

237-
<dl>
238-
<dt><code>FileSystemEntrySync</code></dt>
239-
<dd>An object that represents an entry in the file system.</dd>
240-
</dl>
231+
<p>A <code>FileSystemEntrySync</code> object.</p>
241232

242-
<h5 id="Exceptions_3">Exceptions</h5>
233+
<h4 id="Exceptions_3">Exceptions</h4>
243234

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

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

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

294-
<h5 id="Parameter_2">Parameter</h5>
285+
<h4 id="Parameter_2">Parameter</h4>
295286

296287
<p>None.</p>
297288

298-
<h5 id="Returns_4">Returns</h5>
289+
<h4 id="Returns_4">Returns</h4>
299290

300-
<dl>
301-
<dt><code>DOMString</code></dt>
302-
<dd></dd>
303-
</dl>
291+
<p>A <code>DOMString</code> object.</p>
304292

305-
<h5 id="Exceptions_4">Exceptions</h5>
293+
<h4 id="Exceptions_4">Exceptions</h4>
306294

307295
<p>None</p>
308296

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

316-
<h5 id="Parameter_3">Parameter</h5>
304+
<h4 id="Parameter_3">Parameter</h4>
317305

318306
<p>None</p>
319307

320-
<h5 id="Returns_5">Returns</h5>
308+
<h4 id="Returns_5">Returns</h4>
321309

322-
<dl>
323-
<dt><code>void</code></dt>
324-
<dd></dd>
325-
</dl>
310+
<p>None.</p>
326311

327-
<h5 id="Exceptions_5">Exceptions</h5>
312+
<h4 id="Exceptions_5">Exceptions</h4>
328313

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

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

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

362-
<h5 id="Parameter_4">Parameter</h5>
347+
<h4 id="Parameter_4">Parameter</h4>
363348

364349
<p>None</p>
365350

366-
<h5 id="Returns_6">Returns</h5>
351+
<h4 id="Returns_6">Returns</h4>
367352

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

373-
<h5 id="Exceptions_6">Exceptions</h5>
358+
<h4 id="Exceptions_6">Exceptions</h4>
374359

375360
<p>None.</p>
376361

‎files/en-us/web/api/html_dom_api/index.html

+9-12
Original file line numberDiff line numberDiff line change
@@ -439,21 +439,18 @@ <h2 id="Browser_compatibility">Browser compatibility</h2>
439439

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

442-
<dl>
443-
<dt>References</dt>
444-
<dd>
445-
<ul>
442+
<h3>References</h3>
443+
444+
<ul>
446445
<li><a href="/en-US/docs/Web/HTML/Element">HTML elements reference</a></li>
447446
<li><a href="/en-US/docs/Web/HTML/Attributes">HTML attribute reference</a></li>
448447
<li>{{DOMxRef("Document_Object_Model", "Document Object Model (DOM)", "", "1")}} reference</li>
449-
</ul>
450-
</dd>
451-
<dt>Guides</dt>
452-
<dd>
453-
<ul>
448+
</ul>
449+
450+
<h3>Guides</h3>
451+
452+
<ul>
454453
<li>
455454
<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>
456455
</li>
457-
</ul>
458-
</dd>
459-
</dl>
456+
</ul>

0 commit comments

Comments
 (0)