Skip to content

Commit ec515b4

Browse files
hamishwilleehamishwillee
authored
Page macro: RTC* fix example include to links (mdn#7532)
1 parent df35a4e commit ec515b4

File tree

6 files changed

+21
-33
lines changed

6 files changed

+21
-33
lines changed

‎files/en-us/web/api/rtcdtlstransport/state/index.html

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@
1515

1616
<p>The <strong><code>state</code></strong> read-only property of the
1717
{{DOMxRef("RTCDtlsTransport")}} interface provides information which describes a
18-
Datagram Transport Layer Security (<strong>{{Glossary("DTLS")}}</strong>) transport
19-
state.</p>
18+
Datagram Transport Layer Security (<strong>{{Glossary("DTLS")}}</strong>) transport state.</p>
2019

2120
<h2 id="Syntax">Syntax</h2>
2221

23-
<pre
24-
class="brush: js">let <var>myState</var> = <var>dtlsTransport</var>.state;</pre>
22+
<pre class="brush: js">let <var>myState</var> = <var>dtlsTransport</var>.state;</pre>
2523

2624
<h3 id="Value">Value</h3>
2725

@@ -31,11 +29,9 @@ <h3 id="Value">Value</h3>
3129
<dt><code>new</code></dt>
3230
<dd>The initial state when DTLS has not started negotiating yet.</dd>
3331
<dt><code>connecting</code></dt>
34-
<dd>DTLS is in the process of negotiating a secure connection and verifying the remote
35-
fingerprint.</dd>
32+
<dd>DTLS is in the process of negotiating a secure connection and verifying the remote fingerprint.</dd>
3633
<dt><code>connected</code></dt>
37-
<dd>DTLS has completed negotiation of a secure connection and verified the remote
38-
fingerprint.</dd>
34+
<dd>DTLS has completed negotiation of a secure connection and verified the remote fingerprint.</dd>
3935
<dt><code>closed</code></dt>
4036
<dd>The transport has been closed intentionally as the result of receipt of a
4137
<code>close_notify</code> alert, or calling {{DOMxRef("RTCPeerConnection.close()")}}.
@@ -47,7 +43,7 @@ <h3 id="Value">Value</h3>
4743

4844
<h2 id="Examples">Examples</h2>
4945

50-
<p>{{page("/en-US/docs/Web/API/RTCDtlsTransport", "Examples")}}</p>
46+
<p>See <a href="/en-US/docs/Web/API/RTCDtlsTransport#examples"><code>RTCDtlsTransport</code></a> for example code.</p>
5147

5248
<h2 id="Specifications">Specifications</h2>
5349

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
---
1818
<div>{{APIRef("WebRTC")}}</div>
1919

20-
<p><span class="seoSummary">The <code><strong>RTCIceCandidatePair</strong></code> dictionary describes a pair of ICE candidates which together comprise a description of a viable connection between two WebRTC endpoints.</span> It is used as the return value from {{domxref("RTCIceTransport.getSelectedCandidatePair()")}} to identify the currently-selected candidate pair identified by the ICE agent.</p>
20+
<p>The <code><strong>RTCIceCandidatePair</strong></code> dictionary describes a pair of ICE candidates which together comprise a description of a viable connection between two WebRTC endpoints. It is used as the return value from {{domxref("RTCIceTransport.getSelectedCandidatePair()")}} to identify the currently-selected candidate pair identified by the ICE agent.</p>
2121

2222
<h2 id="Properties">Properties</h2>
2323

@@ -28,9 +28,9 @@ <h2 id="Properties">Properties</h2>
2828
<dd>The <code><strong>RTCIceCandidate</strong></code> describing the configuration of the remote end of the connection.</dd>
2929
</dl>
3030

31-
<h2 id="Example">Example</h2>
31+
<h2 id="Examples">Examples</h2>
3232

33-
<p>{{page("/en-US/docs/Web/API/RTCIceTransport/onselectedcandidatepairchange", "Example")}}</p>
33+
<p>See <a href="/en-US/docs/Web/API/RTCIceTransport/onselectedcandidatepairchange#example"><code>RTCIceTransport.onselectedcandidatepairchange</code></a> for example code.</p>
3434

3535
<h2 id="Specifications">Specifications</h2>
3636

‎files/en-us/web/api/rtcicetransport/getselectedcandidatepair/index.html

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,11 @@
2222
<p><span class="seoSummary">The {{domxref("RTCIceTransport")}} method
2323
<code><strong>getSelectedCandidatePair()</strong></code> returns an
2424
{{domxref("RTCIceCandidatePair")}} object containing the current best-choice pair
25-
of {{Glossary("ICE")}} candidates describing the configuration of the endpoints of
26-
the transport.</span></p>
25+
of {{Glossary("ICE")}} candidates describing the configuration of the endpoints of the transport.</span></p>
2726

2827
<h2 id="Syntax">Syntax</h2>
2928

30-
<pre class="brush: js"><em>candidatePair</em> = <em>RTCIceTransport</em>.getSelectedCandidatePair();
31-
</pre>
29+
<pre class="brush: js"><em>candidatePair</em> = <em>RTCIceTransport</em>.getSelectedCandidatePair();</pre>
3230

3331
<h3 id="Parameters">Parameters</h3>
3432

@@ -57,17 +55,15 @@ <h2 id="Usage_notes">Usage notes</h2>
5755

5856
<p>As ICE negotiation continues, any time a pair of candidates is discovered that is
5957
better than the currently-selected pair, the new pair is selected, replacing the
60-
previous pairing, and the <code>selectedcandidatepairchange</code> event is fired
61-
again.</p>
58+
previous pairing, and the <code>selectedcandidatepairchange</code> event is fired again.</p>
6259

6360
<div class="note">
64-
<p><strong>Note:</strong> It's possible for one of the configurations in the selected
65-
candidate pair to remain unchanged when a new pairing is chosen.</p>
61+
<p><strong>Note:</strong> It's possible for one of the configurations in the selected candidate pair to remain unchanged when a new pairing is chosen.</p>
6662
</div>
6763

68-
<h2 id="Example">Example</h2>
64+
<h2 id="Examples">Examples</h2>
6965

70-
<p>{{page("/en-US/docs/Web/API/RTCIceCandidatePair", "Example")}}</p>
66+
<p>See <a href="/en-US/docs/Web/API/RTCIceTransport/onselectedcandidatepairchange#example"><code>RTCIceTransport.onselectedcandidatepairchange</code></a> for example code.</p>
7167

7268
<h2 id="Specifications">Specifications</h2>
7369

‎files/en-us/web/api/rtcicetransport/onselectedcandidatepairchange/index.html

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,13 @@
1919
---
2020
<div>{{APIRef("WebRTC")}}</div>
2121

22-
<p><span class="seoSummary">The {{domxref("RTCIceTransport")}} interface's
23-
<strong><code>onselectedcandidatepairchange</code></strong> event handler specifies a
22+
<p>The {{domxref("RTCIceTransport")}} interface's <strong><code>onselectedcandidatepairchange</code></strong> event handler specifies a
2423
function to be called to handle the {{event("selectedcandidatepairchange")}} event,
25-
which is fired when the ICE agent selects a new candidate pair to be used for the
26-
connection.</span></p>
24+
which is fired when the ICE agent selects a new candidate pair to be used for the connection.</p>
2725

2826
<h2 id="Syntax">Syntax</h2>
2927

30-
<pre class="brush: js"><em>RTCIceTransport</em>.onselectedcandidatepairchange = <em>candidatePairHandler</em>;
31-
</pre>
28+
<pre class="brush: js"><em>RTCIceTransport</em>.onselectedcandidatepairchange = <em>candidatePairHandler</em>;</pre>
3229

3330
<h3 id="Value">Value</h3>
3431

@@ -49,8 +46,7 @@ <h3 id="Value">Value</h3>
4946
<h2 id="Example">Example</h2>
5047

5148
<p>In this example, an event handler for {{event("selectedcandidatepairchange")}} is set
52-
up to update an on-screen display showing the protocol used by the currently selected
53-
candidate pair.</p>
49+
up to update an on-screen display showing the protocol used by the currently selected candidate pair.</p>
5450

5551
<pre class="brush: js">var iceTransport = pc.getSenders()[0].transport.iceTransport;
5652
var localProto = document.getElementById("local-protocol");

‎files/en-us/web/api/rtcpeerconnection/addtransceiver/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ <h3 id="Parameters">Parameters</h3>
4040
<dt><code>init</code> {{optional_inline}}</dt>
4141
<dd>An object that conforms to the {{domxref("RTCRtpTransceiverInit")}} dictionary which
4242
provides any options that you may wish to specify when creating the new transceiver.
43-
Possible values are: {{page("/en-US/docs/Web/API/RTCRtpTransceiverInit",
44-
"Properties")}}</dd>
43+
Possible values are:
44+
{{page("/en-US/docs/Web/API/RTCRtpTransceiverInit", "Properties")}}</dd>
4545
</dl>
4646

4747
<h3 id="Exceptions">Exceptions</h3>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ <h2 id="Properties">Properties</h2>
2626

2727
<h2 id="Examples">Examples</h2>
2828

29-
<p>{{page("/en-US/docs/Web/API/RTCRtpReceiver/getParameters", "Examples")}}</p>
29+
<p>See <a href="/en-US/docs/Web/API/RTCRtpReceiver/getParameters#example"><code>RTCRtpReceiver.getParameters()</code></a> for example code.</p>
3030

3131
<h2 id="Specifications">Specifications</h2>
3232

0 commit comments

Comments
 (0)