diff --git a/Octokit.Reactive/Clients/ObservableFeedsClient.cs b/Octokit.Reactive/Clients/ObservableFeedsClient.cs
index 801ef882..f7f88728 100644
--- a/Octokit.Reactive/Clients/ObservableFeedsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableFeedsClient.cs
@@ -4,6 +4,12 @@ using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
+ ///
+ /// A client for GitHub's Feeds API.
+ ///
+ ///
+ /// See the Feeds API documentation for more information
+ ///
public class ObservableFeedsClient : IObservableFeedsClient
{
readonly IFeedsClient _client;
diff --git a/Octokit.Reactive/Clients/ObservableGistCommentsClient.cs b/Octokit.Reactive/Clients/ObservableGistCommentsClient.cs
index e1e6f576..11bc9104 100644
--- a/Octokit.Reactive/Clients/ObservableGistCommentsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableGistCommentsClient.cs
@@ -21,9 +21,7 @@ namespace Octokit.Reactive
///
/// Gets a single comment by gist- and comment id.
///
- ///
- /// http://developer.github.com/v3/gists/comments/#get-a-single-comment
- ///
+ /// http://developer.github.com/v3/gists/comments/#get-a-single-comment
/// The id of the gist
/// The id of the comment
/// IObservable{GistComment}.
@@ -35,9 +33,7 @@ namespace Octokit.Reactive
///
/// Gets all comments for the gist with the specified id.
///
- ///
- /// http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
- ///
+ /// http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
/// The id of the gist
/// IObservable{GistComment}.
public IObservable GetForGist(int gistId)
@@ -48,9 +44,7 @@ namespace Octokit.Reactive
///
/// Creates a comment for the gist with the specified id.
///
- ///
- /// http://developer.github.com/v3/gists/comments/#create-a-comment
- ///
+ /// http://developer.github.com/v3/gists/comments/#create-a-comment
/// The id of the gist
/// The body of the comment
/// IObservable{GistComment}.
@@ -64,9 +58,7 @@ namespace Octokit.Reactive
///
/// Updates the comment with the specified gist- and comment id.
///
- ///
- /// http://developer.github.com/v3/gists/comments/#edit-a-comment
- ///
+ /// http://developer.github.com/v3/gists/comments/#edit-a-comment
/// The id of the gist
/// The id of the comment
/// The updated body of the comment
@@ -81,9 +73,7 @@ namespace Octokit.Reactive
///
/// Deletes the comment with the specified gist- and comment id.
///
- ///
- /// http://developer.github.com/v3/gists/comments/#delete-a-comment
- ///
+ /// http://developer.github.com/v3/gists/comments/#delete-a-comment
/// The id of the gist
/// The id of the comment
/// IObservable{Unit}.
diff --git a/Octokit.Reactive/Clients/ObservableGistsClient.cs b/Octokit.Reactive/Clients/ObservableGistsClient.cs
index 8fe981b8..3525b870 100644
--- a/Octokit.Reactive/Clients/ObservableGistsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableGistsClient.cs
@@ -29,7 +29,6 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/gists/#get-a-single-gist
///
/// The id of the gist
- /// IObservable{Gist}.
public IObservable Get(string id)
{
Ensure.ArgumentNotNullOrEmptyString(id, "id");
diff --git a/Octokit.Reactive/Clients/ObservableGitDatabaseClient.cs b/Octokit.Reactive/Clients/ObservableGitDatabaseClient.cs
index 0dbbfc8f..3019c03f 100644
--- a/Octokit.Reactive/Clients/ObservableGitDatabaseClient.cs
+++ b/Octokit.Reactive/Clients/ObservableGitDatabaseClient.cs
@@ -1,5 +1,8 @@
namespace Octokit.Reactive
{
+ ///
+ /// Used to maintain api structure therefore contains no methods
+ ///
public class ObservableGitDatabaseClient : IObservableGitDatabaseClient
{
public ObservableGitDatabaseClient(IGitHubClient client)
diff --git a/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs b/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs
index cc2b3383..e9b82759 100644
--- a/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs
@@ -21,9 +21,7 @@ namespace Octokit.Reactive
///
/// Gets a single Issue Comment by number.
///
- ///
- /// http://developer.github.com/v3/issues/comments/#get-a-single-comment
- ///
+ /// http://developer.github.com/v3/issues/comments/#get-a-single-comment
/// The owner of the repository
/// The name of the repository
/// The issue comment number
@@ -37,11 +35,9 @@ namespace Octokit.Reactive
}
///
- /// Gets a list of the Issue Comments in a specified repository.
+ /// Gets Issue Comments for a repository.
///
- ///
- /// http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
- ///
+ /// http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
/// The owner of the repository
/// The name of the repository
/// The list of s for the specified Repository.
@@ -54,11 +50,9 @@ namespace Octokit.Reactive
}
///
- /// Gets a list of the Issue Comments for a specified issue.
+ /// Gets Issue Comments for a specified Issue.
///
- ///
- /// http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
- ///
+ /// http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
/// The owner of the repository
/// The name of the repository
/// The issue number
@@ -72,16 +66,14 @@ namespace Octokit.Reactive
}
///
- /// Creates a new Issue Comment in the specified Issue
+ /// Creates a new Issue Comment for a specified Issue.
///
- ///
- /// http://developer.github.com/v3/issues/comments/#create-a-comment
- ///
+ /// http://developer.github.com/v3/issues/comments/#create-a-comment
/// The owner of the repository
/// The name of the repository
- /// The issue number
+ /// The number of the issue
/// The text of the new comment
- /// The s for that was just created.
+ /// The that was just created.
public IObservable Create(string owner, string name, int number, string newComment)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -92,16 +84,14 @@ namespace Octokit.Reactive
}
///
- /// Updates a specified Issue Comment
+ /// Updates a specified Issue Comment.
///
- ///
- /// http://developer.github.com/v3/issues/comments/#edit-a-comment
- ///
+ /// http://developer.github.com/v3/issues/comments/#edit-a-comment
/// The owner of the repository
/// The name of the repository
- /// The issue number
- /// The text of the updated comment
- /// The s for that was just updated.
+ /// The comment number
+ /// The modified comment
+ /// The that was just updated.
public IObservable Update(string owner, string name, int number, string commentUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit.Reactive/Clients/ObservableIssuesClient.cs b/Octokit.Reactive/Clients/ObservableIssuesClient.cs
index 7cc318fc..21f0c9f5 100644
--- a/Octokit.Reactive/Clients/ObservableIssuesClient.cs
+++ b/Octokit.Reactive/Clients/ObservableIssuesClient.cs
@@ -9,10 +9,27 @@ namespace Octokit.Reactive
readonly IIssuesClient _client;
readonly IConnection _connection;
+ ///
+ /// Client for managing assignees.
+ ///
public IObservableAssigneesClient Assignee { get; private set; }
+ ///
+ /// Client for managing comments.
+ ///
public IObservableIssueCommentsClient Comment { get; private set; }
+ ///
+ /// Client for reading various event information associated with issues/pull requests.
+ /// This is useful both for display on issue/pull request information pages and also to
+ /// determine who should be notified of comments.
+ ///
public IObservableIssuesEventsClient Events { get; private set; }
+ ///
+ /// Client for managing labels.
+ ///
public IObservableIssuesLabelsClient Labels { get; private set; }
+ ///
+ /// Client for managing milestones.
+ ///
public IObservableMilestonesClient Milestone { get; private set; }
public ObservableIssuesClient(IGitHubClient client)
@@ -29,7 +46,8 @@ namespace Octokit.Reactive
}
///
- /// Gets a single Issue by number.///
+ /// Gets a single Issue by number.
+ ///
///
/// http://developer.github.com/v3/issues/#get-a-single-issue
///
diff --git a/Octokit.Reactive/Clients/ObservableIssuesLabelsClient.cs b/Octokit.Reactive/Clients/ObservableIssuesLabelsClient.cs
index 5adc874a..093a69d8 100644
--- a/Octokit.Reactive/Clients/ObservableIssuesLabelsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableIssuesLabelsClient.cs
@@ -103,7 +103,7 @@ namespace Octokit.Reactive
/// The name of the repository
/// The name of the label
/// The data for the label to be updated
- /// The updated label'
+ /// The updated label
public IObservable