document the return values

octokit · Apr 21, 2016 · 1b2d009 · 1b2d009
1 parent 315cbf4
commit 1b2d009
Show file tree

Hide file tree

Showing 4 changed files with 121 additions and 115 deletions.
diff --git a/Octokit.Reactive/Clients/IObservableIssuesClient.cs b/Octokit.Reactive/Clients/IObservableIssuesClient.cs
@@ -42,7 +42,7 @@ public interface IObservableIssuesClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The issue number</param>
-        /// <returns></returns>
+        /// <returns>A signal containing the requested <seealso cref="Issue"/>s.</returns>
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
         IObservable<Issue> Get(string owner, string name, int number);
@@ -55,7 +55,7 @@ public interface IObservableIssuesClient
         /// Issues are sorted by the create date descending.
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForCurrent();
 
         /// <summary>
@@ -67,7 +67,7 @@ public interface IObservableIssuesClient
         /// Issues are sorted by the create date descending.
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForCurrent(ApiOptions options);
 
         /// <summary>
@@ -78,7 +78,7 @@ public interface IObservableIssuesClient
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForCurrent(IssueRequest request);
 
         /// <summary>
@@ -90,7 +90,7 @@ public interface IObservableIssuesClient
         /// </remarks>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForCurrent(IssueRequest request, ApiOptions options);
 
         /// <summary>
@@ -101,7 +101,7 @@ public interface IObservableIssuesClient
         /// Issues are sorted by the create date descending.
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOwnedAndMemberRepositories();
 
         /// <summary>
@@ -113,7 +113,7 @@ public interface IObservableIssuesClient
         /// Issues are sorted by the create date descending.
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOwnedAndMemberRepositories(ApiOptions options);
 
         /// <summary>
@@ -123,7 +123,7 @@ public interface IObservableIssuesClient
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOwnedAndMemberRepositories(IssueRequest request);
 
         /// <summary>
@@ -134,7 +134,7 @@ public interface IObservableIssuesClient
         /// </remarks>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOwnedAndMemberRepositories(IssueRequest request, ApiOptions options);
 
         /// <summary>
@@ -144,7 +144,7 @@ public interface IObservableIssuesClient
         /// http://developer.github.com/v3/issues/#list-issues
         /// </remarks>
         /// <param name="organization">The name of the organization</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOrganization(string organization);
 
         /// <summary>
@@ -155,9 +155,9 @@ public interface IObservableIssuesClient
         /// </remarks>
         /// <param name="organization">The name of the organization</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOrganization(string organization, ApiOptions options);
-        
+
         /// <summary>
         /// Gets all issues for a given organization for the authenticated user.
         /// </summary>
@@ -166,7 +166,7 @@ public interface IObservableIssuesClient
         /// </remarks>
         /// <param name="organization">The name of the organization</param>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOrganization(string organization, IssueRequest request);
 
         /// <summary>
@@ -178,7 +178,7 @@ public interface IObservableIssuesClient
         /// <param name="organization">The name of the organization</param>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForOrganization(string organization, IssueRequest request, ApiOptions options);
 
         /// <summary>
@@ -189,7 +189,7 @@ public interface IObservableIssuesClient
         /// </remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForRepository(string owner, string name);
 
         /// <summary>
@@ -201,7 +201,7 @@ public interface IObservableIssuesClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForRepository(string owner, string name, ApiOptions options);
 
         /// <summary>
@@ -213,7 +213,7 @@ public interface IObservableIssuesClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
-        /// <returns></returns>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForRepository(string owner, string name, RepositoryIssueRequest request);
 
         /// <summary>
@@ -225,8 +225,8 @@ public interface IObservableIssuesClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="request">Used to filter and sort the list of issues returned</param>
-        /// <param name="options">Options for changing the API response</param>        
-        /// <returns></returns>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns>A signal containing one or more <seealso cref="Issue"/>s.</returns>
         IObservable<Issue> GetAllForRepository(string owner, string name, RepositoryIssueRequest request, ApiOptions options);
 
         /// <summary>
@@ -237,7 +237,7 @@ public interface IObservableIssuesClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="newIssue">A <see cref="NewIssue"/> instance describing the new issue to create</param>
-        /// <returns></returns>
+        /// <returns>A signal containing the new <seealso cref="Issue"/>.</returns>
         IObservable<Issue> Create(string owner, string name, NewIssue newIssue);
 
         /// <summary>
@@ -250,18 +250,18 @@ public interface IObservableIssuesClient
         /// <param name="number">The issue number</param>
         /// <param name="issueUpdate">An <see cref="IssueUpdate"/> instance describing the changes to make to the issue
         /// </param>
-        /// <returns></returns>
+        /// <returns>A signal containing the updated <seealso cref="Issue"/>.</returns>
         IObservable<Issue> Update(string owner, string name, int number, IssueUpdate issueUpdate);
-        
-         /// <summary>
-         /// Locks an issue for the specified repository. Issue owners and users with push access can lock an issue.
-         /// </summary>
-         /// <remarks>https://developer.github.com/v3/issues/#lock-an-issue</remarks>
-         /// <param name="owner">The owner of the repository</param>
-         /// <param name="name">The name of the repository</param>
-         /// <param name="number">The issue number</param>
-         /// <returns></returns>
-         IObservable<Unit> Lock(string owner, string name, int number);
+
+        /// <summary>
+        /// Locks an issue for the specified repository. Issue owners and users with push access can lock an issue.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/issues/#lock-an-issue</remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="number">The issue number</param>
+        /// <returns>A signal indicating completion.</returns>
+        IObservable<Unit> Lock(string owner, string name, int number);
 
          /// <summary>
          /// Unlocks an issue for the specified repository. Issue owners and users with push access can unlock an issue.
@@ -270,7 +270,7 @@ public interface IObservableIssuesClient
          /// <param name="owner">The owner of the repository</param>
          /// <param name="name">The name of the repository</param>
          /// <param name="number">The issue number</param>
-         /// <returns></returns>
+         /// <returns>A signal indicating completion.</returns>
          IObservable<Unit> Unlock(string owner, string name, int number);
     }
 }