removed <returns> docs

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

View File

@@ -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");