added some more docs

This commit is contained in:
Brendan Forster
2014-10-07 14:49:08 -02:00
parent 54e0914390
commit d169876a3b
14 changed files with 92 additions and 8 deletions
+12
View File
@@ -21,9 +21,21 @@
Feeds = new FeedsClient(apiConnection);
}
/// <summary>
/// Client for the Events API
/// </summary>
public IEventsClient Events { get; private set; }
/// <summary>
/// Client for the Starring API
/// </summary>
public IStarredClient Starring { get; private set; }
/// <summary>
/// Client for the Watching API
/// </summary>
public IWatchedClient Watching { get; private set; }
/// <summary>
/// Client for the Feeds API
/// </summary>
public IFeedsClient Feeds { get; private set; }
}
}
+15
View File
@@ -8,9 +8,24 @@
/// </remarks>
public interface IActivitiesClient
{
/// <summary>
/// Client for the Events API
/// </summary>
IEventsClient Events { get; }
/// <summary>
/// Client for the Starring API
/// </summary>
IStarredClient Starring { get; }
/// <summary>
/// Client for the Watching API
/// </summary>
IWatchedClient Watching { get; }
/// <summary>
/// Client for the Feeds API
/// </summary>
IFeedsClient Feeds { get; }
}
}
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Pull Request Review Comments API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/pulls/comments/">Review Comments API documentation</a> for more information.
/// </remarks>
public interface IPullRequestReviewCommentsClient
{
/// <summary>
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Commits API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/commits/">Repository Commits API documentation</a> for more information.
/// </remarks>
public interface IRepositoryCommitsClient
{
/// <summary>
@@ -1,12 +1,15 @@
using System;
using System.Collections.Generic;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Deploy Keys API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/keys/">Deploy Keys API documentation</a> for more information.
/// </remarks>
public interface IRepositoryDeployKeysClient
{
/// <summary>
+4 -1
View File
@@ -3,8 +3,11 @@
namespace Octokit
{
/// <summary>
/// GitHub Search Api Client
/// A client for GitHub's Search API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/search/">Search API documentation</a> for more information.
/// </remarks>
public interface ISearchClient
{
/// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Statistics API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
/// </remarks>
public interface IStatisticsClient
{
/// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Watching API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/activity/watching/">Watching API documentation</a> for more information.
/// </remarks>
public interface IWatchedClient
{
/// <summary>
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Pull Request Review Comments API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/pulls/comments/">Review Comments API documentation</a> for more information.
/// </remarks>
public class PullRequestReviewCommentsClient : ApiClient, IPullRequestReviewCommentsClient
{
public PullRequestReviewCommentsClient(IApiConnection apiConnection)
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Commits API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/commits/">Repository Commits API documentation</a> for more information.
/// </remarks>
public class RepositoryCommitsClient : IRepositoryCommitsClient
{
readonly IApiConnection _apiConnection;
@@ -7,10 +7,10 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's repository deploy keys API.
/// A client for GitHub's Repository Deploy Keys API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/keys/">Repository deploy keys API documentation</a> for more information.
/// See the <a href="https://developer.github.com/v3/repos/keys/">Deploy Keys API documentation</a> for more information.
/// </remarks>
public class RepositoryDeployKeysClient : ApiClient, IRepositoryDeployKeysClient
{
+4 -1
View File
@@ -3,8 +3,11 @@
namespace Octokit
{
/// <summary>
/// GitHub Search Api Client
/// A client for GitHub's Search API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/search/">Search API documentation</a> for more information.
/// </remarks>
public class SearchClient : ApiClient, ISearchClient
{
/// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Statistics API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
/// </remarks>
public class StatisticsClient : ApiClient, IStatisticsClient
{
/// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Watching API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/activity/watching/">Watching API documentation</a> for more information.
/// </remarks>
public class WatchedClient : ApiClient, IWatchedClient
{
/// <summary>