Synchronized XML documentation of IObservableRepoCollaboratorsClient and IRepoCollaboratorsClient

Octokit.Reactive/Clients/IObservableRepoCollaboratorsClient.cs

@@ -3,50 +3,76 @@ using System.Reactive;
 
 namespace Octokit.Reactive
 {
+    /// <summary>
+    /// A client for GitHub's Collaborators on a Repository.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="http://developer.github.com/v3/repos/collaborators/">Collaborators API documentation</a> for more details.
+    /// </remarks>
     public interface IObservableRepoCollaboratorsClient
     {
         /// <summary>
-        /// Gets all the available collaborators on this repo.
+        /// Gets all the collaborators on a repository.
         /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
+        /// </remarks>
         /// <param name="owner">The owner of the repository</param>
-        /// <param name="repo">The name of the repository</param>
-        /// <returns>The list of <see cref="User"/>s for the specified repository.</returns>
-        IObservable<User> GetAll(string owner, string repo);
+        /// <param name="name">The name of the repository</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s for the specified repository.</returns>
+        IObservable<User> GetAll(string owner, string name);
 
         /// <summary>
-        /// Gets all the available collaborators on this repo.
+        /// Gets all the collaborators on a repository.
         /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
+        /// </remarks>
         /// <param name="owner">The owner of the repository</param>
-        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the repository</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>The list of <see cref="User"/>s for the specified repository.</returns>
-        IObservable<User> GetAll(string owner, string repo, ApiOptions options);
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s for the specified repository.</returns>
+        IObservable<User> GetAll(string owner, string name, ApiOptions options);
 
         /// <summary>
-        /// Checks to see if a user is an assignee for a repository.
+        /// Checks if a user is a collaborator on a repository.
         /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
+        /// </remarks>
         /// <param name="owner">The owner of the repository</param>
-        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the repository</param>
         /// <param name="user">Username of the prospective collaborator</param>
-        /// <returns></returns>
-        IObservable<bool> IsCollaborator(string owner, string repo, string user);
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns><see cref="bool"/>True if user is a collaborator else false</returns>
+        IObservable<bool> IsCollaborator(string owner, string name, string user);
 
         /// <summary>
-        /// Adds a user as a collaborator to a repository.
+        /// Adds a new collaborator to the repository.
         /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
+        /// </remarks>
         /// <param name="owner">The owner of the repository</param>
-        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the repository</param>
         /// <param name="user">Username of the prospective collaborator</param>
-        /// <returns></returns>
-        IObservable<Unit> Add(string owner, string repo, string user);
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns><see cref="Unit"/></returns>
+        IObservable<Unit> Add(string owner, string name, string user);
 
         /// <summary>
-        /// Removes a user as a collaborator for a repository.
+        /// Deletes a collaborator from the repository.
         /// </summary>
+        /// <remarks>
+        /// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
+        /// </remarks>
         /// <param name="owner">The owner of the repository</param>
-        /// <param name="repo">The name of the repository</param>
+        /// <param name="name">The name of the repository</param>
         /// <param name="user">Username of the prospective collaborator</param>
-        /// <returns></returns>
-        IObservable<Unit> Delete(string owner, string repo, string user);
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns><see cref="Unit"/></returns>
+        IObservable<Unit> Delete(string owner, string name, string user);
     }
 }