cleared <returns> tags

This commit is contained in:
Alexander Efremov
2016-06-17 05:49:46 +07:00
parent 0aa2041f4d
commit 08fd8e01c1
4 changed files with 60 additions and 60 deletions
@@ -16,14 +16,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 list of <see cref="Contributor"/></returns>
/// <returns></returns>
IObservable<IEnumerable<Contributor>> GetContributors(string owner, string name);
/// <summary>
/// Returns a list of <see cref="Contributor"/> for the given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
IObservable<IEnumerable<Contributor>> GetContributors(int repositoryId);
/// <summary>
@@ -31,14 +31,14 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
IObservable<CommitActivity> GetCommitActivity(string owner, string name);
/// <summary>
/// Returns the last year of commit activity grouped by week.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
IObservable<CommitActivity> GetCommitActivity(int repositoryId);
/// <summary>
@@ -46,14 +46,14 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
IObservable<CodeFrequency> GetCodeFrequency(string owner, string name);
/// <summary>
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
IObservable<CodeFrequency> GetCodeFrequency(int repositoryId);
/// <summary>
@@ -61,14 +61,14 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
IObservable<Participation> GetParticipation(string owner, string name);
/// <summary>
/// Returns the total commit counts for the owner and total commit counts in total.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
IObservable<Participation> GetParticipation(int repositoryId);
/// <summary>
@@ -76,14 +76,14 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
IObservable<PunchCard> GetPunchCard(string owner, string name);
/// <summary>
/// Returns a list of the number of commits per hour in each day
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
IObservable<PunchCard> GetPunchCard(int repositoryId);
}
}
@@ -26,7 +26,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 list of <see cref="Contributor"/></returns>
/// <returns></returns>
public IObservable<IEnumerable<Contributor>> GetContributors(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -39,7 +39,7 @@ namespace Octokit.Reactive
/// Returns a list of <see cref="Contributor"/> for the given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
public IObservable<IEnumerable<Contributor>> GetContributors(int repositoryId)
{
return _client.Repository.Statistics.GetContributors(repositoryId).ToObservable();
@@ -50,7 +50,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
public IObservable<CommitActivity> GetCommitActivity(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -63,7 +63,7 @@ namespace Octokit.Reactive
/// Returns the last year of commit activity grouped by week.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
public IObservable<CommitActivity> GetCommitActivity(int repositoryId)
{
return _client.Repository.Statistics.GetCommitActivity(repositoryId).ToObservable();
@@ -74,7 +74,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
public IObservable<CodeFrequency> GetCodeFrequency(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -87,7 +87,7 @@ namespace Octokit.Reactive
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
public IObservable<CodeFrequency> GetCodeFrequency(int repositoryId)
{
return _client.Repository.Statistics.GetCodeFrequency(repositoryId).ToObservable();
@@ -98,7 +98,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
public IObservable<Participation> GetParticipation(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -111,7 +111,7 @@ namespace Octokit.Reactive
/// Returns the total commit counts for the owner and total commit counts in total.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
public IObservable<Participation> GetParticipation(int repositoryId)
{
return _client.Repository.Statistics.GetParticipation(repositoryId).ToObservable();
@@ -122,7 +122,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
public IObservable<PunchCard> GetPunchCard(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -135,7 +135,7 @@ namespace Octokit.Reactive
/// Returns a list of the number of commits per hour in each day
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
public IObservable<PunchCard> GetPunchCard(int repositoryId)
{
return _client.Repository.Statistics.GetPunchCard(repositoryId).ToObservable();
+20 -20
View File
@@ -17,14 +17,14 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
Task<IReadOnlyList<Contributor>> GetContributors(string owner, string name);
/// <summary>
/// Returns a list of <see cref="Contributor"/> for the given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
Task<IReadOnlyList<Contributor>> GetContributors(int repositoryId);
/// <summary>
@@ -33,7 +33,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
Task<IReadOnlyList<Contributor>> GetContributors(string owner, string name, CancellationToken cancellationToken);
/// <summary>
@@ -41,7 +41,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
Task<IReadOnlyList<Contributor>> GetContributors(int repositoryId, CancellationToken cancellationToken);
/// <summary>
@@ -49,14 +49,14 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
Task<CommitActivity> GetCommitActivity(string owner, string name);
/// <summary>
/// Returns the last year of commit activity grouped by week.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
Task<CommitActivity> GetCommitActivity(int repositoryId);
/// <summary>
@@ -65,7 +65,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
Task<CommitActivity> GetCommitActivity(string owner, string name, CancellationToken cancellationToken);
/// <summary>
@@ -73,7 +73,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
Task<CommitActivity> GetCommitActivity(int repositoryId, CancellationToken cancellationToken);
/// <summary>
@@ -81,14 +81,14 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
Task<CodeFrequency> GetCodeFrequency(string owner, string name);
/// <summary>
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
Task<CodeFrequency> GetCodeFrequency(int repositoryId);
/// <summary>
@@ -97,7 +97,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
Task<CodeFrequency> GetCodeFrequency(string owner, string name, CancellationToken cancellationToken);
/// <summary>
@@ -105,7 +105,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
Task<CodeFrequency> GetCodeFrequency(int repositoryId, CancellationToken cancellationToken);
/// <summary>
@@ -113,14 +113,14 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
Task<Participation> GetParticipation(string owner, string name);
/// <summary>
/// Returns the total commit counts for the owner and total commit counts in total.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
Task<Participation> GetParticipation(int repositoryId);
/// <summary>
@@ -129,7 +129,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
Task<Participation> GetParticipation(string owner, string name, CancellationToken cancellationToken);
/// <summary>
@@ -137,7 +137,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
Task<Participation> GetParticipation(int repositoryId, CancellationToken cancellationToken);
/// <summary>
@@ -145,14 +145,14 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
Task<PunchCard> GetPunchCard(string owner, string name);
/// <summary>
/// Returns a list of the number of commits per hour in each day
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
Task<PunchCard> GetPunchCard(int repositoryId);
/// <summary>
@@ -161,7 +161,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
Task<PunchCard> GetPunchCard(string owner, string name, CancellationToken cancellationToken);
/// <summary>
@@ -169,7 +169,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
Task<PunchCard> GetPunchCard(int repositoryId, CancellationToken cancellationToken);
}
}
+20 -20
View File
@@ -26,7 +26,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
public Task<IReadOnlyList<Contributor>> GetContributors(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -39,7 +39,7 @@ namespace Octokit
/// Returns a list of <see cref="Contributor"/> for the given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
public Task<IReadOnlyList<Contributor>> GetContributors(int repositoryId)
{
return GetContributors(repositoryId, CancellationToken.None);
@@ -51,7 +51,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
public Task<IReadOnlyList<Contributor>> GetContributors(string owner, string name, CancellationToken cancellationToken)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -65,7 +65,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>A list of <see cref="Contributor"/></returns>
/// <returns></returns>
public Task<IReadOnlyList<Contributor>> GetContributors(int repositoryId, CancellationToken cancellationToken)
{
return ApiConnection.GetQueuedOperation<Contributor>(ApiUrls.StatsContributors(repositoryId), cancellationToken);
@@ -76,7 +76,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
public Task<CommitActivity> GetCommitActivity(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -89,7 +89,7 @@ namespace Octokit
/// Returns the last year of commit activity grouped by week.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
public Task<CommitActivity> GetCommitActivity(int repositoryId)
{
return GetCommitActivity(repositoryId, CancellationToken.None);
@@ -101,7 +101,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
public async Task<CommitActivity> GetCommitActivity(string owner, string name, CancellationToken cancellationToken)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -117,7 +117,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
/// <returns></returns>
public async Task<CommitActivity> GetCommitActivity(int repositoryId, CancellationToken cancellationToken)
{
var activity = await ApiConnection.GetQueuedOperation<WeeklyCommitActivity>(
@@ -130,7 +130,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
public Task<CodeFrequency> GetCodeFrequency(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -143,7 +143,7 @@ namespace Octokit
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
public Task<CodeFrequency> GetCodeFrequency(int repositoryId)
{
return GetCodeFrequency(repositoryId, CancellationToken.None);
@@ -155,7 +155,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
public async Task<CodeFrequency> GetCodeFrequency(string owner, string name, CancellationToken cancellationToken)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -171,7 +171,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
/// <returns></returns>
public async Task<CodeFrequency> GetCodeFrequency(int repositoryId, CancellationToken cancellationToken)
{
var rawFrequencies = await ApiConnection.GetQueuedOperation<long[]>(
@@ -184,7 +184,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
public Task<Participation> GetParticipation(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -197,7 +197,7 @@ namespace Octokit
/// Returns the total commit counts for the owner and total commit counts in total.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
public Task<Participation> GetParticipation(int repositoryId)
{
return GetParticipation(repositoryId, CancellationToken.None);
@@ -209,7 +209,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
public async Task<Participation> GetParticipation(string owner, string name, CancellationToken cancellationToken)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -225,7 +225,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
/// <returns></returns>
public async Task<Participation> GetParticipation(int repositoryId, CancellationToken cancellationToken)
{
var result = await ApiConnection.GetQueuedOperation<Participation>(
@@ -238,7 +238,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
public Task<PunchCard> GetPunchCard(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -251,7 +251,7 @@ namespace Octokit
/// Returns a list of the number of commits per hour in each day
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
public Task<PunchCard> GetPunchCard(int repositoryId)
{
return GetPunchCard(repositoryId, CancellationToken.None);
@@ -263,7 +263,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
public async Task<PunchCard> GetPunchCard(string owner, string name, CancellationToken cancellationToken)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -279,7 +279,7 @@ namespace Octokit
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="cancellationToken">A token used to cancel this potentially long running request</param>
/// <returns>Returns commit counts per hour in each day</returns>
/// <returns></returns>
public async Task<PunchCard> GetPunchCard(int repositoryId, CancellationToken cancellationToken)
{
var punchCardData = await ApiConnection.GetQueuedOperation<int[]>(