Alias examples for MSTest cake-build#750

Cake.Common.Tools.MSTest.MSTest(string) Cake.Common.Tools.MSTest.MSTest(string, MSTestSettings) Cake.Common.Tools.MSTest.MSTest(IEnumerable<FilePath>) Cake.Common.Tools.MSTest.MSTest(IEnumerable<FilePath>, MSTestSettings)
m-ritchie · Mar 27, 2016 · ffc6fce · ffc6fce
1 parent 7fdd9c2
commit ffc6fce
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/src/Cake.Common/Tools/MSTest/MSTestAliases.cs b/src/Cake.Common/Tools/MSTest/MSTestAliases.cs
@@ -17,6 +17,11 @@ public static class MSTestAliases
         /// <summary>
         /// Runs all MSTest unit tests in the assemblies matching the specified pattern.
         /// </summary>
+        /// <example>
+        /// <code>
+        /// MSTest("./Tests/*.UnitTests.dll");
+        /// </code>
+        /// </example>
         /// <param name="context">The context.</param>
         /// <param name="pattern">The pattern.</param>
         [CakeMethodAlias]
@@ -40,6 +45,11 @@ public static void MSTest(this ICakeContext context, string pattern)
         /// <summary>
         /// Runs all MSTest unit tests in the assemblies matching the specified pattern.
         /// </summary>
+        /// <example>
+        /// <code>
+        /// MSTest("./Tests/*.UnitTests.dll", new MSTestSettings() { NoIsolation = false });
+        /// </code>
+        /// </example>
         /// <param name="context">The context.</param>
         /// <param name="pattern">The pattern.</param>
         /// <param name="settings">The settings.</param>
@@ -64,6 +74,12 @@ public static void MSTest(this ICakeContext context, string pattern, MSTestSetti
         /// <summary>
         /// Runs all MSTest unit tests in the specified assemblies.
         /// </summary>
+        /// <example>
+        /// <code>
+        /// var paths = new List&lt;FilePath&gt;() { "./assemblydir1", "./assemblydir2" };
+        /// MSTest(paths);
+        /// </code>
+        /// </example>
         /// <param name="context">The context.</param>
         /// <param name="assemblyPaths">The assembly paths.</param>
         [CakeMethodAlias]
@@ -75,6 +91,12 @@ public static void MSTest(this ICakeContext context, IEnumerable<FilePath> assem
         /// <summary>
         /// Runs all MSTest unit tests in the specified assemblies.
         /// </summary>
+        /// <example>
+        /// <code>
+        /// var paths = new List&lt;FilePath&gt;() { "./assemblydir1", "./assemblydir2" };
+        /// MSTest(paths, new MSTestSettings() { NoIsolation = false });
+        /// </code>
+        /// </example>
         /// <param name="context">The context.</param>
         /// <param name="assemblyPaths">The assembly paths.</param>
         /// <param name="settings">The settings.</param>