mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-21 14:45:11 +00:00
removed <returns> docs
This commit is contained in:
committed by
aedampir@gmail.com
parent
c3419929b5
commit
eb8ac94d78
@@ -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);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -30,7 +30,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>
|
||||
public IObservable<CompareResult> Compare(string owner, string name, string @base, string head)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -47,7 +47,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>
|
||||
public IObservable<CompareResult> Compare(int repositoryId, string @base, string head)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(@base, "base");
|
||||
@@ -62,7 +62,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>
|
||||
public IObservable<GitHubCommit> Get(string owner, string name, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -77,7 +77,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>
|
||||
public IObservable<GitHubCommit> Get(int repositoryId, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, "reference");
|
||||
@@ -90,7 +90,7 @@ 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>
|
||||
public IObservable<GitHubCommit> GetAll(string owner, string name)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -103,7 +103,7 @@ namespace Octokit.Reactive
|
||||
/// 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>
|
||||
public IObservable<GitHubCommit> GetAll(int repositoryId)
|
||||
{
|
||||
return GetAll(repositoryId, new CommitRequest(), ApiOptions.None);
|
||||
@@ -115,7 +115,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>
|
||||
public IObservable<GitHubCommit> GetAll(string owner, string name, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -130,7 +130,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>
|
||||
public IObservable<GitHubCommit> GetAll(int repositoryId, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNull(options, "options");
|
||||
@@ -144,7 +144,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>
|
||||
public IObservable<GitHubCommit> GetAll(string owner, string name, CommitRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -159,7 +159,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>
|
||||
public IObservable<GitHubCommit> GetAll(int repositoryId, CommitRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNull(request, "request");
|
||||
@@ -174,7 +174,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>
|
||||
public IObservable<GitHubCommit> GetAll(string owner, string name, CommitRequest request, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -191,7 +191,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>
|
||||
public IObservable<GitHubCommit> GetAll(int repositoryId, CommitRequest 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="reference">The repository reference</param>
|
||||
/// <returns>A <see cref="IObservable{GitHubCommit}"/> of <see cref="string"/> for the specified repository reference.</returns>
|
||||
/// <returns></returns>
|
||||
public IObservable<string> GetSha1(string owner, string name, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -221,7 +221,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>
|
||||
public IObservable<string> GetSha1(int repositoryId, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, "reference");
|
||||
|
||||
@@ -19,7 +19,7 @@ namespace Octokit
|
||||
/// <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="CompareResult"/> for the specified references.</returns>
|
||||
/// <returns></returns>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
|
||||
Task<CompareResult> Compare(string owner, string name, string @base, string head);
|
||||
|
||||
@@ -29,7 +29,7 @@ namespace Octokit
|
||||
/// <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="CompareResult"/> for the specified references.</returns>
|
||||
/// <returns></returns>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
|
||||
Task<CompareResult> Compare(int repositoryId, string @base, string head);
|
||||
|
||||
@@ -39,7 +39,7 @@ namespace Octokit
|
||||
/// <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 (SHA)</param>
|
||||
/// <returns>A <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
|
||||
/// <returns></returns>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
||||
Justification = "Makes a network request")]
|
||||
Task<GitHubCommit> Get(string owner, string name, string reference);
|
||||
@@ -49,7 +49,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <param name="reference">The reference for the commit (SHA)</param>
|
||||
/// <returns>A <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
|
||||
/// <returns></returns>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
||||
Justification = "Makes a network request")]
|
||||
Task<GitHubCommit> Get(int repositoryId, string reference);
|
||||
@@ -59,14 +59,14 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId);
|
||||
|
||||
/// <summary>
|
||||
@@ -75,7 +75,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{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
@@ -83,7 +83,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(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 list of commits returned</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request);
|
||||
|
||||
/// <summary>
|
||||
@@ -100,7 +100,7 @@ namespace Octokit
|
||||
/// </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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, CommitRequest request);
|
||||
|
||||
/// <summary>
|
||||
@@ -110,7 +110,7 @@ namespace Octokit
|
||||
/// <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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
@@ -119,7 +119,7 @@ namespace Octokit
|
||||
/// <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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, CommitRequest request, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
@@ -128,7 +128,7 @@ namespace Octokit
|
||||
/// <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="string"/> for the specified repository reference.</returns>
|
||||
/// <returns></returns>
|
||||
Task<string> GetSha1(string owner, string name, string reference);
|
||||
|
||||
/// <summary>
|
||||
@@ -136,7 +136,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <param name="reference">The repository reference</param>
|
||||
/// <returns>A <see cref="string"/> for the specified repository reference.</returns>
|
||||
/// <returns></returns>
|
||||
Task<string> GetSha1(int repositoryId, string reference);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,7 +23,7 @@ namespace Octokit
|
||||
/// <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="CompareResult"/> for the specified references.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<CompareResult> Compare(string owner, string name, string @base, string head)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -40,7 +40,7 @@ namespace Octokit
|
||||
/// <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="CompareResult"/> for the specified references.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<CompareResult> Compare(int repositoryId, string @base, string head)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(@base, "base");
|
||||
@@ -55,7 +55,7 @@ namespace Octokit
|
||||
/// <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 (SHA)</param>
|
||||
/// <returns>A <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<GitHubCommit> Get(string owner, string name, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -70,7 +70,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <param name="reference">The reference for the commit (SHA)</param>
|
||||
/// <returns>A <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<GitHubCommit> Get(int repositoryId, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, "reference");
|
||||
@@ -83,7 +83,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -96,7 +96,7 @@ namespace Octokit
|
||||
/// Gets all commits for a given repository
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId)
|
||||
{
|
||||
return GetAll(repositoryId, new CommitRequest(), ApiOptions.None);
|
||||
@@ -108,7 +108,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{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -122,7 +122,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, ApiOptions options)
|
||||
{
|
||||
return GetAll(repositoryId, new CommitRequest(), options);
|
||||
@@ -134,7 +134,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 list of commits returned</param>
|
||||
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -149,7 +149,7 @@ namespace Octokit
|
||||
/// </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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, CommitRequest request)
|
||||
{
|
||||
Ensure.ArgumentNotNull(request, "request");
|
||||
@@ -164,7 +164,7 @@ namespace Octokit
|
||||
/// <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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -181,7 +181,7 @@ namespace Octokit
|
||||
/// <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="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, CommitRequest request, ApiOptions options)
|
||||
{
|
||||
Ensure.ArgumentNotNull(request, "request");
|
||||
@@ -196,7 +196,7 @@ namespace Octokit
|
||||
/// <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="string"/> for the specified repository reference.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<string> GetSha1(string owner, string name, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -211,7 +211,7 @@ namespace Octokit
|
||||
/// </summary>
|
||||
/// <param name="repositoryId">The ID of the repository</param>
|
||||
/// <param name="reference">The repository reference</param>
|
||||
/// <returns>A <see cref="string"/> for the specified repository reference.</returns>
|
||||
/// <returns></returns>
|
||||
public Task<string> GetSha1(int repositoryId, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(reference, "reference");
|
||||
|
||||
Reference in New Issue
Block a user