Trivial fixes in XML comments

And added an #if around using in RequestParameters.cs (worth having a
look, may have implications when building on different platforms)
This commit is contained in:
Valeriu Caraulean
2014-07-12 00:09:48 +02:00
parent 46a95eb704
commit 20e4a8ca7e
5 changed files with 9 additions and 5 deletions
@@ -28,7 +28,7 @@ namespace Octokit.Reactive
/// <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());
@@ -41,7 +41,7 @@ namespace Octokit.Reactive
/// <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");
@@ -55,7 +55,7 @@ namespace Octokit.Reactive
/// <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());
@@ -68,7 +68,7 @@ namespace Octokit.Reactive
/// <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");
+1
View File
@@ -11,6 +11,7 @@ namespace Octokit
/// </summary>
IPullRequestReviewCommentsClient Comment { get; }
/// <summary>
/// Get a pull request by number.
/// </summary>
/// <remarks>
+1
View File
@@ -16,6 +16,7 @@ namespace Octokit
/// </summary>
public IPullRequestReviewCommentsClient Comment { get; private set; }
/// <summary>
/// Get a pull request by number.
/// </summary>
/// <remarks>
+1 -1
View File
@@ -38,7 +38,7 @@ namespace Octokit
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")]
@@ -1,5 +1,7 @@
using System;
#if !PORTABLE
using System.Collections.Concurrent;
#endif
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;