zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-04 03:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate documentation comments for the

Browse Source 
`Reactive` project
This commit is contained in:
Peter MacNaughton
2014-02-26 22:09:23 -07:00
parent 64bd9d4b9b
commit 04d6e9b386
15 changed files with 140 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs
+14 -24
View File
@@ -21,9 +21,7 @@ namespace Octokit.Reactive
/// <summary>
/// Gets a single Issue Comment by number.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/comments/#get-a-single-comment
/// </remarks>
/// <remarks>http://developer.github.com/v3/issues/comments/#get-a-single-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue comment number</param>
@@ -37,11 +35,9 @@ namespace Octokit.Reactive
}
/// <summary>
/// Gets a list of the Issue Comments in a specified repository.
/// Gets Issue Comments for a repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
/// </remarks>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns>The list of <see cref="IssueComment"/>s for the specified Repository.</returns>
@@ -54,11 +50,9 @@ namespace Octokit.Reactive
}
/// <summary>
/// Gets a list of the Issue Comments for a specified issue.
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
/// </remarks>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
@@ -72,16 +66,14 @@ namespace Octokit.Reactive
}
/// <summary>
/// Creates a new Issue Comment in the specified Issue
/// Creates a new Issue Comment for a specified Issue.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/comments/#create-a-comment
/// </remarks>
/// <remarks>http://developer.github.com/v3/issues/comments/#create-a-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="number">The number of the issue</param>
/// <param name="newComment">The text of the new comment</param>
/// <returns>The <see cref="IssueComment"/>s for that was just created.</returns>
/// <returns>The <see cref="IssueComment"/> that was just created.</returns>
public IObservable<IssueComment> Create(string owner, string name, int number, string newComment)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -92,16 +84,14 @@ namespace Octokit.Reactive
}
/// <summary>
/// Updates a specified Issue Comment
/// Updates a specified Issue Comment.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/comments/#edit-a-comment
/// </remarks>
/// <remarks>http://developer.github.com/v3/issues/comments/#edit-a-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="commentUpdate">The text of the updated comment</param>
/// <returns>The <see cref="IssueComment"/>s for that was just updated.</returns>
/// <param name="number">The comment number</param>
/// <param name="commentUpdate">The modified comment</param>
/// <returns>The <see cref="IssueComment"/> that was just updated.</returns>
public IObservable<IssueComment> Update(string owner, string name, int number, string commentUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");