Skip to content

Commit 4e30cc6

Browse files
authored
General cleanup of MulticastOption (dotnet#4683)
* general cleanup * Internet -> IP
1 parent 8a19151 commit 4e30cc6

File tree

1 file changed

+13
-21
lines changed

1 file changed

+13
-21
lines changed

xml/System.Net.Sockets/MulticastOption.xml

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@
4646
|socketOptionName|<xref:System.Net.Sockets.SocketOptionName.AddMembership>|
4747
|object|<xref:System.Net.Sockets.MulticastOption>|
4848
49-
Use <xref:System.Net.Sockets.SocketOptionName.DropMembership> to drop a multicast group.
50-
51-
49+
Use <xref:System.Net.Sockets.SocketOptionName.DropMembership> to drop a multicast group.
5250
5351
## Examples
5452
The following examples join the default IP interface to an IP multicast group. They assume the IP multicast group address in the range 224.0.0.0 to 239.255.255.255.
@@ -107,7 +105,7 @@
107105
<Parameter Name="group" Type="System.Net.IPAddress" />
108106
</Parameters>
109107
<Docs>
110-
<param name="group">The <see cref="T:System.Net.IPAddress" /> of the multicast group.</param>
108+
<param name="group">The IP address of the multicast group.</param>
111109
<summary>Initializes a new version of the <see cref="T:System.Net.Sockets.MulticastOption" /> class for the specified IP multicast group.</summary>
112110
<remarks>
113111
<format type="text/markdown"><![CDATA[
@@ -153,8 +151,8 @@
153151
<Parameter Name="interfaceIndex" Type="System.Int32" Index="1" FrameworkAlternate="net-5.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-1.3;netstandard-1.4;netstandard-1.6;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
154152
</Parameters>
155153
<Docs>
156-
<param name="group">The <see cref="T:System.Net.IPAddress" /> of the multicast group.</param>
157-
<param name="interfaceIndex">The index of the interface that is used to send and receive multicast packets.</param>
154+
<param name="group">The IP address of the multicast group.</param>
155+
<param name="interfaceIndex">The index of the interface that's used to send and receive multicast packets.</param>
158156
<summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.MulticastOption" /> class with the specified IP multicast group address and interface index.</summary>
159157
<remarks>To be added.</remarks>
160158
</Docs>
@@ -192,16 +190,14 @@
192190
<Parameter Name="mcint" Type="System.Net.IPAddress" />
193191
</Parameters>
194192
<Docs>
195-
<param name="group">The group <see cref="T:System.Net.IPAddress" />.</param>
196-
<param name="mcint">The local <see cref="T:System.Net.IPAddress" />.</param>
193+
<param name="group">The group IP address.</param>
194+
<param name="mcint">The local IP address.</param>
197195
<summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.MulticastOption" /> class with the specified IP multicast group address and local IP address associated with a network interface.</summary>
198196
<remarks>
199197
<format type="text/markdown"><![CDATA[
200198
201199
## Remarks
202-
For machines with multiple network cards, you must use this constructor to create <xref:System.Net.Sockets.MulticastOption> instances.
203-
204-
200+
For machines with multiple network cards, you must use this constructor to create <xref:System.Net.Sockets.MulticastOption> instances.
205201
206202
## Examples
207203
The following example creates a <xref:System.Net.Sockets.MulticastOption> object.
@@ -263,14 +259,12 @@
263259
</ReturnValue>
264260
<Docs>
265261
<summary>Gets or sets the IP address of a multicast group.</summary>
266-
<value>An <see cref="T:System.Net.IPAddress" /> that contains the Internet address of a multicast group.</value>
262+
<value>The IP address of a multicast group.</value>
267263
<remarks>
268264
<format type="text/markdown"><![CDATA[
269265
270266
## Remarks
271-
Valid IP addresses for multicast packets are in the range 224.0.0.0 to 239.255.255.255.
272-
273-
267+
Valid IP addresses for multicast packets are in the range 224.0.0.0 to 239.255.255.255.
274268
275269
## Examples
276270
The following example displays the value of this property.
@@ -322,8 +316,8 @@
322316
<ReturnType>System.Int32</ReturnType>
323317
</ReturnValue>
324318
<Docs>
325-
<summary>Gets or sets the index of the interface that is used to send and receive multicast packets.</summary>
326-
<value>An integer that represents the index of a <see cref="T:System.Net.NetworkInformation.NetworkInterface" /> array element.</value>
319+
<summary>Gets or sets the index of the interface that's used to send and receive multicast packets.</summary>
320+
<value>The index of a <see cref="T:System.Net.NetworkInformation.NetworkInterface" /> array element.</value>
327321
<remarks>To be added.</remarks>
328322
</Docs>
329323
</Member>
@@ -367,14 +361,12 @@
367361
</ReturnValue>
368362
<Docs>
369363
<summary>Gets or sets the local address associated with a multicast group.</summary>
370-
<value>An <see cref="T:System.Net.IPAddress" /> that contains the local address associated with a multicast group.</value>
364+
<value>The local address associated with a multicast group.</value>
371365
<remarks>
372366
<format type="text/markdown"><![CDATA[
373367
374368
## Remarks
375-
The <xref:System.Net.Sockets.MulticastOption.LocalAddress%2A> property contains the IP address of the interface associated with the multicast group membership. If <xref:System.Net.Sockets.MulticastOption.LocalAddress%2A> is set to <xref:System.Net.IPAddress.Any>, the default interface is used.
376-
377-
369+
The <xref:System.Net.Sockets.MulticastOption.LocalAddress%2A> property contains the IP address of the interface associated with the multicast group membership. If <xref:System.Net.Sockets.MulticastOption.LocalAddress%2A> is set to <xref:System.Net.IPAddress.Any>, the default interface is used.
378370
379371
## Examples
380372
The following example displays the value of this property.

0 commit comments

Comments
 (0)