From 3b7488c4daf77542b8e6f5adf140ffd76c7523e5 Mon Sep 17 00:00:00 2001
From: Peter MacNaughton <peter@macnaughton.info>
Date: Mon, 2 Dec 2013 22:09:04 -0700
Subject: [PATCH] API client constructors documented

---
 Octokit/Clients/ActivitiesClient.cs    | 4 ++++
 Octokit/Clients/AssigneesClient.cs     | 4 ++++
 Octokit/Clients/BlobsClient.cs         | 4 ++++
 Octokit/Clients/CommitsClient.cs       | 4 ++++
 Octokit/Clients/EventsClient.cs        | 4 ++++
 Octokit/Clients/GistCommentsClient.cs  | 4 ++++
 Octokit/Clients/GistsClient.cs         | 4 ++++
 Octokit/Clients/GitDatabaseClient.cs   | 4 ++++
 Octokit/Clients/IssueCommentsClient.cs | 4 ++++
 Octokit/Clients/IssuesClient.cs        | 4 ++++
 Octokit/Clients/MilestonesClient.cs    | 4 ++++
 Octokit/Clients/NotificationsClient.cs | 4 ++++
 Octokit/Clients/ReferencesClient.cs    | 4 ++++
 Octokit/Clients/StarredClient.cs       | 4 ++++
 Octokit/Clients/TagsClient.cs          | 4 ++++
 Octokit/Clients/TreesClient.cs         | 4 ++++
 Octokit/Clients/UsersClient.cs         | 4 ++++
 17 files changed, 68 insertions(+)

