API interface summaries

Modified existing comments in IGitDatabaseClient, IMiscellaneousClient and
ITeamsClient. Hopefully for valid reasons.
This commit is contained in:
Peter MacNaughton
2013-12-02 22:08:21 -07:00
parent 185589e8e5
commit 231fa2c520
23 changed files with 127 additions and 4 deletions
+6
View File
@@ -1,5 +1,11 @@
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Activity API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/">Activity API documentation</a> for more information.
/// </remarks>
public interface IActivitiesClient public interface IActivitiesClient
{ {
IEventsClient Events { get; } IEventsClient Events { get; }
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Issue Assignees API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/assignees/">Issue Assignees API documentation</a> for more information.
/// </remarks>
public interface IAssigneesClient public interface IAssigneesClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -2,6 +2,12 @@
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Git Blobs API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/blobs/">Git Blobs API documentation</a> for more information.
/// </remarks>
public interface IBlobsClient public interface IBlobsClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Git Repository Status API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/statuses/">Repository Statuses API documentation</a> for more information.
/// </remarks>
public interface ICommitStatusClient public interface ICommitStatusClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Git Commits API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/commits/">Git Commits API documentation</a> for more information.
/// </remarks>
public interface ICommitsClient public interface ICommitsClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Activity Events API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/events/">Activity Events API documentation</a> for more information
/// </remarks>
public interface IEventsClient public interface IEventsClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Gist Comments API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/gists/comments/">Gist Comments API documentation</a> for more information.
/// </remarks>
public interface IGistCommentsClient public interface IGistCommentsClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Gists API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/gists/">Gists API documentation</a> for more information.
/// </remarks>
public interface IGistsClient public interface IGistsClient
{ {
IGistCommentsClient Comment { get; set; } IGistCommentsClient Comment { get; set; }
+4 -1
View File
@@ -1,8 +1,11 @@
namespace Octokit namespace Octokit
{ {
/// <summary> /// <summary>
/// Used to maintain api structure therefore contains no methods /// A client for GitHub's Git API.
/// </summary> /// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/">Git API documentation</a> for more information.
/// </remarks>
public interface IGitDatabaseClient public interface IGitDatabaseClient
{ {
IBlobsClient Blob { get; set; } IBlobsClient Blob { get; set; }
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Issue Comments API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/comments/">Issue Comments API documentation</a> for more information.
/// </remarks>
public interface IIssueCommentsClient public interface IIssueCommentsClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Issues API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/">Issues API documentation</a> for more information.
/// </remarks>
public interface IIssuesClient public interface IIssuesClient
{ {
IAssigneesClient Assignee { get; } IAssigneesClient Assignee { get; }
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Issue Events API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/events/">Issue Events API documentation</a> for more information.
/// </remarks>
public interface IIssuesEventsClient public interface IIssuesEventsClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Issue Milestones API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/milestones/">Issue Milestones API documentation</a> for more information.
/// </remarks>
public interface IMilestonesClient public interface IMilestonesClient
{ {
/// <summary> /// <summary>
+1 -1
View File
@@ -11,7 +11,7 @@ namespace Octokit
/// A client for GitHub's miscellaneous APIs. /// A client for GitHub's miscellaneous APIs.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// See the <a href="http://developer.github.com/v3/misc/">miscellaneous API documentation</a> for more details. /// See the <a href="http://developer.github.com/v3/misc/">Miscellaneous API documentation</a> for more details.
/// </remarks> /// </remarks>
public interface IMiscellaneousClient public interface IMiscellaneousClient
{ {
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Activity Notifications API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Activity Notifications API documentation</a> for more information.
/// </remarks>
public interface INotificationsClient public interface INotificationsClient
{ {
/// <summary> /// <summary>
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Organization Members API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/">Orgs API documentation</a> for more information.
/// </remarks>
public interface IOrganizationMembersClient public interface IOrganizationMembersClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's References API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/refs/">References API documentation</a> for more information.
/// </remarks>
public interface IReferencesClient public interface IReferencesClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's User Keys API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/users/keys/">Users API documentation</a> for more information.
/// </remarks>
public interface ISshKeysClient public interface ISshKeysClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Activity Starring API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/starring/">Activity Starring API documentation</a> for more information.
/// </remarks>
public interface IStarredClient public interface IStarredClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Git Tags API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/tags/">Git Tags API documentation</a> for more information.
/// </remarks>
public interface ITagsClient public interface ITagsClient
{ {
/// <summary> /// <summary>
+2 -2
View File
@@ -7,10 +7,10 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary> /// <summary>
/// A client for GitHub's Org Teams API. /// A client for GitHub's Organization Teams API.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/teams/">Orgs API documentation</a> for more information. /// See the <a href="http://developer.github.com/v3/orgs/teams/">Organization Teams API documentation</a> for more information.
/// </remarks> /// </remarks>
public interface ITeamsClient public interface ITeamsClient
{ {
+6
View File
@@ -2,6 +2,12 @@
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Git Trees API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/trees/">Git Trees API documentation</a> for more information.
/// </remarks>
public interface ITreesClient public interface ITreesClient
{ {
/// <summary> /// <summary>
+6
View File
@@ -4,6 +4,12 @@ using System.Threading.Tasks;
namespace Octokit namespace Octokit
{ {
/// <summary>
/// A client for GitHub's Users API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/users/">Users API documentation</a> for more information.
/// </remarks>
public interface IUsersClient public interface IUsersClient
{ {
/// <summary> /// <summary>