mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-07 04:16:51 +00:00
cleared <returns> tags
This commit is contained in:
@@ -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);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user