zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-07 12:26:18 +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/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);
}
}