(cake-buildGH-1689) Add documentation that Chocolatey licensed is req…

…uired
CRuppert · Jan 23, 2018 · 3dffbe4 · 3dffbe4
1 parent b5dd3f9
commit 3dffbe4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/src/Cake.Common/Tools/Chocolatey/ChocolateyAliases.cs b/src/Cake.Common/Tools/Chocolatey/ChocolateyAliases.cs
@@ -1146,6 +1146,7 @@ public static void ChocolateyNew(this ICakeContext context, string packageId, Ch
 
         /// <summary>
         /// Downloads a Chocolatey package to the current working directory.
+        /// Requires Chocolatey licensed edition.
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="packageId">The id of the package to download.</param>
@@ -1165,6 +1166,9 @@ public static void ChocolateyDownload(this ICakeContext context, string packageI
 
         /// <summary>
         /// Downloads a Chocolatey package using the specified settings.
+        /// Requires Chocolatey licensed edition.
+        /// Features requiring Chocolatey for Business or a minimum version are documented
+        /// in <see cref="ChocolateyDownloadSettings"/>.
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="packageId">The id of the package to install.</param>

diff --git a/src/Cake.Common/Tools/Chocolatey/Download/ChocolateyDownloader.cs b/src/Cake.Common/Tools/Chocolatey/Download/ChocolateyDownloader.cs
@@ -36,6 +36,9 @@ public ChocolateyDownloader(
 
         /// <summary>
         /// Downloads Chocolatey packages using the specified package id and settings.
+        /// Requires Chocolatey licensed edition.
+        /// Features requiring Chocolatey for Business or a minimum version are documented
+        /// in <see cref="ChocolateyDownloadSettings"/>.
         /// </summary>
         /// <param name="packageId">The source package id.</param>
         /// <param name="settings">The settings.</param>