Merge pull request #1082 from phillipsj/feature-remaining-documentation

GH-750 Remaining documentation
cake-build · Jul 20, 2016 · 0a6b68c · 0a6b68c
2 parents 77cebab + d31bf86
commit 0a6b68c
Show file tree

Hide file tree

Showing 4 changed files with 105 additions and 0 deletions.
diff --git a/src/Cake.Common/Tools/NSIS/NSISAliases.cs b/src/Cake.Common/Tools/NSIS/NSISAliases.cs
@@ -25,6 +25,11 @@ public static class NSISAliases
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="scriptFile">The path to the <c>.nsi</c> script file to compile.</param>
+        /// <example>
+        /// <code>
+        /// MakeNSIS("./src/Cake.nsi");
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("MakeNSIS")]
         // ReSharper disable once InconsistentNaming
@@ -39,6 +44,13 @@ public static void MakeNSIS(this ICakeContext context, FilePath scriptFile)
         /// <param name="context">The context.</param>
         /// <param name="scriptFile">The path to the <c>.nsi</c> script file to compile.</param>
         /// <param name="settings">The <see cref="MakeNSISSettings"/> to use.</param>
+        /// <example>
+        /// <code>
+        /// MakeNSIS("./src/Cake.nsi", new MakeNSISSettings {
+        ///     NoConfig = true
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         [CakeAliasCategory("MakeNSIS")]
         // ReSharper disable once InconsistentNaming

diff --git a/src/Cake.Common/Tools/Roundhouse/RoundhouseAliases.cs b/src/Cake.Common/Tools/Roundhouse/RoundhouseAliases.cs
@@ -25,6 +25,15 @@ public static class RoundhouseAliases
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// RoundhouseMigrate(new RoundhouseSettings{
+        ///     ServerName = "Sql2008R2",
+        ///     DatabaseName = "AdventureWorks2008R2",
+        ///     SqlFilesDirectory = "./src/sql"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void RoundhouseMigrate(this ICakeContext context, RoundhouseSettings settings)
         {
@@ -42,6 +51,14 @@ public static void RoundhouseMigrate(this ICakeContext context, RoundhouseSettin
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// RoundhouseDrop(new RoundhouseSettings{
+        ///     ServerName = "Sql2008R2",
+        ///     DatabaseName = "AdventureWorks2008R2"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void RoundhouseDrop(this ICakeContext context, RoundhouseSettings settings)
         {

diff --git a/src/Cake.Common/Tools/XBuild/XBuildAliases.cs b/src/Cake.Common/Tools/XBuild/XBuildAliases.cs
@@ -23,6 +23,11 @@ public static class XBuildAliases
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="solution">The solution to build.</param>
+        /// <example>
+        /// <code>
+        /// XBuild("./src/Cake.sln");
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XBuild(this ICakeContext context, FilePath solution)
         {
@@ -35,6 +40,14 @@ public static void XBuild(this ICakeContext context, FilePath solution)
         /// <param name="context">The context.</param>
         /// <param name="solution">The solution to build.</param>
         /// <param name="configurator">The settings configurator.</param>
+        /// <example>
+        /// <code>
+        /// XBuild("./src/Cake.sln", configurator =>
+        ///     configurator.SetConfiguration("Debug")
+        ///         .SetVerbosity(Verbosity.Minimal)
+        ///         .UseToolVersion(XBuildToolVersion.NET40));
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XBuild(this ICakeContext context, FilePath solution, Action<XBuildSettings> configurator)
         {
@@ -60,6 +73,15 @@ public static void XBuild(this ICakeContext context, FilePath solution, Action<X
         /// <param name="context">The context.</param>
         /// <param name="solution">The solution to build.</param>
         /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// MSBuild("./src/Cake.sln", new XBuildSettings {
+        ///     Verbosity = Verbosity.Minimal,
+        ///     ToolVersion = XBuildToolVersion.NET40,
+        ///     Configuration = "Release"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XBuild(this ICakeContext context, FilePath solution, XBuildSettings settings)
         {

diff --git a/src/Cake.Common/Tools/XUnit/XUnitAliases.cs b/src/Cake.Common/Tools/XUnit/XUnitAliases.cs
@@ -28,6 +28,11 @@ public static class XUnitAliases
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="pattern">The pattern.</param>
+        /// <example>
+        /// <code>
+        /// XUnit("./src/**/bin/Release/*.Tests.dll");
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XUnit(this ICakeContext context, string pattern)
         {
@@ -46,6 +51,15 @@ public static void XUnit(this ICakeContext context, string pattern)
         /// <param name="context">The context.</param>
         /// <param name="pattern">The pattern.</param>
         /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// XUnit("./src/**/bin/Release/*.Tests.dll",
+        ///      new XUnitSettings {
+        ///         HtmlReport = true,
+        ///         OutputDirectory = "./build"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XUnit(this ICakeContext context, string pattern, XUnitSettings settings)
         {
@@ -63,6 +77,16 @@ public static void XUnit(this ICakeContext context, string pattern, XUnitSetting
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="assemblies">The assemblies.</param>
+        /// <example>
+        /// <code>
+        /// XUnit(new []{
+        ///     "./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
+        ///     "./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
+        ///     "./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
+        ///     "./src/Cake.Tests/bin/Release/Cake.Tests.dll"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XUnit(this ICakeContext context, IEnumerable<string> assemblies)
         {
@@ -79,6 +103,12 @@ public static void XUnit(this ICakeContext context, IEnumerable<string> assembli
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="assemblies">The assemblies.</param>
+        /// <example>
+        /// <code>
+        /// var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
+        /// XUnit(testAssemblies);
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XUnit(this ICakeContext context, IEnumerable<FilePath> assemblies)
         {
@@ -91,6 +121,20 @@ public static void XUnit(this ICakeContext context, IEnumerable<FilePath> assemb
         /// <param name="context">The context.</param>
         /// <param name="assemblies">The assemblies.</param>
         /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// XUnit(new []{
+        ///     "./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
+        ///     "./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
+        ///     "./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
+        ///     "./src/Cake.Tests/bin/Release/Cake.Tests.dll"
+        ///      },
+        ///      new XUnitSettings {
+        ///         HtmlReport = true,
+        ///         OutputDirectory = "./build"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XUnit(this ICakeContext context, IEnumerable<string> assemblies, XUnitSettings settings)
         {
@@ -108,6 +152,16 @@ public static void XUnit(this ICakeContext context, IEnumerable<string> assembli
         /// <param name="context">The context.</param>
         /// <param name="assemblies">The assemblies.</param>
         /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
+        /// XUnit(testAssemblies,
+        ///      new XUnitSettings {
+        ///         HtmlReport = true,
+        ///         OutputDirectory = "./build"
+        ///     });
+        /// </code>
+        /// </example>
         [CakeMethodAlias]
         public static void XUnit(this ICakeContext context, IEnumerable<FilePath> assemblies, XUnitSettings settings)
         {