Add missing SocketAddress API docs (#9306)

* Add missing SocketAddress API docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Carlos Sánchez López <[email protected]> --------- Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Carlos Sánchez López <[email protected]>
dotnet · Sep 18, 2023 · eb9031c · eb9031c
1 parent 9387dee
commit eb9031c
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/xml/System.Net/SocketAddress.xml b/xml/System.Net/SocketAddress.xml
@@ -217,9 +217,11 @@
         <ReturnType>System.Memory&lt;System.Byte&gt;</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Gets the underlying memory that can be passed to native OS calls.</summary>
+
         <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <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>
+
       </Docs>
     </Member>
     <Member MemberName="Equals">
@@ -446,9 +448,10 @@
         <Parameter Name="addressFamily" Type="System.Net.Sockets.AddressFamily" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="addressFamily">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="addressFamily">The addressing scheme to use.</param>
+
+        <summary>Gets the maximum required buffer size for the given <see cref="T:System.Net.Sockets.AddressFamily"/>.</summary>
+        <returns>The maximum buffer size.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>