zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-21 06:35:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

removed <returns> docs

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-17 05:11:21 +07:00
committed by aedampir@gmail.com
parent c3419929b5
commit eb8ac94d78
4 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs
View File

@@ -18,7 +18,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="base">The reference to use as the base commit</param>
/// <param name="head">The reference to use as the head commit</param>
/// <returns>A <see cref="IObservable{CompareResult}"/> of <see cref="CompareResult"/> for the specified references.</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
IObservable<CompareResult> Compare(string owner, string name, string @base, string head);
@@ -28,7 +28,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="base">The reference to use as the base commit</param>
/// <param name="head">The reference to use as the head commit</param>
/// <returns>A <see cref="IObservable{CompareResult}"/> of <see cref="CompareResult"/> for the specified references.</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
IObservable<CompareResult> Compare(int repositoryId, string @base, string head);
@@ -38,7 +38,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The reference for the commit</param>
/// <returns>A <see cref="IObservable{CompareResult}"/> of <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<GitHubCommit> Get(string owner, string name, string reference);
@@ -48,7 +48,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="reference">The reference for the commit</param>
/// <returns>A <see cref="IObservable{CompareResult}"/> of <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<GitHubCommit> Get(int repositoryId, string reference);
@@ -58,14 +58,14 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(string owner, string name);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(int repositoryId);
/// <summary>
@@ -74,7 +74,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 <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(string owner, string name, ApiOptions options);
/// <summary>
@@ -82,7 +82,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(int repositoryId, ApiOptions options);
/// <summary>
@@ -91,7 +91,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 list of commits returned</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(string owner, string name, CommitRequest request);
/// <summary>
@@ -99,7 +99,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter list of commits returned</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(int repositoryId, CommitRequest request);
/// <summary>
@@ -109,7 +109,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter list of commits returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(string owner, string name, CommitRequest request, ApiOptions options);
/// <summary>
@@ -118,7 +118,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter list of commits returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
/// <returns></returns>
IObservable<GitHubCommit> GetAll(int repositoryId, CommitRequest request, ApiOptions options);
/// <summary>
@@ -127,7 +127,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The repository reference</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="string"/> for the specified repository reference.</returns>
/// <returns></returns>
IObservable<string> GetSha1(string owner, string name, string reference);
/// <summary>
@@ -135,7 +135,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="reference">The repository reference</param>
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="string"/> for the specified repository reference.</returns>
/// <returns></returns>
IObservable<string> GetSha1(int repositoryId, string reference);
}
}