diff --git a/Octokit/Clients/IActivitiesClient.cs b/Octokit/Clients/IActivitiesClient.cs index ad1e4fcc..c2bd6b70 100644 --- a/Octokit/Clients/IActivitiesClient.cs +++ b/Octokit/Clients/IActivitiesClient.cs @@ -1,5 +1,11 @@ namespace Octokit { + /// + /// A client for GitHub's Activity API. + /// + /// + /// See the Activity API documentation for more information. + /// public interface IActivitiesClient { IEventsClient Events { get; } diff --git a/Octokit/Clients/IAssigneesClient.cs b/Octokit/Clients/IAssigneesClient.cs index 24de3c03..2d629751 100644 --- a/Octokit/Clients/IAssigneesClient.cs +++ b/Octokit/Clients/IAssigneesClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Issue Assignees API. + /// + /// + /// See the Issue Assignees API documentation for more information. + /// public interface IAssigneesClient { /// diff --git a/Octokit/Clients/IBlobsClient.cs b/Octokit/Clients/IBlobsClient.cs index d063c59e..2d462464 100644 --- a/Octokit/Clients/IBlobsClient.cs +++ b/Octokit/Clients/IBlobsClient.cs @@ -2,6 +2,12 @@ namespace Octokit { + /// + /// A client for GitHub's Git Blobs API. + /// + /// + /// See the Git Blobs API documentation for more information. + /// public interface IBlobsClient { /// diff --git a/Octokit/Clients/ICommitStatusClient.cs b/Octokit/Clients/ICommitStatusClient.cs index 81daf573..61065400 100644 --- a/Octokit/Clients/ICommitStatusClient.cs +++ b/Octokit/Clients/ICommitStatusClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Git Repository Status API. + /// + /// + /// See the Repository Statuses API documentation for more information. + /// public interface ICommitStatusClient { /// diff --git a/Octokit/Clients/ICommitsClient.cs b/Octokit/Clients/ICommitsClient.cs index 6f187fd3..60cc0365 100644 --- a/Octokit/Clients/ICommitsClient.cs +++ b/Octokit/Clients/ICommitsClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Git Commits API. + /// + /// + /// See the Git Commits API documentation for more information. + /// public interface ICommitsClient { /// diff --git a/Octokit/Clients/IEventsClient.cs b/Octokit/Clients/IEventsClient.cs index 378cc91a..8213b5bd 100644 --- a/Octokit/Clients/IEventsClient.cs +++ b/Octokit/Clients/IEventsClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Activity Events API. + /// + /// + /// See the Activity Events API documentation for more information + /// public interface IEventsClient { /// diff --git a/Octokit/Clients/IGistCommentsClient.cs b/Octokit/Clients/IGistCommentsClient.cs index a9a5aeb8..3b60366f 100644 --- a/Octokit/Clients/IGistCommentsClient.cs +++ b/Octokit/Clients/IGistCommentsClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Gist Comments API. + /// + /// + /// See the Gist Comments API documentation for more information. + /// public interface IGistCommentsClient { /// diff --git a/Octokit/Clients/IGistsClient.cs b/Octokit/Clients/IGistsClient.cs index a8a90fdb..3c1787a9 100644 --- a/Octokit/Clients/IGistsClient.cs +++ b/Octokit/Clients/IGistsClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Gists API. + /// + /// + /// See the Gists API documentation for more information. + /// public interface IGistsClient { IGistCommentsClient Comment { get; set; } diff --git a/Octokit/Clients/IGitDatabaseClient.cs b/Octokit/Clients/IGitDatabaseClient.cs index 0516b36a..e14f7334 100644 --- a/Octokit/Clients/IGitDatabaseClient.cs +++ b/Octokit/Clients/IGitDatabaseClient.cs @@ -1,8 +1,11 @@ namespace Octokit { /// - /// Used to maintain api structure therefore contains no methods + /// A client for GitHub's Git API. /// + /// + /// See the Git API documentation for more information. + /// public interface IGitDatabaseClient { IBlobsClient Blob { get; set; } diff --git a/Octokit/Clients/IIssueCommentsClient.cs b/Octokit/Clients/IIssueCommentsClient.cs index 3836c5e1..7261018d 100644 --- a/Octokit/Clients/IIssueCommentsClient.cs +++ b/Octokit/Clients/IIssueCommentsClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Issue Comments API. + /// + /// + /// See the Issue Comments API documentation for more information. + /// public interface IIssueCommentsClient { /// diff --git a/Octokit/Clients/IIssuesClient.cs b/Octokit/Clients/IIssuesClient.cs index c5110bd4..eac0c68d 100644 --- a/Octokit/Clients/IIssuesClient.cs +++ b/Octokit/Clients/IIssuesClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Issues API. + /// + /// + /// See the Issues API documentation for more information. + /// public interface IIssuesClient { IAssigneesClient Assignee { get; } diff --git a/Octokit/Clients/IIssuesEventsClient.cs b/Octokit/Clients/IIssuesEventsClient.cs index 39afa005..6b711a9c 100644 --- a/Octokit/Clients/IIssuesEventsClient.cs +++ b/Octokit/Clients/IIssuesEventsClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Issue Events API. + /// + /// + /// See the Issue Events API documentation for more information. + /// public interface IIssuesEventsClient { /// diff --git a/Octokit/Clients/IMilestonesClient.cs b/Octokit/Clients/IMilestonesClient.cs index b633e198..d0635db4 100644 --- a/Octokit/Clients/IMilestonesClient.cs +++ b/Octokit/Clients/IMilestonesClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Issue Milestones API. + /// + /// + /// See the Issue Milestones API documentation for more information. + /// public interface IMilestonesClient { /// diff --git a/Octokit/Clients/IMiscellaneousClient.cs b/Octokit/Clients/IMiscellaneousClient.cs index 7c08bf4d..577c6c1b 100644 --- a/Octokit/Clients/IMiscellaneousClient.cs +++ b/Octokit/Clients/IMiscellaneousClient.cs @@ -11,7 +11,7 @@ namespace Octokit /// A client for GitHub's miscellaneous APIs. /// /// - /// See the miscellaneous API documentation for more details. + /// See the Miscellaneous API documentation for more details. /// public interface IMiscellaneousClient { diff --git a/Octokit/Clients/INotificationsClient.cs b/Octokit/Clients/INotificationsClient.cs index 241295f2..885bd4e7 100644 --- a/Octokit/Clients/INotificationsClient.cs +++ b/Octokit/Clients/INotificationsClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Activity Notifications API. + /// + /// + /// See the Activity Notifications API documentation for more information. + /// public interface INotificationsClient { /// diff --git a/Octokit/Clients/IOrganizationMembersClient.cs b/Octokit/Clients/IOrganizationMembersClient.cs index f763a908..3ac23eb7 100644 --- a/Octokit/Clients/IOrganizationMembersClient.cs +++ b/Octokit/Clients/IOrganizationMembersClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Organization Members API. + /// + /// + /// See the Orgs API documentation for more information. + /// public interface IOrganizationMembersClient { /// diff --git a/Octokit/Clients/IReferencesClient.cs b/Octokit/Clients/IReferencesClient.cs index 06aecfb8..10a9fe2c 100644 --- a/Octokit/Clients/IReferencesClient.cs +++ b/Octokit/Clients/IReferencesClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's References API. + /// + /// + /// See the References API documentation for more information. + /// public interface IReferencesClient { /// diff --git a/Octokit/Clients/ISshKeysClient.cs b/Octokit/Clients/ISshKeysClient.cs index a66586f3..807d1e8f 100644 --- a/Octokit/Clients/ISshKeysClient.cs +++ b/Octokit/Clients/ISshKeysClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's User Keys API. + /// + /// + /// See the Users API documentation for more information. + /// public interface ISshKeysClient { /// diff --git a/Octokit/Clients/IStarredClient.cs b/Octokit/Clients/IStarredClient.cs index 5dcbebfb..1110dbb7 100644 --- a/Octokit/Clients/IStarredClient.cs +++ b/Octokit/Clients/IStarredClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Activity Starring API. + /// + /// + /// See the Activity Starring API documentation for more information. + /// public interface IStarredClient { /// diff --git a/Octokit/Clients/ITagsClient.cs b/Octokit/Clients/ITagsClient.cs index ba07c693..86ce2caf 100644 --- a/Octokit/Clients/ITagsClient.cs +++ b/Octokit/Clients/ITagsClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Git Tags API. + /// + /// + /// See the Git Tags API documentation for more information. + /// public interface ITagsClient { /// diff --git a/Octokit/Clients/ITeamsClient.cs b/Octokit/Clients/ITeamsClient.cs index 31c02b70..a2abafab 100644 --- a/Octokit/Clients/ITeamsClient.cs +++ b/Octokit/Clients/ITeamsClient.cs @@ -7,10 +7,10 @@ using System.Threading.Tasks; namespace Octokit { /// - /// A client for GitHub's Org Teams API. + /// A client for GitHub's Organization Teams API. /// /// - /// See the Orgs API documentation for more information. + /// See the Organization Teams API documentation for more information. /// public interface ITeamsClient { diff --git a/Octokit/Clients/ITreesClient.cs b/Octokit/Clients/ITreesClient.cs index 54ae836e..aad5234d 100644 --- a/Octokit/Clients/ITreesClient.cs +++ b/Octokit/Clients/ITreesClient.cs @@ -2,6 +2,12 @@ namespace Octokit { + /// + /// A client for GitHub's Git Trees API. + /// + /// + /// See the Git Trees API documentation for more information. + /// public interface ITreesClient { /// diff --git a/Octokit/Clients/IUsersClient.cs b/Octokit/Clients/IUsersClient.cs index a42dc2ae..8cc36b14 100644 --- a/Octokit/Clients/IUsersClient.cs +++ b/Octokit/Clients/IUsersClient.cs @@ -4,6 +4,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Users API. + /// + /// + /// See the Users API documentation for more information. + /// public interface IUsersClient { ///