[skip ci] Updated documentation.

README.md

@@ -123,7 +123,8 @@ Note that if you use ` #addin nuget:?package=Cake.Paket` you can use the cake te
 
 # Documentation
 
-See the [Documentation](https://larzw.github.io/Cake.Paket/site) for additional help.
+- See the [Documentation](https://larzw.github.io/Cake.Paket/site) for additional help.
+- Cake's sites contains documentation of the addin at [Cake.Paket](http://cakebuild.net/dsl/paket/).
 
 # Contributing
 

Source/Cake.Paket.Addin/Pack/PaketPackSettings.cs

@@ -3,74 +3,74 @@
 namespace Cake.Paket.Addin.Pack
 {
     /// <summary>
-    /// Contains settings used by <see cref="PaketPacker"/>.
-    /// See <see href="https://fsprojects.github.io/Paket/paket-pack.html">Paket Pack</see> for more details.
+    /// Contains settings used by <see cref="PaketPacker"/>. See <see
+    /// href="https://fsprojects.github.io/Paket/paket-pack.html">Paket Pack</see> for more details.
     /// </summary>
     public sealed class PaketPackSettings : ToolSettings
     {
         /// <summary>
-        /// Gets or sets buildconfig.
+        /// Gets or sets the buildconfig.
         /// </summary>
         public string BuildConfig { get; set; }
 
         /// <summary>
-        /// Gets or sets buildplatform.
+        /// Gets or sets the buildplatform.
         /// </summary>
         public string BuildPlatform { get; set; }
 
         /// <summary>
-        /// Gets or sets version.
+        /// Gets or sets the exclude.
         /// </summary>
-        public string Version { get; set; }
+        public string Exclude { get; set; }
 
         /// <summary>
-        /// Gets or sets templatefile.
+        /// Gets or sets a value indicating whether to enable include-referenced-projects.
         /// </summary>
-        public string TemplateFile { get; set; }
+        public bool IncludeReferencedProjects { get; set; }
 
         /// <summary>
-        /// Gets or sets exclude.
+        /// Gets or sets a value indicating whether to enable lock-dependencies.
         /// </summary>
-        public string Exclude { get; set; }
+        public bool LockDependencies { get; set; }
 
         /// <summary>
-        /// Gets or sets specific-version.
+        /// Gets or sets a value indicating whether to enable minimum-from-lock-file.
         /// </summary>
-        public string SpecificVersion { get; set; }
+        public bool MinimumFromLockFile { get; set; }
 
         /// <summary>
-        /// Gets or sets releaseNotes.
+        /// Gets or sets a value indicating whether to enable pin-project-references.
         /// </summary>
-        public string ReleaseNotes { get; set; }
+        public bool PinProjectReferences { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to enable lock-dependencies.
+        /// Gets or sets the project-url.
         /// </summary>
-        public bool LockDependencies { get; set; }
+        public string ProjectUrl { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to enable minimum-from-lock-file.
+        /// Gets or sets the releaseNotes.
         /// </summary>
-        public bool MinimumFromLockFile { get; set; }
+        public string ReleaseNotes { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to enable pin-project-references.
+        /// Gets or sets the specific-version.
         /// </summary>
-        public bool PinProjectReferences { get; set; }
+        public string SpecificVersion { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether to enable symbols.
         /// </summary>
         public bool Symbols { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to enable include-referenced-projects.
+        /// Gets or sets the templatefile.
         /// </summary>
-        public bool IncludeReferencedProjects { get; set; }
+        public string TemplateFile { get; set; }
 
         /// <summary>
-        /// Gets or sets project-url.
+        /// Gets or sets the version.
         /// </summary>
-        public string ProjectUrl { get; set; }
+        public string Version { get; set; }
     }
-}
+}

Source/Cake.Paket.Addin/PaketAliases.cs

@@ -111,7 +111,7 @@ public static void PaketRestore(this ICakeContext context, PaketRestoreSettings
         }
 
         /// <summary>
-        /// Runs paket restore for the given settings.
+        /// Runs paket restore.
         /// </summary>
         /// <param name="context">The context.</param>
         [CakeMethodAlias]
@@ -132,4 +132,4 @@ private static PaketToolResolver GetPaketToolResolver(ICakeContext context)
             return new PaketToolResolver(context.FileSystem, context.Environment, context.Tools, context.ProcessRunner, context.Arguments, context.Log);
         }
     }
-}
+}

Source/Cake.Paket.Addin/Push/PaketPushSettings.cs

@@ -3,24 +3,24 @@
 namespace Cake.Paket.Addin.Push
 {
     /// <summary>
-    /// Contains settings used by <see cref="PaketPusher"/>.
-    /// See <see href="https://fsprojects.github.io/Paket/paket-push.html">Paket Push</see> for more details.
+    /// Contains settings used by <see cref="PaketPusher"/>. See <see
+    /// href="https://fsprojects.github.io/Paket/paket-push.html">Paket Push</see> for more details.
     /// </summary>
     public sealed class PaketPushSettings : ToolSettings
     {
         /// <summary>
-        /// Gets or sets url.
+        /// Gets or sets the apikey.
         /// </summary>
-        public string Url { get; set; }
+        public string ApiKey { get; set; }
 
         /// <summary>
-        /// Gets or sets apikey.
+        /// Gets or sets the endpoint.
         /// </summary>
-        public string ApiKey { get; set; }
+        public string EndPoint { get; set; }
 
         /// <summary>
-        /// Gets or sets endpoint.
+        /// Gets or sets the url.
         /// </summary>
-        public string EndPoint { get; set; }
+        public string Url { get; set; }
     }
-}
+}

Source/Cake.Paket.Addin/Restore/PaketRestoreSettings.cs

@@ -3,40 +3,37 @@
 namespace Cake.Paket.Addin.Restore
 {
     /// <summary>
-    /// Contains settings used by <see cref="PaketRestorer"/>.
-    /// See <see href="https://fsprojects.github.io/Paket/paket-restore.html">Paket Restore</see> for more details.
+    /// Contains settings used by <see cref="PaketRestorer"/>. See <see
+    /// href="https://fsprojects.github.io/Paket/paket-restore.html">Paket Restore</see> for more details.
     /// </summary>
     public sealed class PaketRestoreSettings : ToolSettings
     {
         /// <summary>
-        /// Gets or sets a value indicating whether to force the download of all packages.
+        /// Gets or sets a value indicating whether to cause the restore to fail if any of the checks fail.
         /// </summary>
-        public bool Force { get; set; }
+        public bool FailOnChecks { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to restore packages that are referenced in paket.references files, instead of all packages in paket.dependencies.
+        /// Gets or sets a value indicating whether to force the download of all packages.
         /// </summary>
-        public bool OnlyReferenced { get; set; }
+        public bool Force { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to touch project files referencing packages which are being restored, to help incremental build tools detecting the change.
+        /// Gets or sets a value to restore a single group.
         /// </summary>
-        public bool TouchAffectedRefs { get; set; }
+        public string Group { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to skips the test if paket.dependencies and paket.lock are in sync.
+        /// Gets or sets a value indicating whether to skip the test if paket.dependencies and
+        /// paket.lock are in sync.
         /// </summary>
         public bool IgnoreChecks { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to causes the restore to fail if any of the checks fail.
-        /// </summary>
-        public bool FailOnChecks { get; set; }
-
-        /// <summary>
-        /// Gets or sets a value to restore a single group.
+        /// Gets or sets a value indicating whether to restore packages that are referenced in the
+        /// paket.references files, as opposed to all the packages in paket.dependencies.
         /// </summary>
-        public string Group { get; set; }
+        public bool OnlyReferenced { get; set; }
 
         /// <summary>
         /// Gets or sets a value to restore dependencies for a project.
@@ -47,5 +44,11 @@ public sealed class PaketRestoreSettings : ToolSettings
         /// Gets or sets value to restore all packages from the given paket.references files.
         /// </summary>
         public string ReferencesFiles { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to touch project files referencing packages which
+        /// are being restored, to help incremental build tools detecting the change.
+        /// </summary>
+        public bool TouchAffectedRefs { get; set; }
     }
-}
+}

docs/index.md

@@ -111,6 +111,10 @@ Note that if you use ` #nuget:?package=Cake.Paket` you can use the cake teams de
 
 [Cake.Paket.Example](https://github.com/larzw/Cake.Paket.Example) is an example project which uses Paket with Cake. Additionally, the project for the paket addin and module is another good resource, see [build.cake](https://github.com/larzw/Cake.Paket/blob/master/build.cake).
 
+# Documentation
+
+Besides this documentaion, Cake's sites contains documentation of the addin at [Cake.Paket](http://cakebuild.net/dsl/paket/).
+
 # Contributing
 
 All types of contributions are welcome! Please see the [Contributing](https://github.com/larzw/Cake.Paket/blob/master/.github/CONTRIBUTING.md) guidlines.

docs/site/api/Cake.NuGet.INuGetContentResolver.html

@@ -85,10 +85,10 @@ <h3 id="methods">Methods
               </h3>
               <span class="small pull-right mobile-hide">
                 <span class="divider">|</span>
-                <a href="https://github.com/larzw/Cake.Paket/new/release-1.2.1/docs/apispec/new?filename=Cake_NuGet_INuGetContentResolver_GetFiles_Cake_Core_IO_DirectoryPath_Cake_Core_Packaging_PackageReference_Cake_Core_Packaging_PackageType_.md&amp;value=---%0Auid%3A%20Cake.NuGet.INuGetContentResolver.GetFiles(Cake.Core.IO.DirectoryPath%2CCake.Core.Packaging.PackageReference%2CCake.Core.Packaging.PackageType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+                <a href="https://github.com/larzw/Cake.Paket/new/develop/docs/apispec/new?filename=Cake_NuGet_INuGetContentResolver_GetFiles_Cake_Core_IO_DirectoryPath_Cake_Core_Packaging_PackageReference_Cake_Core_Packaging_PackageType_.md&amp;value=---%0Auid%3A%20Cake.NuGet.INuGetContentResolver.GetFiles(Cake.Core.IO.DirectoryPath%2CCake.Core.Packaging.PackageReference%2CCake.Core.Packaging.PackageType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
               </span>
               <span class="small pull-right mobile-hide">
-                <a href="https://github.com/larzw/Cake.Paket/blob/release-1.2.1/Source/Cake.NuGet/INuGetContentResolver.cs/#L42">View Source</a>
+                <a href="https://github.com/larzw/Cake.Paket/blob/develop/Source/Cake.NuGet/INuGetContentResolver.cs/#L42">View Source</a>
               </span>
               <a id="Cake_NuGet_INuGetContentResolver_GetFiles_" data-uid="Cake.NuGet.INuGetContentResolver.GetFiles*"></a>
               <h4 id="Cake_NuGet_INuGetContentResolver_GetFiles_Cake_Core_IO_DirectoryPath_Cake_Core_Packaging_PackageReference_Cake_Core_Packaging_PackageType_" data-uid="Cake.NuGet.INuGetContentResolver.GetFiles(Cake.Core.IO.DirectoryPath,Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">GetFiles(DirectoryPath, PackageReference, PackageType)</h4>
@@ -154,10 +154,10 @@ <h5 class="returns">Returns</h5>
               <div class="contribution">
                 <ul class="nav">
                   <li>
-                    <a href="https://github.com/larzw/Cake.Paket/new/release-1.2.1/docs/apispec/new?filename=Cake_NuGet_INuGetContentResolver.md&amp;value=---%0Auid%3A%20Cake.NuGet.INuGetContentResolver%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
+                    <a href="https://github.com/larzw/Cake.Paket/new/develop/docs/apispec/new?filename=Cake_NuGet_INuGetContentResolver.md&amp;value=---%0Auid%3A%20Cake.NuGet.INuGetContentResolver%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com/larzw/Cake.Paket/blob/release-1.2.1/Source/Cake.NuGet/INuGetContentResolver.cs/#L32" class="contribution-link">View Source</a>
+                    <a href="https://github.com/larzw/Cake.Paket/blob/develop/Source/Cake.NuGet/INuGetContentResolver.cs/#L32" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

docs/site/api/Cake.NuGet.html

@@ -87,7 +87,7 @@ <h4><a class="xref" href="Cake.NuGet.INuGetContentResolver.html">INuGetContentRe
               <div class="contribution">
                 <ul class="nav">
                   <li>
-                    <a href="https://github.com/larzw/Cake.Paket/new/release-1.2.1/docs/apispec/new?filename=Cake_NuGet.md&amp;value=---%0Auid%3A%20Cake.NuGet%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
+                    <a href="https://github.com/larzw/Cake.Paket/new/develop/docs/apispec/new?filename=Cake_NuGet.md&amp;value=---%0Auid%3A%20Cake.NuGet%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                 </ul>
               </div>