Skip to content

Commit eb9031c

Browse files
antonfirsovgewarrencarlossanlop
authored
Add missing SocketAddress API docs (dotnet#9306)
* Add missing SocketAddress API docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com> --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
1 parent 9387dee commit eb9031c

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

xml/System.Net/SocketAddress.xml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -217,9 +217,11 @@
217217
<ReturnType>System.Memory&lt;System.Byte&gt;</ReturnType>
218218
</ReturnValue>
219219
<Docs>
220-
<summary>To be added.</summary>
220+
<summary>Gets the underlying memory that can be passed to native OS calls.</summary>
221+
221222
<value>To be added.</value>
222-
<remarks>To be added.</remarks>
223+
<remarks>The content of the buffer can be invalidated if <see cref="P:System.Net.SocketAddress.Size"/> is changed or if the <see cref="T:System.Net.SocketAddress"/> instance is used in another receive call.</remarks>
224+
223225
</Docs>
224226
</Member>
225227
<Member MemberName="Equals">
@@ -446,9 +448,10 @@
446448
<Parameter Name="addressFamily" Type="System.Net.Sockets.AddressFamily" Index="0" FrameworkAlternate="net-8.0" />
447449
</Parameters>
448450
<Docs>
449-
<param name="addressFamily">To be added.</param>
450-
<summary>To be added.</summary>
451-
<returns>To be added.</returns>
451+
<param name="addressFamily">The addressing scheme to use.</param>
452+
453+
<summary>Gets the maximum required buffer size for the given <see cref="T:System.Net.Sockets.AddressFamily"/>.</summary>
454+
<returns>The maximum buffer size.</returns>
452455
<remarks>To be added.</remarks>
453456
</Docs>
454457
</Member>

0 commit comments

Comments
 (0)