(doc) Add all missing documentation

This was pointed out via the warnings produced by StyleCop.

Author: gep13

src/Cake.AppVeyor/AppVeyorAliases.cs

@@ -22,9 +22,8 @@ namespace Cake.AppVeyor
     public static class AppVeyorAliases
     {
         /// <summary>
-        /// Clears the AppVeyor Cache.
+        /// Clears the AppVeyor Cache using additional settings in <cref>AppVeyorSettings</cref>.
         /// </summary>
-        /// <returns>The projects.</returns>
         /// <param name="context">The context.</param>
         /// <param name="settings">The settings.</param>
         /// <param name="accountName">The account name.</param>
@@ -37,9 +36,8 @@ public static void AppVeyorClearCache(this ICakeContext context, AppVeyorSetting
         }
 
         /// <summary>
-        /// Gets all projects.
+        /// Clears the AppVeyor Cache.
         /// </summary>
-        /// <returns>The projects.</returns>
         /// <param name="context">The context.</param>
         /// <param name="appVeyorApiToken">The API Token.</param>
         /// <param name="accountName">The account name.</param>
@@ -52,7 +50,7 @@ public static void AppVeyorClearCache(this ICakeContext context, string appVeyor
         }
 
         /// <summary>
-        /// Gets all projects.
+        /// Gets all projects using additional settings in <cref>AppVeyorSettings</cref>.
         /// </summary>
         /// <returns>The projects.</returns>
         /// <param name="context">The context.</param>
@@ -78,7 +76,7 @@ public static List<AppVeyorProject> AppVeyorProjects(this ICakeContext context,
         }
 
         /// <summary>
-        /// Gets the project build history.
+        /// Gets the project build history using additional settings in <cref>AppVeyorSettings</cref>.
         /// </summary>
         /// <returns>The project build history.</returns>
         /// <param name="context">The context.</param>
@@ -114,7 +112,7 @@ public static AppVeyorProjectHistory AppVeyorProjectHistory(this ICakeContext co
         }
 
         /// <summary>
-        /// Gets the last build of the project.
+        /// Gets the last build of the project using additional settings in <cref>AppVeyorSettings</cref>.
         /// </summary>
         /// <returns>The project's last build.</returns>
         /// <param name="context">The context.</param>
@@ -144,7 +142,7 @@ public static AppVeyorProjectBuild AppVeyorProjectLastBuild(this ICakeContext co
         }
 
         /// <summary>
-        /// Gets the last successful build of the project.
+        /// Gets the last successful build of the project using additional settings in <cref>AppVeyorSettings</cref>.
         /// </summary>
         /// <returns>The project's last successful build.</returns>
         /// <param name="context">The context.</param>

src/Cake.AppVeyor/AppVeyorClient.cs

@@ -8,10 +8,18 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// Provides a class for sending HTTP requests to AppVeyor.
+    /// </summary>
     public static class AppVeyorClient
     {
         private const string BaseUrl = "https://ci.appveyor.com";
 
+        /// <summary>
+        /// Create a new instance of <cref>IAppVeyorApi</cref> for interacting with the available methods against AppVeyor REST API.
+        /// </summary>
+        /// <param name="authToken">The API Key to use.</param>
+        /// <returns>An instance of <cref>IAppVeyorApi</cref> to allow communication to AppVeyor REST API.</returns>
         public static IAppVeyorApi Create(string authToken)
         {
             return RestService.For<IAppVeyorApi>(

src/Cake.AppVeyor/AuthenticatedHttpClientHandler.cs

@@ -5,15 +5,31 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// The default message handler used by <cref>AppVeyorClient</cref>.
+    /// </summary>
     public class AuthenticatedHttpClientHandler : HttpClientHandler
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AuthenticatedHttpClientHandler"/> class.
+        /// </summary>
+        /// <param name="authToken">The API Key for accessing AppVeyor.</param>
         public AuthenticatedHttpClientHandler(string authToken)
         {
             AuthToken = authToken;
         }
 
+        /// <summary>
+        /// Gets or sets the API Key used to communicate with AppVeyor.
+        /// </summary>
         public string AuthToken { get; set; }
 
+        /// <summary>
+        /// Sends a message, asynchronously, to AppVeyor.
+        /// </summary>
+        /// <param name="request">The <cref>HttpRequestMessage</cref> to send to AppVeyor.</param>
+        /// <param name="cancellationToken">The <cref>CancellationToken</cref> for the operation.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation to send a request to AppVeyor.</returns>
         protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
         {
             request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", AuthToken);

src/Cake.AppVeyor/IAppVeyorApi.cs

@@ -4,53 +4,147 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// Provides the API methods that can be called against AppVeyor via the <cref>AppVeyorClient</cref>.
+    /// </summary>
     public interface IAppVeyorApi
     {
+        /// <summary>
+        /// Clear the cache for a given AppVeyor project.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
         [Delete("/api/projects/{accountName}/{projectSlug}/buildcache")]
         Task ClearCache(string accountName, string projectSlug);
 
+        /// <summary>
+        /// Gets a list of projects from AppVeyor.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with a list of AppVeyor projects.</returns>
         [Get("/api/projects")]
         Task<List<AppVeyorProject>> GetProjects();
 
+        /// <summary>
+        /// Gets the history for a given project from AppVeyor.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <param name="recordsPerPage">The numbers of records to return in a page of results.</param>
+        /// <param name="startBuildId">The ID for the build to start with.</param>
+        /// <param name="branch">The name of the branch to use for the request.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the project history.</returns>
         [Get("/api/projects/{accountName}/{projectSlug}/history")]
         Task<AppVeyorProjectHistory> GetProjectHistory(string accountName, string projectSlug, [AliasAs("recordsNumber")] int recordsPerPage, int? startBuildId = null, string branch = null);
 
+        /// <summary>
+        /// Gets the latest build for a given project.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the last build for the project.</returns>
         [Get("/api/projects/{accountName}/{projectSlug}")]
         Task<AppVeyorProjectBuild> GetProjectLastBuild(string accountName, string projectSlug);
 
+        /// <summary>
+        /// Gets the latest build for a given project based on branch name.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <param name="branchName">The name of the branch to use for the request.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the last build for a branch for the project.</returns>
         [Get("/api/projects/{accountName}/{projectSlug}/branch/{branchName}")]
         Task<AppVeyorProjectBuild> GetProjectLastBranchBuild(string accountName, string projectSlug, string branchName);
 
+        /// <summary>
+        /// Gets a specific AppVeyor build based on buil version number.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <param name="buildVersion">The build version number.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the build for the specified version for the project.</returns>
         [Get("/api/projects/{accountName}/{projectSlug}/build/{buildVersion}")]
         Task<AppVeyorProjectBuild> GetProjectBuildByVersion(string accountName, string projectSlug, string buildVersion);
 
+        /// <summary>
+        /// Get the deployments for a given project.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with a lst of deployments for the project.</returns>
         [Get("/api/projects/{accountName}/{projectSlug}/deployments")]
         Task<AppVeyorProjectDeployments> GetProjectDeployments(string accountName, string projectSlug);
 
+        /// <summary>
+        /// Starts a build.
+        /// </summary>
+        /// <param name="buildRequest">An instance of <cref>AppVeyorBuildRequestLatestCommit</cref> identifying which build to start.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the build.</returns>
         [Post("/api/builds")]
         Task<AppVeyorBuild> StartBuildLatestCommit([Body] AppVeyorBuildRequestLatestCommit buildRequest);
 
+        /// <summary>
+        /// Starts a build for a given commit.
+        /// </summary>
+        /// <param name="buildRequest">An instance of <cref>AppVeyorBuildRequestSpecificCommit</cref> identifying which build to start.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the build.</returns>
         [Post("/api/builds")]
         Task<AppVeyorBuild> StartBuildSpecificCommit([Body] AppVeyorBuildRequestSpecificCommit buildRequest);
 
+        /// <summary>
+        /// Starts a build from a pull request.
+        /// </summary>
+        /// <param name="buildRequest">An instance of <cref>AppVeyorBuildRequestPullRequest</cref> identifying which build to start.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the build.</returns>
         [Post("/api/builds")]
         Task<AppVeyorBuild> StartBuildPullRequest([Body] AppVeyorBuildRequestPullRequest buildRequest);
 
+        /// <summary>
+        /// Cancels a build.
+        /// </summary>
+        /// <param name="accountName">The AppVeyor account name.</param>
+        /// <param name="projectSlug">The slug for the project.</param>
+        /// <param name="buildVersion">The build version number.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
         [Delete("/api/builds/{accountName}/{projectSlug}/{buildVersion}")]
         Task CancelBuild(string accountName, string projectSlug, string buildVersion);
 
+        /// <summary>
+        /// Gets a single deployment.
+        /// </summary>
+        /// <param name="deploymentId">ID for the deployment to fetch.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the specified deployment.</returns>
         [Get("/api/deployments/{deploymentId}")]
         Task<AppVeyorProjectDeployment> GetDeployment(int deploymentId);
 
+        /// <summary>
+        /// Starts a deployment.
+        /// </summary>
+        /// <param name="startDeploymentRequest">An instance of <cref>AppVeyorStartDeploymentRequest</cref> identifying which deployment to start.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the deployment that was started.</returns>
         [Post("/api/deployments")]
         Task<AppVeyorDeployment> StartDeployment(AppVeyorStartDeploymentRequest startDeploymentRequest);
 
+        /// <summary>
+        /// Cancels a deployment.
+        /// </summary>
+        /// <param name="cancelDeploymentRequest">An instance of <cref>AppVeyorCancelDeploymentRequest</cref> identifying which deployment to cancel.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
         [Put("/api/deployments/stop")]
         Task CancelDeployment(AppVeyorCancelDeploymentRequest cancelDeploymentRequest);
 
+        /// <summary>
+        /// Gets all environemnts.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the list of environment.</returns>
         [Get("/api/environments")]
         Task<List<AppVeyorEnvironment>> GetEnvironments();
 
+        /// <summary>
+        /// Gets all deployments for a given environment.
+        /// </summary>
+        /// <param name="deploymentEnvironmentId">The ID of the deployment.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation with the deployment for the environment.</returns>
         [Get("/api/environments/{deploymentEnvironmentId}/deployments")]
         Task<AppVeyorEnvironmentDeployments> GetEnvironmentDeployments(int deploymentEnvironmentId);
     }

src/Cake.AppVeyor/Models/AppVeyorBuildRequestLatestCommit.cs

@@ -3,23 +3,41 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// Provides a class to describe the properties of the latest commit of an AppVeyor build.
+    /// </summary>
     public class AppVeyorBuildRequestLatestCommit
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AppVeyorBuildRequestLatestCommit"/> class.
+        /// </summary>
         public AppVeyorBuildRequestLatestCommit()
         {
             Branch = "master";
             EnvironmentVariables = new Dictionary<string, string>();
         }
 
+        /// <summary>
+        /// Gets or sets the AppVeyor Account Name.
+        /// </summary>
         [JsonProperty("accountName")]
         public string AccountName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the AppVeyor Project Slug.
+        /// </summary>
         [JsonProperty("projectSlug")]
         public string ProjectSlug { get; set; }
 
+        /// <summary>
+        /// Gets or sets the branch name for the project.
+        /// </summary>
         [JsonProperty("branch")]
         public string Branch { get; set; }
 
+        /// <summary>
+        /// Gets or sets the environment variables.
+        /// </summary>
         [JsonProperty("environmentVariables")]
         public Dictionary<string, string> EnvironmentVariables { get; set; }
     }

src/Cake.AppVeyor/Models/AppVeyorBuildRequestPullRequest.cs

@@ -2,14 +2,26 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// Provides a class to describe the properties of a pull request build.
+    /// </summary>
     public class AppVeyorBuildRequestPullRequest
     {
+        /// <summary>
+        /// Gets or sets the AppVeyor Account Name.
+        /// </summary>
         [JsonProperty("accountName")]
         public string AccountName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the AppVeyor Project Slug.
+        /// </summary>
         [JsonProperty("projectSlug")]
         public string ProjectSlug { get; set; }
 
+        /// <summary>
+        /// Gets or sets the Pull Request ID.
+        /// </summary>
         [JsonProperty("pullRequestId")]
         public int PullRequestId { get; set; }
     }

src/Cake.AppVeyor/Models/AppVeyorBuildRequestSpecificCommit.cs

@@ -2,22 +2,40 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// Provides a class to describe the properties of a specific commit of an AppVeyor build.
+    /// </summary>
     public class AppVeyorBuildRequestSpecificCommit
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AppVeyorBuildRequestSpecificCommit"/> class.
+        /// </summary>
         public AppVeyorBuildRequestSpecificCommit()
         {
             Branch = "master";
         }
 
+        /// <summary>
+        /// Gets or sets the AppVeyor Account Name.
+        /// </summary>
         [JsonProperty("accountName")]
         public string AccountName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the AppVeyor Project Slug.
+        /// </summary>
         [JsonProperty("projectSlug")]
         public string ProjectSlug { get; set; }
 
+        /// <summary>
+        /// Gets or sets the branch name for the project.
+        /// </summary>
         [JsonProperty("branch")]
         public string Branch { get; set; }
 
+        /// <summary>
+        /// Gets or sets the SHA identifying a specific commit.
+        /// </summary>
         [JsonProperty("commitId")]
         public string CommitId { get; set; }
     }

src/Cake.AppVeyor/Models/AppVeyorCancelDeploymentRequest.cs

@@ -2,8 +2,14 @@
 
 namespace Cake.AppVeyor
 {
+    /// <summary>
+    /// Provides a class to describe the properties of a deployment to be cancelled.
+    /// </summary>
     public class AppVeyorCancelDeploymentRequest
     {
+        /// <summary>
+        /// Gets or sets of the deployment ID.
+        /// </summary>
         [JsonProperty("deploymentId")]
         public int DeploymentId { get; set; }
     }