From e690e22637b7e857bfbcaeaae4d0350e0aa6ba2d Mon Sep 17 00:00:00 2001 From: Mordechai Zuber Date: Wed, 20 Jan 2016 15:49:10 +0200 Subject: [PATCH] Fix up xml and add missing docs --- .../IObservableRepositoryPagesClient.cs | 6 ++-- .../ObservableRepositoryPagesClient.cs | 29 +++++++++++++++++++ Octokit/Clients/IRepositoryPagesClient.cs | 6 ++-- Octokit/Clients/RepositoryPagesClient.cs | 6 ++-- 4 files changed, 38 insertions(+), 9 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs index 8e82d59d..9e30b366 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryPagesClient.cs @@ -9,7 +9,7 @@ namespace Octokit.Reactive /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// @@ -20,7 +20,7 @@ namespace Octokit.Reactive /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// @@ -30,7 +30,7 @@ namespace Octokit.Reactive /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// diff --git a/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs index 6c827482..2f44dee6 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryPagesClient.cs @@ -1,5 +1,6 @@ using Octokit.Reactive.Internal; using System; +using System.Diagnostics.CodeAnalysis; using System.Reactive.Threading.Tasks; namespace Octokit.Reactive @@ -17,6 +18,16 @@ namespace Octokit.Reactive _connection = client.Connection; } + /// + /// Gets the page metadata for a given repository + /// + /// The owner of the repository + /// The name of the repository + /// + /// See the API documentation for more information. + /// + /// + [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] public IObservable Get(string owner, string repositoryName) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -25,6 +36,15 @@ namespace Octokit.Reactive return _client.Get(owner, repositoryName).ToObservable(); } + /// + /// Gets all build metadata for a given repository + /// + /// The owner of the repository + /// The name of the repository + /// + /// See the API documentation for more information. + /// + /// public IObservable GetBuilds(string owner, string repositoryName) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -33,6 +53,15 @@ namespace Octokit.Reactive return _connection.GetAndFlattenAllPages(ApiUrls.RepositoryPageBuilds(owner, repositoryName)); } + /// + /// Gets the build metadata for the last build for a given repository + /// + /// The owner of the repository + /// The name of the repository + /// + /// See the API documentation for more information. + /// + /// public IObservable GetLatestBuild(string owner, string repositoryName) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit/Clients/IRepositoryPagesClient.cs b/Octokit/Clients/IRepositoryPagesClient.cs index 668563ac..25c02ea0 100644 --- a/Octokit/Clients/IRepositoryPagesClient.cs +++ b/Octokit/Clients/IRepositoryPagesClient.cs @@ -16,7 +16,7 @@ namespace Octokit /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// @@ -27,7 +27,7 @@ namespace Octokit /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// @@ -37,7 +37,7 @@ namespace Octokit /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// diff --git a/Octokit/Clients/RepositoryPagesClient.cs b/Octokit/Clients/RepositoryPagesClient.cs index 32081088..698a516f 100644 --- a/Octokit/Clients/RepositoryPagesClient.cs +++ b/Octokit/Clients/RepositoryPagesClient.cs @@ -24,7 +24,7 @@ namespace Octokit /// Gets the page metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// @@ -41,7 +41,7 @@ namespace Octokit /// Gets all build metadata for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. /// @@ -58,7 +58,7 @@ namespace Octokit /// Gets the build metadata for the last build for a given repository /// /// The owner of the repository - /// The name of the repository + /// The name of the repository /// /// See the API documentation for more information. ///