diff --git a/Octokit/Clients/ActivitiesClient.cs b/Octokit/Clients/ActivitiesClient.cs
index bf07a291..d4ed340e 100644
--- a/Octokit/Clients/ActivitiesClient.cs
+++ b/Octokit/Clients/ActivitiesClient.cs
@@ -2,6 +2,10 @@
 {
     public class ActivitiesClient : ApiClient, IActivitiesClient
     {
+        /// <summary>
+        /// Instatiate a new GitHub Activities API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public ActivitiesClient(IApiConnection apiConnection)
             : base(apiConnection)
         {
diff --git a/Octokit/Clients/AssigneesClient.cs b/Octokit/Clients/AssigneesClient.cs
index 3d755e0a..fda5388d 100644
--- a/Octokit/Clients/AssigneesClient.cs
+++ b/Octokit/Clients/AssigneesClient.cs
@@ -6,6 +6,10 @@ namespace Octokit
 {
     public class AssigneesClient : ApiClient, IAssigneesClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Issue Assignees API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public AssigneesClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }
diff --git a/Octokit/Clients/BlobsClient.cs b/Octokit/Clients/BlobsClient.cs
index 4ac0b3b9..2be1a3e4 100644
--- a/Octokit/Clients/BlobsClient.cs
+++ b/Octokit/Clients/BlobsClient.cs
@@ -4,6 +4,10 @@ namespace Octokit
 {
     public class BlobsClient : ApiClient, IBlobsClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Git Blobs API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public BlobsClient(IApiConnection apiConnection)
             : base(apiConnection)
         {
diff --git a/Octokit/Clients/CommitsClient.cs b/Octokit/Clients/CommitsClient.cs
index 095b4bc6..f040e71c 100644
--- a/Octokit/Clients/CommitsClient.cs
+++ b/Octokit/Clients/CommitsClient.cs
@@ -4,6 +4,10 @@ namespace Octokit
 {
     public class CommitsClient : ApiClient, ICommitsClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Git Commits API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public CommitsClient(IApiConnection apiConnection) : 
             base(apiConnection)
         {
diff --git a/Octokit/Clients/EventsClient.cs b/Octokit/Clients/EventsClient.cs
index f21ed214..d26aa4f0 100644
--- a/Octokit/Clients/EventsClient.cs
+++ b/Octokit/Clients/EventsClient.cs
@@ -5,6 +5,10 @@ namespace Octokit
 {
     public class EventsClient : ApiClient, IEventsClient
     {
+        /// <summary>
+        /// Instantiates a new GitHub Issue Events API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public EventsClient(IApiConnection apiConnection)
             : base(apiConnection)
         {
diff --git a/Octokit/Clients/GistCommentsClient.cs b/Octokit/Clients/GistCommentsClient.cs
index 1b708e43..cc3caa2f 100644
--- a/Octokit/Clients/GistCommentsClient.cs
+++ b/Octokit/Clients/GistCommentsClient.cs
@@ -5,6 +5,10 @@ namespace Octokit
 {
     public class GistCommentsClient : ApiClient, IGistCommentsClient
     {
+        /// <summary>
+        /// Instantiates a new GitHub Gist Comments API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public GistCommentsClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }
diff --git a/Octokit/Clients/GistsClient.cs b/Octokit/Clients/GistsClient.cs
index 0a08b80f..b155ae39 100644
--- a/Octokit/Clients/GistsClient.cs
+++ b/Octokit/Clients/GistsClient.cs
@@ -4,6 +4,10 @@ namespace Octokit
 {
     public class GistsClient : ApiClient, IGistsClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Gists API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public GistsClient(IApiConnection apiConnection) : 
             base(apiConnection)
         {
diff --git a/Octokit/Clients/GitDatabaseClient.cs b/Octokit/Clients/GitDatabaseClient.cs
index 0b50317f..f22db2fc 100644
--- a/Octokit/Clients/GitDatabaseClient.cs
+++ b/Octokit/Clients/GitDatabaseClient.cs
@@ -2,6 +2,10 @@
 {
     public class GitDatabaseClient : ApiClient, IGitDatabaseClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Git API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public GitDatabaseClient(IApiConnection apiConnection) 
             : base(apiConnection)
         {
diff --git a/Octokit/Clients/IssueCommentsClient.cs b/Octokit/Clients/IssueCommentsClient.cs
index 476e63ba..72e80a35 100644
--- a/Octokit/Clients/IssueCommentsClient.cs
+++ b/Octokit/Clients/IssueCommentsClient.cs
@@ -6,6 +6,10 @@ namespace Octokit
 {
     public class IssueCommentsClient : ApiClient, IIssueCommentsClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Issue Comments API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public IssueCommentsClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }
diff --git a/Octokit/Clients/IssuesClient.cs b/Octokit/Clients/IssuesClient.cs
index 9c2ddc05..d48ced73 100644
--- a/Octokit/Clients/IssuesClient.cs
+++ b/Octokit/Clients/IssuesClient.cs
@@ -5,6 +5,10 @@ namespace Octokit
 {
     public class IssuesClient : ApiClient, IIssuesClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Issues API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public IssuesClient(IApiConnection apiConnection) : base(apiConnection)
         {
             Assignee = new AssigneesClient(apiConnection);
diff --git a/Octokit/Clients/MilestonesClient.cs b/Octokit/Clients/MilestonesClient.cs
index 65b127dc..e4c50789 100644
--- a/Octokit/Clients/MilestonesClient.cs
+++ b/Octokit/Clients/MilestonesClient.cs
@@ -6,6 +6,10 @@ namespace Octokit
 {
     public class MilestonesClient : ApiClient, IMilestonesClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Issue Milestones API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public MilestonesClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }
diff --git a/Octokit/Clients/NotificationsClient.cs b/Octokit/Clients/NotificationsClient.cs
index ab2fcf36..a707a36a 100644
--- a/Octokit/Clients/NotificationsClient.cs
+++ b/Octokit/Clients/NotificationsClient.cs
@@ -6,6 +6,10 @@ namespace Octokit
 {
     public class NotificationsClient : ApiClient, INotificationsClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub Activity Notifications API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public NotificationsClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }
diff --git a/Octokit/Clients/ReferencesClient.cs b/Octokit/Clients/ReferencesClient.cs
index 9ba48437..cfd70a60 100644
--- a/Octokit/Clients/ReferencesClient.cs
+++ b/Octokit/Clients/ReferencesClient.cs
@@ -5,6 +5,10 @@ namespace Octokit
 {
     public class ReferencesClient : ApiClient, IReferencesClient
     {
+        /// <summary>
+        /// Instatiates a new GitHub References API client
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public ReferencesClient(IApiConnection apiConnection) : 
             base(apiConnection)
         {
diff --git a/Octokit/Clients/StarredClient.cs b/Octokit/Clients/StarredClient.cs
index 94ff2849..c8b1ea24 100644
--- a/Octokit/Clients/StarredClient.cs
+++ b/Octokit/Clients/StarredClient.cs
@@ -7,6 +7,10 @@ namespace Octokit
 {
     public class StarredClient : ApiClient, IStarredClient
     {
+        /// <summary>
+        /// Instantiates a new GitHub Activity Starring API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public StarredClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }
diff --git a/Octokit/Clients/TagsClient.cs b/Octokit/Clients/TagsClient.cs
index 099f1d5e..b43e76b3 100644
--- a/Octokit/Clients/TagsClient.cs
+++ b/Octokit/Clients/TagsClient.cs
@@ -4,6 +4,10 @@ namespace Octokit
 {
     public class TagsClient : ApiClient, ITagsClient
     {
+        /// <summary>
+        /// Instantiates a new GitHub Git Tags API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public TagsClient(IApiConnection apiConnection) 
             : base(apiConnection)
         {
diff --git a/Octokit/Clients/TreesClient.cs b/Octokit/Clients/TreesClient.cs
index 3d109fa9..80b8361f 100644
--- a/Octokit/Clients/TreesClient.cs
+++ b/Octokit/Clients/TreesClient.cs
@@ -6,6 +6,10 @@ namespace Octokit
 {
     public class TreesClient : ApiClient, ITreesClient
     {
+        /// <summary>
+        /// Instantiates a new GitHub Git Trees API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public TreesClient(IApiConnection apiConnection)
             : base(apiConnection)
         {
diff --git a/Octokit/Clients/UsersClient.cs b/Octokit/Clients/UsersClient.cs
index b61870d3..8263ed37 100644
--- a/Octokit/Clients/UsersClient.cs
+++ b/Octokit/Clients/UsersClient.cs
@@ -15,6 +15,10 @@ namespace Octokit
     {
         static readonly Uri _userEndpoint = new Uri("user", UriKind.Relative);
 
+        /// <summary>
+        /// Instantiates a new GitHub Users API client.
+        /// </summary>
+        /// <param name="apiConnection">An API connection</param>
         public UsersClient(IApiConnection apiConnection) : base(apiConnection)
         {
         }