mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-21 06:35:11 +00:00
modified XML docs
This commit is contained in:
@@ -3,6 +3,12 @@ using System.Reactive.Threading.Tasks;
|
||||
|
||||
namespace Octokit.Reactive
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Git Commits API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/git/commits/">Git Commits API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public class ObservableCommitsClient : IObservableCommitsClient
|
||||
{
|
||||
readonly ICommitsClient _client;
|
||||
@@ -10,6 +16,7 @@ namespace Octokit.Reactive
|
||||
public ObservableCommitsClient(IGitHubClient client)
|
||||
{
|
||||
Ensure.ArgumentNotNull(client, "client");
|
||||
|
||||
_client = client.Git.Commit;
|
||||
}
|
||||
|
||||
@@ -22,7 +29,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">Tha sha reference of the commit</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="Commit"/> representing commit for specified repository and reference</returns>
|
||||
public IObservable<Commit> Get(string owner, string name, string reference)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -41,7 +48,7 @@ namespace Octokit.Reactive
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="commit">The commit to create</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IObservable{Commit}"/> of <see cref="Commit"/> representing created commit for specified repository</returns>
|
||||
public IObservable<Commit> Create(string owner, string name, NewCommit commit)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
|
||||
Reference in New Issue
Block a user