From 5295af8815eb176f8687114ddf7d1cf0a2ed7aed Mon Sep 17 00:00:00 2001
From: stakx <stakx@eml.cc>
Date: Sat, 28 Mar 2020 15:06:43 +0100
Subject: [PATCH] Add XML doc comments for setup verification

---
 src/Moq/Setup.cs | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/src/Moq/Setup.cs b/src/Moq/Setup.cs
index a50f49bc3..ec4d5a31e 100644
--- a/src/Moq/Setup.cs
+++ b/src/Moq/Setup.cs
@@ -89,6 +89,20 @@ public override string ToString()
 			return builder.ToString();
 		}
 
+		/// <summary>
+		///   Verifies this setup and/or those of its inner mock (if present and known).
+		/// </summary>
+		/// <param name="predicate">
+		///   Specifies which setups should be verified.
+		/// </param>
+		/// <param name="error">
+		///   If this setup and/or any of its inner mock (if present and known) failed verification,
+		///   this <see langword="out"/> parameter will receive a <see cref="MockException"/> describing the verification error(s).
+		/// </param>
+		/// <returns>
+		///   <see langword="true"/> if this setup and/or any of its inner mock (if present and known) did not fail verification;
+		///   otherwise, <see langword="false"/>.
+		/// </returns>
 		public bool TryVerify(Func<Setup, bool> predicate, out MockException error)
 		{
 			if (predicate(this))
@@ -103,6 +117,21 @@ public bool TryVerify(Func<Setup, bool> predicate, out MockException error)
 			return this.TryVerifyInnerMock(predicate, out error);
 		}
 
+		/// <summary>
+		///   Verifies all setups of this setup's inner mock (if present and known).
+		///   Multiple verification errors are aggregated into a single <see cref="MockException"/>.
+		/// </summary>
+		/// <param name="predicate">
+		///   Specifies which setups should be verified.
+		/// </param>
+		/// <param name="error">
+		///   If one or more setups of this setup's inner mock (if present and known) failed verification,
+		///   this <see langword="out"/> parameter will receive a <see cref="MockException"/> describing the verification error(s).
+		/// </param>
+		/// <returns>
+		///   <see langword="true"/> if no setup of this setup's inner mock (if present and known) failed verification;
+		///   otherwise, <see langword="false"/>.
+		/// </returns>
 		protected virtual bool TryVerifyInnerMock(Func<Setup, bool> predicate, out MockException error)
 		{
 			if (this.ReturnsInnerMock(out var innerMock))
@@ -118,6 +147,17 @@ protected virtual bool TryVerifyInnerMock(Func<Setup, bool> predicate, out MockE
 			return true;
 		}
 
+		/// <summary>
+		///   Verifies only this setup, excluding those of its inner mock (if present and known).
+		/// </summary>
+		/// <param name="error">
+		///   If this setup failed verification,
+		///   this <see langword="out"/> parameter will receive a <see cref="MockException"/> describing the verification error.
+		/// </param>
+		/// <returns>
+		///   <see langword="true"/> if this setup did not fail verification;
+		///   otherwise, <see langword="false"/>.
+		/// </returns>
 		protected virtual bool TryVerifySelf(out MockException error)
 		{
 			error = null;