Merge pull request #1341 from microsoft/AArnott-patch-1

AArnott · web-flow · commit e60dcef551b1 · 2024-07-24T09:53:28.000-06:00
Update AsyncQueue.Enqueue doc
diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs
@@ -161,6 +161,7 @@ public void Complete()
     /// Adds an element to the tail of the queue.
     /// </summary>
     /// <param name="value">The value to add.</param>
+    /// <exception cref="InvalidOperationException">Thrown if <see cref="Complete" /> has already been called. Use <see cref="TryEnqueue" /> to avoid an exception in this case.</exception>
     public void Enqueue(T value)
     {
         if (!this.TryEnqueue(value))

Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,7 @@ public void Complete()`
`161`	`161`	`/// Adds an element to the tail of the queue.`
`162`	`162`	`/// </summary>`
`163`	`163`	`/// <param name="value">The value to add.</param>`
	`164`	`+ /// <exception cref="InvalidOperationException">Thrown if <see cref="Complete" /> has already been called. Use <see cref="TryEnqueue" /> to avoid an exception in this case.</exception>`
`164`	`165`	`public void Enqueue(T value)`
`165`	`166`	`{`
`166`	`167`	`if (!this.TryEnqueue(value))`