modified XML docs

This commit is contained in:
aedampir@gmail.com
2016-06-10 23:29:48 +07:00
parent 72e30a7f90
commit 11dd7e5869
4 changed files with 21 additions and 8 deletions

View File

@@ -3,6 +3,12 @@ using System.Diagnostics.CodeAnalysis;
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 interface IObservableCommitsClient
{
/// <summary>
@@ -14,7 +20,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>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<Commit> Get(string owner, string name, string reference);
@@ -28,7 +34,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>
IObservable<Commit> Create(string owner, string name, NewCommit commit);
}
}