zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-03 03:01:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleared <returns> tags

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-17 05:44:24 +07:00
parent 8e3d7be4cd
commit 3fefc4879e
4 changed files with 88 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
+22 -22
View File
@@ -25,7 +25,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The number of the pull request</param>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<PullRequest> Get(string owner, string name, int number);
@@ -38,7 +38,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The number of the pull request</param>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<PullRequest> Get(int repositoryId, int number);
@@ -51,7 +51,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name);
/// <summary>
@@ -61,7 +61,7 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId);
/// <summary>
@@ -73,7 +73,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -84,7 +84,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
@@ -96,7 +96,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name, PullRequestRequest request);
/// <summary>
@@ -107,7 +107,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request);
/// <summary>
@@ -120,7 +120,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(string owner, string name, PullRequestRequest request, ApiOptions options);
/// <summary>
@@ -132,7 +132,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options);
/// <summary>
@@ -142,7 +142,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A created <see cref="PullRequest"/> result</returns>
/// <returns></returns>
IObservable<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest);
/// <summary>
@@ -151,7 +151,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A created <see cref="PullRequest"/> result</returns>
/// <returns></returns>
IObservable<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest);
/// <summary>
@@ -163,7 +163,7 @@ namespace Octokit.Reactive
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
IObservable<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
@@ -174,7 +174,7 @@ namespace Octokit.Reactive
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
IObservable<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
@@ -185,7 +185,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
/// <returns></returns>
IObservable<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest);
/// <summary>
@@ -195,7 +195,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
/// <returns></returns>
IObservable<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest);
/// <summary>
@@ -205,7 +205,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
/// <returns></returns>
IObservable<bool> Merged(string owner, string name, int number);
/// <summary>
@@ -214,7 +214,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
/// <returns></returns>
IObservable<bool> Merged(int repositoryId, int number);
/// <summary>
@@ -224,7 +224,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
/// <returns></returns>
IObservable<PullRequestCommit> Commits(string owner, string name, int number);
/// <summary>
@@ -233,7 +233,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
/// <returns></returns>
IObservable<PullRequestCommit> Commits(int repositoryId, int number);
/// <summary>
@@ -243,7 +243,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
/// <returns></returns>
IObservable<PullRequestFile> Files(string owner, string name, int number);
/// <summary>
@@ -252,7 +252,7 @@ namespace Octokit.Reactive
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
/// <returns></returns>
IObservable<PullRequestFile> Files(int repositoryId, int number);
}
}
Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
+22 -22
View File
@@ -35,7 +35,7 @@ namespace Octokit.Reactive
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public IObservable<PullRequest> Get(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -52,7 +52,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The number of the pull request</param>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public IObservable<PullRequest> Get(int repositoryId, int number)
{
return _client.Get(repositoryId, number).ToObservable();
@@ -66,7 +66,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -82,7 +82,7 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId)
{
return GetAllForRepository(repositoryId, ApiOptions.None);
@@ -97,7 +97,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -115,7 +115,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
@@ -132,7 +132,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(string owner, string name, PullRequestRequest request)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -150,7 +150,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request)
{
Ensure.ArgumentNotNull(request, "request");
@@ -168,7 +168,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(string owner, string name, PullRequestRequest request, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -189,7 +189,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A collection of <see cref="PullRequest"/> results</returns>
/// <returns></returns>
public IObservable<PullRequest> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options)
{
Ensure.ArgumentNotNull(request, "request");
@@ -206,7 +206,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A created <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public IObservable<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -222,7 +222,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A created <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public IObservable<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest)
{
Ensure.ArgumentNotNull(newPullRequest, "newPullRequest");
@@ -239,7 +239,7 @@ namespace Octokit.Reactive
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public IObservable<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -257,7 +257,7 @@ namespace Octokit.Reactive
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public IObservable<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate)
{
Ensure.ArgumentNotNull(pullRequestUpdate, "pullRequestUpdate");
@@ -273,7 +273,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
/// <returns></returns>
public IObservable<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -290,7 +290,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>A <see cref="PullRequestMerge"/> result</returns>
/// <returns></returns>
public IObservable<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest)
{
Ensure.ArgumentNotNull(mergePullRequest, "mergePullRequest");
@@ -305,7 +305,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
/// <returns></returns>
public IObservable<bool> Merged(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -320,7 +320,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="bool"/> result - true if the pull request has been merged, false otherwise</returns>
/// <returns></returns>
public IObservable<bool> Merged(int repositoryId, int number)
{
return _client.Merged(repositoryId, number).ToObservable();
@@ -333,7 +333,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
/// <returns></returns>
public IObservable<PullRequestCommit> Commits(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -348,7 +348,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestCommit"/> results</returns>
/// <returns></returns>
public IObservable<PullRequestCommit> Commits(int repositoryId, int number)
{
return _connection.GetAndFlattenAllPages<PullRequestCommit>(ApiUrls.PullRequestCommits(repositoryId, number));
@@ -361,7 +361,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
/// <returns></returns>
public IObservable<PullRequestFile> Files(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -376,7 +376,7 @@ namespace Octokit.Reactive
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A collection of <see cref="PullRequestFile"/> results</returns>
/// <returns></returns>
public IObservable<PullRequestFile> Files(int repositoryId, int number)
{
return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number));
Octokit/Clients/IPullRequestsClient.cs
+22 -22
View File
@@ -23,7 +23,7 @@ namespace Octokit
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task<PullRequest> Get(string owner, string name, int number);
@@ -34,7 +34,7 @@ namespace Octokit
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task<PullRequest> Get(int repositoryId, int number);
@@ -47,7 +47,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name);
/// <summary>
@@ -57,7 +57,7 @@ namespace Octokit
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId);
/// <summary>
@@ -69,7 +69,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -80,7 +80,7 @@ namespace Octokit
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
@@ -92,7 +92,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, PullRequestRequest request);
/// <summary>
@@ -103,7 +103,7 @@ namespace Octokit
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request);
/// <summary>
@@ -116,7 +116,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, PullRequestRequest request, ApiOptions options);
/// <summary>
@@ -128,7 +128,7 @@ namespace Octokit
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options);
/// <summary>
@@ -138,7 +138,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
/// <returns></returns>
Task<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest);
/// <summary>
@@ -147,7 +147,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
/// <returns></returns>
Task<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest);
/// <summary>
@@ -159,7 +159,7 @@ namespace Octokit
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
Task<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
@@ -170,7 +170,7 @@ namespace Octokit
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
Task<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate);
/// <summary>
@@ -181,7 +181,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
/// <returns></returns>
Task<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest);
/// <summary>
@@ -191,7 +191,7 @@ namespace Octokit
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
/// <returns></returns>
Task<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest);
/// <summary>
@@ -201,7 +201,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>True if the operation has been merged, false otherwise</returns>
/// <returns></returns>
Task<bool> Merged(string owner, string name, int number);
/// <summary>
@@ -210,7 +210,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>True if the operation has been merged, false otherwise</returns>
/// <returns></returns>
Task<bool> Merged(int repositoryId, int number);
/// <summary>
@@ -220,7 +220,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequestCommit>> Commits(string owner, string name, int number);
/// <summary>
@@ -229,7 +229,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequestCommit>> Commits(int repositoryId, int number);
/// <summary>
@@ -239,7 +239,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number);
/// <summary>
@@ -248,7 +248,7 @@ namespace Octokit
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
/// <returns></returns>
Task<IReadOnlyList<PullRequestFile>> Files(int repositoryId, int number);
}
}
Octokit/Clients/PullRequestsClient.cs
+22 -22
View File
@@ -28,7 +28,7 @@ namespace Octokit
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public Task<PullRequest> Get(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -43,7 +43,7 @@ namespace Octokit
/// <remarks>
/// http://developer.github.com/v3/pulls/#get-a-single-pull-request
/// </remarks>
/// <returns>A <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public Task<PullRequest> Get(int repositoryId, int number)
{
return ApiConnection.Get<PullRequest>(ApiUrls.PullRequest(repositoryId, number));
@@ -57,7 +57,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -73,7 +73,7 @@ namespace Octokit
/// http://developer.github.com/v3/pulls/#list-pull-requests
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId)
{
return GetAllForRepository(repositoryId, new PullRequestRequest(), ApiOptions.None);
@@ -88,7 +88,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -106,7 +106,7 @@ namespace Octokit
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which are currently open</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
@@ -123,7 +123,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, PullRequestRequest request)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -141,7 +141,7 @@ namespace Octokit
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request)
{
Ensure.ArgumentNotNull(request, "request");
@@ -159,7 +159,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(string owner, string name, PullRequestRequest request, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -180,7 +180,7 @@ namespace Octokit
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter and sort the list of pull requests returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{PullRequest}"/> of <see cref="PullRequest"/>s which match the criteria</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequest>> GetAllForRepository(int repositoryId, PullRequestRequest request, ApiOptions options)
{
Ensure.ArgumentNotNull(request, "request");
@@ -197,7 +197,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
/// <returns></returns>
public Task<PullRequest> Create(string owner, string name, NewPullRequest newPullRequest)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -213,7 +213,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/pulls/#create-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="newPullRequest">A <see cref="NewPullRequest"/> instance describing the new PullRequest to create</param>
/// <returns>A <see cref="PullRequest"/> result which was created on the server</returns>
/// <returns></returns>
public Task<PullRequest> Create(int repositoryId, NewPullRequest newPullRequest)
{
Ensure.ArgumentNotNull(newPullRequest, "newPullRequest");
@@ -230,7 +230,7 @@ namespace Octokit
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public Task<PullRequest> Update(string owner, string name, int number, PullRequestUpdate pullRequestUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -248,7 +248,7 @@ namespace Octokit
/// <param name="number">The PullRequest number</param>
/// <param name="pullRequestUpdate">An <see cref="PullRequestUpdate"/> instance describing the changes to make to the PullRequest
/// </param>
/// <returns>An updated <see cref="PullRequest"/> result</returns>
/// <returns></returns>
public Task<PullRequest> Update(int repositoryId, int number, PullRequestUpdate pullRequestUpdate)
{
Ensure.ArgumentNotNull(pullRequestUpdate, "pullRequestUpdate");
@@ -264,7 +264,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
/// <returns></returns>
public async Task<PullRequestMerge> Merge(string owner, string name, int number, MergePullRequest mergePullRequest)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -300,7 +300,7 @@ namespace Octokit
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="mergePullRequest">A <see cref="MergePullRequest"/> instance describing a pull request merge</param>
/// <returns>An <see cref="PullRequestMerge"/> result which indicates the merge result</returns>
/// <returns></returns>
public async Task<PullRequestMerge> Merge(int repositoryId, int number, MergePullRequest mergePullRequest)
{
Ensure.ArgumentNotNull(mergePullRequest, "mergePullRequest");
@@ -334,7 +334,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>True if the operation has been merged, false otherwise</returns>
/// <returns></returns>
public async Task<bool> Merged(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -358,7 +358,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>True if the operation has been merged, false otherwise</returns>
/// <returns></returns>
public async Task<bool> Merged(int repositoryId, int number)
{
try
@@ -380,7 +380,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequestCommit>> Commits(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -395,7 +395,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestCommit}"/> of <see cref="Commit"/>s which are part of this pull request</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequestCommit>> Commits(int repositoryId, int number)
{
return ApiConnection.GetAll<PullRequestCommit>(ApiUrls.PullRequestCommits(repositoryId, number));
@@ -408,7 +408,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -423,7 +423,7 @@ namespace Octokit
/// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>A <see cref="IReadOnlyList{PullRequestFile}"/> which are part of this pull request</returns>
/// <returns></returns>
public Task<IReadOnlyList<PullRequestFile>> Files(int repositoryId, int number)
{
return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number));