zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-09 13:01:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixing xml docs

Browse Source
This commit is contained in:
Cameron MacFarland
2014-06-10 09:03:27 +08:00
parent 3ffcc17dfd
commit f6c42b78c5
13 changed files with 69 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableDeploymentsClient.cs
+1 -1
View File
@@ -26,7 +26,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newDeployment">A <see cref="NewDeployment"/> instance describing the new deployment to create</param>
/// <returns>The created <see cref="Deployment"></returns>
/// <returns>The created <see cref="Deployment"/></returns>
IObservable<Deployment> Create(string owner, string name, NewDeployment newDeployment);
/// <summary>
Octokit.Reactive/Clients/IObservableReleasesClient.cs
+10 -10
View File
@@ -26,11 +26,11 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")]
IObservable<Release> Get(string owner, string name, int number);
IObservable<Release> Get(string owner, string name, int id);
/// <summary>
/// Creates a new <see cref="Release"/> for the specified repository.
@@ -53,11 +53,11 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns>
IObservable<Release> EditRelease(string owner, string name, int number, ReleaseUpdate data);
IObservable<Release> EditRelease(string owner, string name, int id, ReleaseUpdate data);
/// <summary>
/// Deletes an existing <see cref="Release"/> for the specified repository.
@@ -67,10 +67,10 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release to delete</param>
/// <param name="id">The id of the release to delete</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns></returns>
IObservable<Unit> DeleteRelease(string owner, string name, int number);
IObservable<Unit> DeleteRelease(string owner, string name, int id);
/// <summary>
/// Gets all <see cref="ReleaseAsset"/> for the specified release of the specified repository.
@@ -80,10 +80,10 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="Release"/>.</param>
/// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns>
IObservable<ReleaseAsset> GetAssets(string owner, string name, int number);
IObservable<ReleaseAsset> GetAssets(string owner, string name, int id);
/// <summary>
/// Uploads a <see cref="ReleaseAsset"/> for the specified release.
@@ -132,8 +132,8 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="ReleaseAsset"/>.</param>
/// <param name="id">The id of the <see cref="ReleaseAsset"/>.</param>
/// <returns></returns>
IObservable<Unit> DeleteAsset(string owner, string name, int number);
IObservable<Unit> DeleteAsset(string owner, string name, int id);
}
}
Octokit.Reactive/Clients/IObservableRepositoryCommentsClient.cs
+1 -1
View File
@@ -33,7 +33,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The sha of the commit</param>
/// <param name="sha">The sha of the commit</param>
/// <returns></returns>
IObservable<CommitComment> GetForCommit(string owner, string name, string sha);
Octokit.Reactive/Clients/ObservableDeploymentsClient.cs
+1 -1
View File
@@ -48,7 +48,7 @@ namespace Octokit.Reactive.Clients
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newDeployment">A <see cref="NewDeployment"/> instance describing the new deployment to create</param>
/// <returns>The created <see cref="Deployment"></returns>
/// <returns>The created <see cref="Deployment"/></returns>
public IObservable<Deployment> Create(string owner, string name, NewDeployment newDeployment)
{
return _client.Create(owner, name, newDeployment).ToObservable();
Octokit.Reactive/Clients/ObservableFollowersClient.cs
+4 -4
View File
@@ -28,7 +28,7 @@ namespace Octokit.Reactive
/// <remarks>
/// See the <a href="http://developer.github.com/v3/users/followers/#list-followers-of-a-user">API documentation</a> for more information.
/// </remarks>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/>s that follow the authenticated user.</returns>
/// <returns>A <see cref="System.Collections.Generic.IReadOnlyList{User}"/> of <see cref="User"/>s that follow the authenticated user.</returns>
public IObservable<User> GetAllForCurrent()
{
return _connection.GetAndFlattenAllPages<User>(ApiUrls.Followers());
@@ -41,7 +41,7 @@ namespace Octokit.Reactive
/// <remarks>
/// See the <a href="http://developer.github.com/v3/users/followers/#list-followers-of-a-user">API documentation</a> for more information.
/// </remarks>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/>s that follow the passed user.</returns>
/// <returns>A <see cref="System.Collections.Generic.IReadOnlyList{User}"/> of <see cref="User"/>s that follow the passed user.</returns>
public IObservable<User> GetAll(string login)
{
Ensure.ArgumentNotNullOrEmptyString(login, "login");
@@ -55,7 +55,7 @@ namespace Octokit.Reactive
/// <remarks>
/// See the <a href="http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user">API documentation</a> for more information.
/// </remarks>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/>s that the authenticated user follows.</returns>
/// <returns>A <see cref="System.Collections.Generic.IReadOnlyList{User}"/> of <see cref="User"/>s that the authenticated user follows.</returns>
public IObservable<User> GetFollowingForCurrent()
{
return _connection.GetAndFlattenAllPages<User>(ApiUrls.Following());
@@ -68,7 +68,7 @@ namespace Octokit.Reactive
/// <remarks>
/// See the <a href="http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user">API documentation</a> for more information.
/// </remarks>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/>s that the passed user follows.</returns>
/// <returns>A <see cref="System.Collections.Generic.IReadOnlyList{User}"/> of <see cref="User"/>s that the passed user follows.</returns>
public IObservable<User> GetFollowing(string login)
{
Ensure.ArgumentNotNullOrEmptyString(login, "login");
Octokit.Reactive/Clients/ObservableReleasesClient.cs
+15 -19
View File
@@ -44,16 +44,15 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns>
public IObservable<Release> Get(string owner, string name, int number)
public IObservable<Release> Get(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(number, "number");
return _client.Get(owner, name, number).ToObservable();
return _client.Get(owner, name, id).ToObservable();
}
/// <summary>
@@ -84,17 +83,17 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns>
public IObservable<Release> EditRelease(string owner, string name, int number, ReleaseUpdate data)
public IObservable<Release> EditRelease(string owner, string name, int id, ReleaseUpdate data)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(data, "data");
return _client.EditRelease(owner, name, number, data).ToObservable();
return _client.EditRelease(owner, name, id, data).ToObservable();
}
/// <summary>
@@ -105,16 +104,15 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release to delete</param>
/// <param name="id">The id of the release to delete</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns></returns>
public IObservable<Unit> DeleteRelease(string owner, string name, int number)
public IObservable<Unit> DeleteRelease(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(number, "number");
return _client.DeleteRelease(owner, name, number).ToObservable();
return _client.DeleteRelease(owner, name, id).ToObservable();
}
/// <summary>
@@ -125,16 +123,15 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="Release"/>.</param>
/// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns>
public IObservable<ReleaseAsset> GetAssets(string owner, string name, int number)
public IObservable<ReleaseAsset> GetAssets(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(number, "number");
return _connection.GetAndFlattenAllPages<ReleaseAsset>(ApiUrls.ReleaseAssets(owner, name, number));
return _connection.GetAndFlattenAllPages<ReleaseAsset>(ApiUrls.ReleaseAssets(owner, name, id));
}
/// <summary>
@@ -207,15 +204,14 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="ReleaseAsset"/>.</param>
/// <param name="id">The id of the <see cref="ReleaseAsset"/>.</param>
/// <returns></returns>
public IObservable<Unit> DeleteAsset(string owner, string name, int number)
public IObservable<Unit> DeleteAsset(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(number, "number");
return _client.DeleteAsset(owner, name, number).ToObservable();
return _client.DeleteAsset(owner, name, id).ToObservable();
}
}
}
Octokit.Reactive/Clients/ObservableRepositoryCommentsClient.cs
+1 -1
View File
@@ -55,7 +55,7 @@ namespace Octokit.Reactive
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The sha of the commit</param>
/// <param name="sha">The sha of the commit</param>
/// <returns></returns>
public IObservable<CommitComment> GetForCommit(string owner, string name, string sha)
{
Octokit/Clients/IReleasesClient.cs
+10 -10
View File
@@ -34,11 +34,11 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")]
Task<Release> Get(string owner, string name, int number);
Task<Release> Get(string owner, string name, int id);
/// <summary>
/// Creates a new <see cref="Release"/> for the specified repository.
@@ -61,11 +61,11 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns>
Task<Release> EditRelease(string owner, string name, int number, ReleaseUpdate data);
Task<Release> EditRelease(string owner, string name, int id, ReleaseUpdate data);
/// <summary>
/// Deletes an existing <see cref="Release"/> for the specified repository.
@@ -75,10 +75,10 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release to delete</param>
/// <param name="id">The id of the release to delete</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns></returns>
Task DeleteRelease(string owner, string name, int number);
Task DeleteRelease(string owner, string name, int id);
/// <summary>
/// Gets all <see cref="ReleaseAsset"/> for the specified release of the specified repository.
@@ -88,10 +88,10 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="Release"/>.</param>
/// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns>
Task<IReadOnlyList<ReleaseAsset>> GetAssets(string owner, string name, int number);
Task<IReadOnlyList<ReleaseAsset>> GetAssets(string owner, string name, int id);
/// <summary>
/// Uploads a <see cref="ReleaseAsset"/> for the specified release.
@@ -140,8 +140,8 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="ReleaseAsset"/>.</param>
/// <param name="id">The id of the <see cref="ReleaseAsset"/>.</param>
/// <returns></returns>
Task DeleteAsset(string owner, string name, int number);
Task DeleteAsset(string owner, string name, int id);
}
}
Octokit/Clients/IRepositoryCommentsClient.cs
+1 -1
View File
@@ -39,7 +39,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The sha of the commit</param>
/// <param name="sha">The sha of the commit</param>
/// <returns></returns>
Task<IReadOnlyList<CommitComment>> GetForCommit(string owner, string name, string sha);
Octokit/Clients/ReleasesClient.cs
+15 -15
View File
@@ -48,15 +48,15 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns>
public Task<Release> Get(string owner, string name, int number)
public Task<Release> Get(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
var endpoint = ApiUrls.Releases(owner, name, number);
var endpoint = ApiUrls.Releases(owner, name, id);
return ApiConnection.Get<Release>(endpoint);
}
@@ -89,17 +89,17 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns>
public Task<Release> EditRelease(string owner, string name, int number, ReleaseUpdate data)
public Task<Release> EditRelease(string owner, string name, int id, ReleaseUpdate data)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(data, "data");
var endpoint = ApiUrls.Releases(owner, name, number);
var endpoint = ApiUrls.Releases(owner, name, id);
return ApiConnection.Patch<Release>(endpoint, data);
}
@@ -111,15 +111,15 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the release to delete</param>
/// <param name="id">The id of the release to delete</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns></returns>
public Task DeleteRelease(string owner, string name, int number)
public Task DeleteRelease(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
var endpoint = ApiUrls.Releases(owner, name, number);
var endpoint = ApiUrls.Releases(owner, name, id);
return ApiConnection.Delete(endpoint);
}
@@ -131,15 +131,15 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="Release"/>.</param>
/// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns>
public Task<IReadOnlyList<ReleaseAsset>> GetAssets(string owner, string name, int number)
public Task<IReadOnlyList<ReleaseAsset>> GetAssets(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
var endpoint = ApiUrls.ReleaseAssets(owner, name, number);
var endpoint = ApiUrls.ReleaseAssets(owner, name, id);
return ApiConnection.GetAll<ReleaseAsset>(endpoint, null, "application/vnd.github.v3");
}
@@ -216,14 +216,14 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param>
/// <param name="number">The id of the <see cref="ReleaseAsset"/>.</param>
/// <param name="id">The id of the <see cref="ReleaseAsset"/>.</param>
/// <returns></returns>
public Task DeleteAsset(string owner, string name, int number)
public Task DeleteAsset(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
var endpoint = ApiUrls.Assets(owner, name, number);
var endpoint = ApiUrls.Assets(owner, name, id);
return ApiConnection.Delete(endpoint);
}
}
Octokit/Clients/RepositoryCommentsClient.cs
+1 -1
View File
@@ -58,7 +58,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The sha of the commit</param>
/// <param name="sha">The sha of the commit</param>
/// <returns></returns>
public Task<IReadOnlyList<CommitComment>> GetForCommit(string owner, string name, string sha)
{
Octokit/Exceptions/PrivateRepositoryQuotaExceededException.cs
-4
View File
@@ -22,10 +22,6 @@ namespace Octokit
/// <summary>
/// Constructs an instance of PrivateRepositoryQuotaExceededException.
/// </summary>
/// <param name="owner">The login of the owner of the existing repository</param>
/// <param name="name">The name of the existing repository</param>
/// <param name="ownerIsOrganization">True if the owner is an organization</param>
/// <param name="baseAddress">The base address of the repository.</param>
/// <param name="innerException">The inner validation exception.</param>
public PrivateRepositoryQuotaExceededException(ApiValidationException innerException)
: base(innerException)
Octokit/Helpers/ApiUrls.cs
+9 -9
View File
@@ -114,11 +114,11 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <returns></returns>
public static Uri Releases(string owner, string name, int number)
public static Uri Releases(string owner, string name, int id)
{
return "repos/{0}/{1}/releases/{2}".FormatUri(owner, name, number);
return "repos/{0}/{1}/releases/{2}".FormatUri(owner, name, id);
}
/// <summary>
@@ -126,11 +126,11 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The id of the release</param>
/// <param name="id">The id of the release</param>
/// <returns></returns>
public static Uri ReleaseAssets(string owner, string name, int number)
public static Uri ReleaseAssets(string owner, string name, int id)
{
return "repos/{0}/{1}/releases/{2}/assets".FormatUri(owner, name, number);
return "repos/{0}/{1}/releases/{2}/assets".FormatUri(owner, name, id);
}
/// <summary>
@@ -151,11 +151,11 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The id of the release asset</param>
/// <param name="id">The id of the release asset</param>
/// <returns></returns>
public static Uri Assets(string owner, string name, int number)
public static Uri Assets(string owner, string name, int id)
{
return "repos/{0}/{1}/releases/assets/{2}".FormatUri(owner, name, number);
return "repos/{0}/{1}/releases/assets/{2}".FormatUri(owner, name, id);
}
/// <summary>