From f6c42b78c5ed7a23b0020dafb7c8c70bf4099597 Mon Sep 17 00:00:00 2001 From: Cameron MacFarland Date: Tue, 10 Jun 2014 09:03:27 +0800 Subject: [PATCH] Fixing xml docs --- .../Clients/IObservableDeploymentsClient.cs | 2 +- .../Clients/IObservableReleasesClient.cs | 20 +++++------ .../IObservableRepositoryCommentsClient.cs | 2 +- .../Clients/ObservableDeploymentsClient.cs | 2 +- .../Clients/ObservableFollowersClient.cs | 8 ++--- .../Clients/ObservableReleasesClient.cs | 34 ++++++++----------- .../ObservableRepositoryCommentsClient.cs | 2 +- Octokit/Clients/IReleasesClient.cs | 20 +++++------ Octokit/Clients/IRepositoryCommentsClient.cs | 2 +- Octokit/Clients/ReleasesClient.cs | 30 ++++++++-------- Octokit/Clients/RepositoryCommentsClient.cs | 2 +- ...PrivateRepositoryQuotaExceededException.cs | 4 --- Octokit/Helpers/ApiUrls.cs | 18 +++++----- 13 files changed, 69 insertions(+), 77 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableDeploymentsClient.cs b/Octokit.Reactive/Clients/IObservableDeploymentsClient.cs index f5a52394..3a77e846 100644 --- a/Octokit.Reactive/Clients/IObservableDeploymentsClient.cs +++ b/Octokit.Reactive/Clients/IObservableDeploymentsClient.cs @@ -26,7 +26,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// A instance describing the new deployment to create - /// The created + /// The created IObservable Create(string owner, string name, NewDeployment newDeployment); /// diff --git a/Octokit.Reactive/Clients/IObservableReleasesClient.cs b/Octokit.Reactive/Clients/IObservableReleasesClient.cs index 48f76e80..3459e35c 100644 --- a/Octokit.Reactive/Clients/IObservableReleasesClient.cs +++ b/Octokit.Reactive/Clients/IObservableReleasesClient.cs @@ -26,11 +26,11 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// Thrown when a general API error occurs. /// The specified by the id [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] - IObservable Get(string owner, string name, int number); + IObservable Get(string owner, string name, int id); /// /// Creates a new for the specified repository. @@ -53,11 +53,11 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// A description of the release to edit /// Thrown when a general API error occurs. /// The updated . - IObservable EditRelease(string owner, string name, int number, ReleaseUpdate data); + IObservable EditRelease(string owner, string name, int id, ReleaseUpdate data); /// /// Deletes an existing for the specified repository. @@ -67,10 +67,10 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the release to delete + /// The id of the release to delete /// Thrown when a general API error occurs. /// - IObservable DeleteRelease(string owner, string name, int number); + IObservable DeleteRelease(string owner, string name, int id); /// /// Gets all for the specified release of the specified repository. @@ -80,10 +80,10 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// Thrown when a general API error occurs. /// The list of for the specified release of the specified repository. - IObservable GetAssets(string owner, string name, int number); + IObservable GetAssets(string owner, string name, int id); /// /// Uploads a for the specified release. @@ -132,8 +132,8 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// - IObservable DeleteAsset(string owner, string name, int number); + IObservable DeleteAsset(string owner, string name, int id); } } diff --git a/Octokit.Reactive/Clients/IObservableRepositoryCommentsClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryCommentsClient.cs index 2a1faef4..66a93d41 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryCommentsClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryCommentsClient.cs @@ -33,7 +33,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit /// The owner of the repository /// The name of the repository - /// The sha of the commit + /// The sha of the commit /// IObservable GetForCommit(string owner, string name, string sha); diff --git a/Octokit.Reactive/Clients/ObservableDeploymentsClient.cs b/Octokit.Reactive/Clients/ObservableDeploymentsClient.cs index 45e51809..ce5c996a 100644 --- a/Octokit.Reactive/Clients/ObservableDeploymentsClient.cs +++ b/Octokit.Reactive/Clients/ObservableDeploymentsClient.cs @@ -48,7 +48,7 @@ namespace Octokit.Reactive.Clients /// The owner of the repository /// The name of the repository /// A instance describing the new deployment to create - /// The created + /// The created public IObservable Create(string owner, string name, NewDeployment newDeployment) { return _client.Create(owner, name, newDeployment).ToObservable(); diff --git a/Octokit.Reactive/Clients/ObservableFollowersClient.cs b/Octokit.Reactive/Clients/ObservableFollowersClient.cs index e9dadc2e..cefacb36 100644 --- a/Octokit.Reactive/Clients/ObservableFollowersClient.cs +++ b/Octokit.Reactive/Clients/ObservableFollowersClient.cs @@ -28,7 +28,7 @@ namespace Octokit.Reactive /// /// See the API documentation for more information. /// - /// A of s that follow the authenticated user. + /// A of s that follow the authenticated user. public IObservable GetAllForCurrent() { return _connection.GetAndFlattenAllPages(ApiUrls.Followers()); @@ -41,7 +41,7 @@ namespace Octokit.Reactive /// /// See the API documentation for more information. /// - /// A of s that follow the passed user. + /// A of s that follow the passed user. public IObservable GetAll(string login) { Ensure.ArgumentNotNullOrEmptyString(login, "login"); @@ -55,7 +55,7 @@ namespace Octokit.Reactive /// /// See the API documentation for more information. /// - /// A of s that the authenticated user follows. + /// A of s that the authenticated user follows. public IObservable GetFollowingForCurrent() { return _connection.GetAndFlattenAllPages(ApiUrls.Following()); @@ -68,7 +68,7 @@ namespace Octokit.Reactive /// /// See the API documentation for more information. /// - /// A of s that the passed user follows. + /// A of s that the passed user follows. public IObservable GetFollowing(string login) { Ensure.ArgumentNotNullOrEmptyString(login, "login"); diff --git a/Octokit.Reactive/Clients/ObservableReleasesClient.cs b/Octokit.Reactive/Clients/ObservableReleasesClient.cs index 1b9d8c27..e2a52a85 100644 --- a/Octokit.Reactive/Clients/ObservableReleasesClient.cs +++ b/Octokit.Reactive/Clients/ObservableReleasesClient.cs @@ -44,16 +44,15 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// Thrown when a general API error occurs. /// The specified by the id - public IObservable Get(string owner, string name, int number) + public IObservable Get(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - Ensure.ArgumentNotNull(number, "number"); - return _client.Get(owner, name, number).ToObservable(); + return _client.Get(owner, name, id).ToObservable(); } /// @@ -84,17 +83,17 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// A description of the release to edit /// Thrown when a general API error occurs. /// The updated . - public IObservable EditRelease(string owner, string name, int number, ReleaseUpdate data) + public IObservable EditRelease(string owner, string name, int id, ReleaseUpdate data) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(data, "data"); - return _client.EditRelease(owner, name, number, data).ToObservable(); + return _client.EditRelease(owner, name, id, data).ToObservable(); } /// @@ -105,16 +104,15 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the release to delete + /// The id of the release to delete /// Thrown when a general API error occurs. /// - public IObservable DeleteRelease(string owner, string name, int number) + public IObservable DeleteRelease(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - Ensure.ArgumentNotNull(number, "number"); - return _client.DeleteRelease(owner, name, number).ToObservable(); + return _client.DeleteRelease(owner, name, id).ToObservable(); } /// @@ -125,16 +123,15 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// Thrown when a general API error occurs. /// The list of for the specified release of the specified repository. - public IObservable GetAssets(string owner, string name, int number) + public IObservable GetAssets(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - Ensure.ArgumentNotNull(number, "number"); - return _connection.GetAndFlattenAllPages(ApiUrls.ReleaseAssets(owner, name, number)); + return _connection.GetAndFlattenAllPages(ApiUrls.ReleaseAssets(owner, name, id)); } /// @@ -207,15 +204,14 @@ namespace Octokit.Reactive /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// - public IObservable DeleteAsset(string owner, string name, int number) + public IObservable DeleteAsset(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - Ensure.ArgumentNotNull(number, "number"); - return _client.DeleteAsset(owner, name, number).ToObservable(); + return _client.DeleteAsset(owner, name, id).ToObservable(); } } } diff --git a/Octokit.Reactive/Clients/ObservableRepositoryCommentsClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryCommentsClient.cs index 492792e8..8bb70a89 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryCommentsClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryCommentsClient.cs @@ -55,7 +55,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit /// The owner of the repository /// The name of the repository - /// The sha of the commit + /// The sha of the commit /// public IObservable GetForCommit(string owner, string name, string sha) { diff --git a/Octokit/Clients/IReleasesClient.cs b/Octokit/Clients/IReleasesClient.cs index 250f1e43..48939c11 100644 --- a/Octokit/Clients/IReleasesClient.cs +++ b/Octokit/Clients/IReleasesClient.cs @@ -34,11 +34,11 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// Thrown when a general API error occurs. /// The specified by the id [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] - Task Get(string owner, string name, int number); + Task Get(string owner, string name, int id); /// /// Creates a new for the specified repository. @@ -61,11 +61,11 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// A description of the release to edit /// Thrown when a general API error occurs. /// The updated . - Task EditRelease(string owner, string name, int number, ReleaseUpdate data); + Task EditRelease(string owner, string name, int id, ReleaseUpdate data); /// /// Deletes an existing for the specified repository. @@ -75,10 +75,10 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the release to delete + /// The id of the release to delete /// Thrown when a general API error occurs. /// - Task DeleteRelease(string owner, string name, int number); + Task DeleteRelease(string owner, string name, int id); /// /// Gets all for the specified release of the specified repository. @@ -88,10 +88,10 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// Thrown when a general API error occurs. /// The list of for the specified release of the specified repository. - Task> GetAssets(string owner, string name, int number); + Task> GetAssets(string owner, string name, int id); /// /// Uploads a for the specified release. @@ -140,8 +140,8 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// - Task DeleteAsset(string owner, string name, int number); + Task DeleteAsset(string owner, string name, int id); } } diff --git a/Octokit/Clients/IRepositoryCommentsClient.cs b/Octokit/Clients/IRepositoryCommentsClient.cs index cd47654b..11a67545 100644 --- a/Octokit/Clients/IRepositoryCommentsClient.cs +++ b/Octokit/Clients/IRepositoryCommentsClient.cs @@ -39,7 +39,7 @@ namespace Octokit /// http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit /// The owner of the repository /// The name of the repository - /// The sha of the commit + /// The sha of the commit /// Task> GetForCommit(string owner, string name, string sha); diff --git a/Octokit/Clients/ReleasesClient.cs b/Octokit/Clients/ReleasesClient.cs index 1a3af891..139f09a6 100644 --- a/Octokit/Clients/ReleasesClient.cs +++ b/Octokit/Clients/ReleasesClient.cs @@ -48,15 +48,15 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// Thrown when a general API error occurs. /// The specified by the id - public Task Get(string owner, string name, int number) + public Task Get(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - var endpoint = ApiUrls.Releases(owner, name, number); + var endpoint = ApiUrls.Releases(owner, name, id); return ApiConnection.Get(endpoint); } @@ -89,17 +89,17 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the release + /// The id of the release /// A description of the release to edit /// Thrown when a general API error occurs. /// The updated . - public Task EditRelease(string owner, string name, int number, ReleaseUpdate data) + public Task EditRelease(string owner, string name, int id, ReleaseUpdate data) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); Ensure.ArgumentNotNull(data, "data"); - var endpoint = ApiUrls.Releases(owner, name, number); + var endpoint = ApiUrls.Releases(owner, name, id); return ApiConnection.Patch(endpoint, data); } @@ -111,15 +111,15 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the release to delete + /// The id of the release to delete /// Thrown when a general API error occurs. /// - public Task DeleteRelease(string owner, string name, int number) + public Task DeleteRelease(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - var endpoint = ApiUrls.Releases(owner, name, number); + var endpoint = ApiUrls.Releases(owner, name, id); return ApiConnection.Delete(endpoint); } @@ -131,15 +131,15 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// Thrown when a general API error occurs. /// The list of for the specified release of the specified repository. - public Task> GetAssets(string owner, string name, int number) + public Task> GetAssets(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - var endpoint = ApiUrls.ReleaseAssets(owner, name, number); + var endpoint = ApiUrls.ReleaseAssets(owner, name, id); return ApiConnection.GetAll(endpoint, null, "application/vnd.github.v3"); } @@ -216,14 +216,14 @@ namespace Octokit /// /// The repository's owner /// The repository's name - /// The id of the . + /// The id of the . /// - public Task DeleteAsset(string owner, string name, int number) + public Task DeleteAsset(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); - var endpoint = ApiUrls.Assets(owner, name, number); + var endpoint = ApiUrls.Assets(owner, name, id); return ApiConnection.Delete(endpoint); } } diff --git a/Octokit/Clients/RepositoryCommentsClient.cs b/Octokit/Clients/RepositoryCommentsClient.cs index 8f7ccac4..f4017a2a 100644 --- a/Octokit/Clients/RepositoryCommentsClient.cs +++ b/Octokit/Clients/RepositoryCommentsClient.cs @@ -58,7 +58,7 @@ namespace Octokit /// http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit /// The owner of the repository /// The name of the repository - /// The sha of the commit + /// The sha of the commit /// public Task> GetForCommit(string owner, string name, string sha) { diff --git a/Octokit/Exceptions/PrivateRepositoryQuotaExceededException.cs b/Octokit/Exceptions/PrivateRepositoryQuotaExceededException.cs index b21ff1f7..10bff3cf 100644 --- a/Octokit/Exceptions/PrivateRepositoryQuotaExceededException.cs +++ b/Octokit/Exceptions/PrivateRepositoryQuotaExceededException.cs @@ -22,10 +22,6 @@ namespace Octokit /// /// Constructs an instance of PrivateRepositoryQuotaExceededException. /// - /// The login of the owner of the existing repository - /// The name of the existing repository - /// True if the owner is an organization - /// The base address of the repository. /// The inner validation exception. public PrivateRepositoryQuotaExceededException(ApiValidationException innerException) : base(innerException) diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs index 9e4f2c52..984f159c 100644 --- a/Octokit/Helpers/ApiUrls.cs +++ b/Octokit/Helpers/ApiUrls.cs @@ -114,11 +114,11 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The id of the release + /// The id of the release /// - public static Uri Releases(string owner, string name, int number) + public static Uri Releases(string owner, string name, int id) { - return "repos/{0}/{1}/releases/{2}".FormatUri(owner, name, number); + return "repos/{0}/{1}/releases/{2}".FormatUri(owner, name, id); } /// @@ -126,11 +126,11 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The id of the release + /// The id of the release /// - public static Uri ReleaseAssets(string owner, string name, int number) + public static Uri ReleaseAssets(string owner, string name, int id) { - return "repos/{0}/{1}/releases/{2}/assets".FormatUri(owner, name, number); + return "repos/{0}/{1}/releases/{2}/assets".FormatUri(owner, name, id); } /// @@ -151,11 +151,11 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The id of the release asset + /// The id of the release asset /// - public static Uri Assets(string owner, string name, int number) + public static Uri Assets(string owner, string name, int id) { - return "repos/{0}/{1}/releases/assets/{2}".FormatUri(owner, name, number); + return "repos/{0}/{1}/releases/assets/{2}".FormatUri(owner, name, id); } ///