cleared <retruns> tags

2025-12-20 14:15:12 +00:00 · 2016-06-17 05:51:47 +07:00
parent ea0b218905
commit e6696f05ab
4 changed files with 40 additions and 40 deletions
--- a/Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs
+++ b/Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs
@@ -20,7 +20,7 @@ namespace Octokit.Reactive
        /// <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 <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        IObservable<EventInfo> GetAllForIssue(string owner, string name, int number);
        
        /// <summary>
@@ -31,7 +31,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
-        /// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        IObservable<EventInfo> GetAllForIssue(int repositoryId, int number);

        /// <summary>
@@ -44,7 +44,7 @@ namespace Octokit.Reactive
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        IObservable<EventInfo> GetAllForIssue(string owner, string name, int number, ApiOptions options);

        /// <summary>
@@ -56,7 +56,7 @@ namespace Octokit.Reactive
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        IObservable<EventInfo> GetAllForIssue(int repositoryId, int number, ApiOptions options);

        /// <summary>
@@ -67,7 +67,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
-        /// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        IObservable<IssueEvent> GetAllForRepository(string owner, string name);

        /// <summary>
@@ -77,7 +77,7 @@ namespace Octokit.Reactive
        /// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
-        /// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        IObservable<IssueEvent> GetAllForRepository(int repositoryId);

        /// <summary>
@@ -89,7 +89,7 @@ namespace Octokit.Reactive
        /// <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>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        IObservable<IssueEvent> GetAllForRepository(string owner, string name, ApiOptions options);

        /// <summary>
@@ -100,7 +100,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        IObservable<IssueEvent> GetAllForRepository(int repositoryId, ApiOptions options);

        /// <summary>
@@ -112,7 +112,7 @@ namespace Octokit.Reactive
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
        Justification = "Method makes a network request")]
        IObservable<IssueEvent> Get(string owner, string name, int number);
@@ -125,7 +125,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
        Justification = "Method makes a network request")]
        IObservable<IssueEvent> Get(int repositoryId, int number);
--- a/Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs
@@ -32,7 +32,7 @@ namespace Octokit.Reactive
        /// <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 <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public IObservable<EventInfo> GetAllForIssue(string owner, string name, int number)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -49,7 +49,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
-        /// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public IObservable<EventInfo> GetAllForIssue(int repositoryId, int number)
        {
            return GetAllForIssue(repositoryId, number, ApiOptions.None);
@@ -65,7 +65,7 @@ namespace Octokit.Reactive
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public IObservable<EventInfo> GetAllForIssue(string owner, string name, int number, ApiOptions options)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -84,7 +84,7 @@ namespace Octokit.Reactive
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public IObservable<EventInfo> GetAllForIssue(int repositoryId, int number, ApiOptions options)
        {
            Ensure.ArgumentNotNull(options, "options");
@@ -100,7 +100,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
-        /// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public IObservable<IssueEvent> GetAllForRepository(string owner, string name)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -116,7 +116,7 @@ namespace Octokit.Reactive
        /// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
-        /// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public IObservable<IssueEvent> GetAllForRepository(int repositoryId)
        {
            return GetAllForRepository(repositoryId, ApiOptions.None);
@@ -131,7 +131,7 @@ namespace Octokit.Reactive
        /// <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>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public IObservable<IssueEvent> GetAllForRepository(string owner, string name, ApiOptions options)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -149,7 +149,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public IObservable<IssueEvent> GetAllForRepository(int repositoryId, ApiOptions options)
        {
            Ensure.ArgumentNotNull(options, "options");
@@ -166,7 +166,7 @@ namespace Octokit.Reactive
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        public IObservable<IssueEvent> Get(string owner, string name, int number)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -183,7 +183,7 @@ namespace Octokit.Reactive
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        public IObservable<IssueEvent> Get(int repositoryId, int number)
        {
            return _client.Get(repositoryId, number).ToObservable();
--- a/Octokit/Clients/IIssuesEventsClient.cs
+++ b/Octokit/Clients/IIssuesEventsClient.cs
@@ -21,7 +21,7 @@ namespace Octokit
        /// <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 <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number);

        /// <summary>
@@ -32,7 +32,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
-        /// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<EventInfo>> GetAllForIssue(int repositoryId, int number);

        /// <summary>
@@ -45,7 +45,7 @@ namespace Octokit
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number, ApiOptions options);

        /// <summary>
@@ -57,7 +57,7 @@ namespace Octokit
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<EventInfo>> GetAllForIssue(int repositoryId, int number, ApiOptions options);

        /// <summary>
@@ -68,7 +68,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
-        /// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name);

        /// <summary>
@@ -78,7 +78,7 @@ namespace Octokit
        /// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
-        /// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<IssueEvent>> GetAllForRepository(int repositoryId);

        /// <summary>
@@ -90,7 +90,7 @@ namespace Octokit
        /// <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>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name, ApiOptions options);

        /// <summary>
@@ -101,7 +101,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        Task<IReadOnlyList<IssueEvent>> GetAllForRepository(int repositoryId, ApiOptions options);

        /// <summary>
@@ -113,7 +113,7 @@ namespace Octokit
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
        Task<IssueEvent> Get(string owner, string name, int number);
@@ -126,7 +126,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
        Task<IssueEvent> Get(int repositoryId, int number);
--- a/Octokit/Clients/IssuesEventsClient.cs
+++ b/Octokit/Clients/IssuesEventsClient.cs
@@ -26,7 +26,7 @@ namespace Octokit
        /// <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 <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -43,7 +43,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
-        /// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<EventInfo>> GetAllForIssue(int repositoryId, int number)
        {
            return GetAllForIssue(repositoryId, number, ApiOptions.None);
@@ -59,7 +59,7 @@ namespace Octokit
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number, ApiOptions options)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -78,7 +78,7 @@ namespace Octokit
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The issue number</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<EventInfo>> GetAllForIssue(int repositoryId, int number, ApiOptions options)
        {
            Ensure.ArgumentNotNull(options, "options");
@@ -94,7 +94,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
-        /// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -110,7 +110,7 @@ namespace Octokit
        /// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
-        /// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<IssueEvent>> GetAllForRepository(int repositoryId)
        {
            return GetAllForRepository(repositoryId, ApiOptions.None);
@@ -125,7 +125,7 @@ namespace Octokit
        /// <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>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name, ApiOptions options)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -143,7 +143,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="options">Options for changing the API response</param>
-        /// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
+        /// <returns></returns>
        public Task<IReadOnlyList<IssueEvent>> GetAllForRepository(int repositoryId, ApiOptions options)
        {
            Ensure.ArgumentNotNull(options, "options");
@@ -160,7 +160,7 @@ namespace Octokit
        /// <param name="owner">The owner of the repository</param>
        /// <param name="name">The name of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        public Task<IssueEvent> Get(string owner, string name, int number)
        {
            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -177,7 +177,7 @@ namespace Octokit
        /// </remarks>
        /// <param name="repositoryId">The ID of the repository</param>
        /// <param name="number">The event id</param>
-        /// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
+        /// <returns></returns>
        public Task<IssueEvent> Get(int repositoryId, int number)
        {
            return ApiConnection.Get<IssueEvent>(ApiUrls.IssuesEvent(repositoryId, number));