From fc9d254dac92f04146407fe6c15e2fdd768663c5 Mon Sep 17 00:00:00 2001
From: Marc Brooks <IDisposable@gmail.com>
Date: Mon, 20 Mar 2023 16:48:35 -0500
Subject: [PATCH] Correct doc comment for IMultiplyOperators returns (#8915)

Replaced _divided-by_ with _multiplied-by_ in
System.Half, System.Int128, System.UInt128,
System.Numerics.IMultiplyOperators, and
System.Runtime.InteropServices.NFloat.
This reflects the matching changes in
https://github.com/dotnet/runtime/pull/83693 to the
IMultiplyOperators and NFloat and
fixes https://github.com/dotnet/runtime/issues/80521
---
 xml/System.Numerics/IMultiplyOperators`3.xml  | 2 +-
 xml/System.Runtime.InteropServices/NFloat.xml | 2 +-
 xml/System/Half.xml                           | 2 +-
 xml/System/Int128.xml                         | 4 ++--
 xml/System/UInt128.xml                        | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/xml/System.Numerics/IMultiplyOperators`3.xml b/xml/System.Numerics/IMultiplyOperators`3.xml
index 38c4c14aafc..86849223529 100644
--- a/xml/System.Numerics/IMultiplyOperators`3.xml
+++ b/xml/System.Numerics/IMultiplyOperators`3.xml
@@ -52,7 +52,7 @@
         <param name="left">The value which <paramref name="right" /> multiplies.</param>
         <param name="right">The value which multiplies <paramref name="left" />.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
         <exception cref="T:System.OverflowException">The product of <paramref name="left" /> multiplied by <paramref name="right" /> is not representable by <typeparamref name="TResult" />.</exception>
       </Docs>
diff --git a/xml/System.Runtime.InteropServices/NFloat.xml b/xml/System.Runtime.InteropServices/NFloat.xml
index cc07996a6b4..f9c418a5828 100644
--- a/xml/System.Runtime.InteropServices/NFloat.xml
+++ b/xml/System.Runtime.InteropServices/NFloat.xml
@@ -4290,7 +4290,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
         <param name="left">The value that <paramref name="right" /> multiplies.</param>
         <param name="right">The value that multiplies <paramref name="left" />.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
diff --git a/xml/System/Half.xml b/xml/System/Half.xml
index f2031f7a003..3007a93cc6a 100644
--- a/xml/System/Half.xml
+++ b/xml/System/Half.xml
@@ -4252,7 +4252,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
         <param name="left">To be added.</param>
         <param name="right">To be added.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
       </Docs>
diff --git a/xml/System/Int128.xml b/xml/System/Int128.xml
index a13ab07e506..21e58d18c9b 100644
--- a/xml/System/Int128.xml
+++ b/xml/System/Int128.xml
@@ -1491,7 +1491,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
         <param name="left">To be added.</param>
         <param name="right">To be added.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_CheckedMultiply(`0,`1)" />
       </Docs>
@@ -2847,7 +2847,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601> this method matches the IEE
         <param name="left">To be added.</param>
         <param name="right">To be added.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
       </Docs>
diff --git a/xml/System/UInt128.xml b/xml/System/UInt128.xml
index 3c0dff5babb..01544808266 100644
--- a/xml/System/UInt128.xml
+++ b/xml/System/UInt128.xml
@@ -1383,7 +1383,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
         <param name="left">To be added.</param>
         <param name="right">To be added.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_CheckedMultiply(`0,`1)" />
       </Docs>
@@ -2739,7 +2739,7 @@ For <xref:System.Numerics.IFloatingPoint%601> this method matches the IEEE 754:2
         <param name="left">To be added.</param>
         <param name="right">To be added.</param>
         <summary>Multiplies two values together to compute their product.</summary>
-        <returns>The product of <paramref name="left" /> divided-by <paramref name="right" />.</returns>
+        <returns>The product of <paramref name="left" /> multiplied-by <paramref name="right" />.</returns>
         <remarks>To be added.</remarks>
         <inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
       </Docs>