Skip to content

Commit

Permalink
Merge pull request #538 from vcaraulean/code-doc-fixes
Browse files Browse the repository at this point in the history
Trivial fixes in XML comments
  • Loading branch information
shiftkey committed Jul 11, 2014
2 parents 46a95eb + 20e4a8c commit b311e47
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 5 deletions.
8 changes: 4 additions & 4 deletions Octokit.Reactive/Clients/ObservableFollowersClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public ObservableFollowersClient(IGitHubClient client)
/// <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="IObservable{User}"/> of <see cref="User"/>s that follow the authenticated user.</returns>
public IObservable<User> GetAllForCurrent()
{
return _connection.GetAndFlattenAllPages<User>(ApiUrls.Followers());
Expand All @@ -41,7 +41,7 @@ public IObservable<User> GetAllForCurrent()
/// <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="IObservable{User}"/> of <see cref="User"/>s that follow the passed user.</returns>
public IObservable<User> GetAll(string login)
{
Ensure.ArgumentNotNullOrEmptyString(login, "login");
Expand All @@ -55,7 +55,7 @@ public IObservable<User> GetAll(string login)
/// <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="IObservable{User}"/> of <see cref="User"/>s that the authenticated user follows.</returns>
public IObservable<User> GetFollowingForCurrent()
{
return _connection.GetAndFlattenAllPages<User>(ApiUrls.Following());
Expand All @@ -68,7 +68,7 @@ public IObservable<User> GetFollowingForCurrent()
/// <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="IObservable{User}"/> of <see cref="User"/>s that the passed user follows.</returns>
public IObservable<User> GetFollowing(string login)
{
Ensure.ArgumentNotNullOrEmptyString(login, "login");
Expand Down
1 change: 1 addition & 0 deletions Octokit/Clients/IPullRequestsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ public interface IPullRequestsClient
/// </summary>
IPullRequestReviewCommentsClient Comment { get; }

/// <summary>
/// Get a pull request by number.
/// </summary>
/// <remarks>
Expand Down
1 change: 1 addition & 0 deletions Octokit/Clients/PullRequestsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public PullRequestsClient(IApiConnection apiConnection) : base(apiConnection)
/// </summary>
public IPullRequestReviewCommentsClient Comment { get; private set; }

/// <summary>
/// Get a pull request by number.
/// </summary>
/// <remarks>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Request/OauthTokenRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public OauthTokenRequest(string clientId, string clientSecret, string code)
public string ClientSecret { get; private set; }

/// <summary>
/// The code you received as a response to making the <see cref="IOAuthClient.CreateGitHubLoginUrl">OAuth login
/// The code you received as a response to making the <see cref="IOauthClient.CreateAccessToken">OAuth login
/// request</see>.
/// </summary>
[Parameter(Key = "code")]
Expand Down
2 changes: 2 additions & 0 deletions Octokit/Models/Request/RequestParameters.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
using System;
#if !PORTABLE
using System.Collections.Concurrent;
#endif
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
Expand Down

0 comments on commit b311e47

Please sign in to comment.