re-enable InheritDoc (Azure#17259)

* re-enable inheritdoc and fix non-generated comment warnings
annelo-msft · Feb 17, 2021 · a370951 · a370951
1 parent c85264e
commit a370951
Show file tree

Hide file tree

Showing 14 changed files with 40 additions and 46 deletions.
diff --git a/eng/Directory.Build.Data.props b/eng/Directory.Build.Data.props
@@ -55,7 +55,7 @@
     <GenerateAPIListing Condition="'$(IsShippingClientLibrary)' == 'true'">true</GenerateAPIListing>
     <UpdateSourceOnBuild Condition="'$(UpdateSourceOnBuild)' == ''">$(AZURE_DEV_UPDATESOURCESONBUILD)</UpdateSourceOnBuild>
     <PowerShellExe Condition="'$(PowerShellExe)' == ''">pwsh</PowerShellExe>
-    <InheritDocEnabled>false</InheritDocEnabled>
+    <InheritDocEnabled>true</InheritDocEnabled>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(IsShippingClientLibrary)' == 'true' and '$(TF_BUILD)' == 'true'">

diff --git a/sdk/core/Azure.Core.Amqp/src/AmqpAddress.cs b/sdk/core/Azure.Core.Amqp/src/AmqpAddress.cs
@@ -86,13 +86,13 @@ public bool Equals(AmqpAddress other) =>
         public bool Equals(string other) =>
             _address == other;
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="AmqpAddress"/> values for equality.</summary>
         public static bool operator ==(AmqpAddress left, AmqpAddress right)
         {
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="AmqpAddress"/> values for inequality.</summary>
         public static bool operator !=(AmqpAddress left, AmqpAddress right)
         {
             return !(left == right);

diff --git a/sdk/core/Azure.Core.Amqp/src/AmqpMessageId.cs b/sdk/core/Azure.Core.Amqp/src/AmqpMessageId.cs
@@ -87,13 +87,13 @@ public bool Equals(AmqpMessageId other) =>
         public bool Equals(string other) =>
             _messageIdString == other;
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="AmqpMessageId"/> values for equality.</summary>
         public static bool operator ==(AmqpMessageId left, AmqpMessageId right)
         {
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="AmqpMessageId"/> values for inequality.</summary>
         public static bool operator !=(AmqpMessageId left, AmqpMessageId right)
         {
             return !(left == right);

diff --git a/...grid/Microsoft.Azure.WebJobs.Extensions.EventGrid/src/OutputBinding/EventGridAttribute.cs b/...grid/Microsoft.Azure.WebJobs.Extensions.EventGrid/src/OutputBinding/EventGridAttribute.cs
@@ -6,7 +6,7 @@
 
 namespace Microsoft.Azure.WebJobs.Extensions.EventGrid
 {
-    /// <summary>Attribute to specify parameters for the Event Grid output binding</summary>
+    /// <summary>Attribute to specify parameters for the Event Grid output binding.</summary>
     /// <seealso cref="System.Attribute" />
     [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.ReturnValue)]
     [Binding]

diff --git a/sdk/search/Azure.Search.Documents/src/SearchDocument/SearchDocument.Dictionary.cs b/sdk/search/Azure.Search.Documents/src/SearchDocument/SearchDocument.Dictionary.cs
@@ -32,13 +32,13 @@ public bool TryGetValue(string key, out object value) =>
         /// <inheritdoc />
         public ICollection<string> Keys => _values.Keys;
 
-        /// <inheritdoc />
+        /// <inheritdoc cref="IDictionary{TKey, TValue}.Values" />
         ICollection<object> IDictionary<string, object>.Values => _values.Values;
 
         /// <inheritdoc />
         public int Count => _values.Count;
 
-        /// <inheritdoc />
+        /// <inheritdoc cref="ICollection{T}.IsReadOnly" />
         bool ICollection<KeyValuePair<string, object>>.IsReadOnly => _values.IsReadOnly;
 
         /// <inheritdoc />
@@ -47,15 +47,15 @@ public bool TryGetValue(string key, out object value) =>
         /// <inheritdoc />
         public bool ContainsKey(string key) => _values.ContainsKey(key);
 
-        /// <inheritdoc />
+        /// <inheritdoc cref="ICollection{T}.Add" />
         void ICollection<KeyValuePair<string, object>>.Add(KeyValuePair<string, object> item) =>
             SetValue(item.Key, item.Value);
 
-        /// <inheritdoc />
+        /// <inheritdoc cref="ICollection{T}.Contains" />
         bool ICollection<KeyValuePair<string, object>>.Contains(KeyValuePair<string, object> item) =>
             _values.Contains(item);
 
-        /// <inheritdoc />
+        /// <inheritdoc cref="ICollection{T}.CopyTo" />
         void ICollection<KeyValuePair<string, object>>.CopyTo(KeyValuePair<string, object>[] array, int arrayIndex) =>
             _values.CopyTo(array, arrayIndex);
 
@@ -69,7 +69,7 @@ public IEnumerator<KeyValuePair<string, object>> GetEnumerator() =>
         /// <inheritdoc />
         public bool Remove(string key) => _values.Remove(key);
 
-        /// <inheritdoc />
+        /// <inheritdoc cref="ICollection{T}.Remove" />
         bool ICollection<KeyValuePair<string, object>>.Remove(KeyValuePair<string, object> item) =>
             _values.Remove(item);
 

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/CorrelationRuleFilter.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/CorrelationRuleFilter.cs
@@ -265,7 +265,7 @@ public override bool Equals(RuleFilter other)
             return false;
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="CorrelationRuleFilter"/> values for equality.</summary>
         public static bool operator ==(CorrelationRuleFilter left, CorrelationRuleFilter right)
         {
             if (ReferenceEquals(left, right))
@@ -281,7 +281,7 @@ public override bool Equals(RuleFilter other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="CorrelationRuleFilter"/> values for inequality.</summary>
         public static bool operator !=(CorrelationRuleFilter left, CorrelationRuleFilter right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/CreateRuleOptions.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/CreateRuleOptions.cs
@@ -130,7 +130,7 @@ public bool Equals(CreateRuleOptions other)
             return false;
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="CreateRuleOptions"/> values for equality.</summary>
         public static bool operator ==(CreateRuleOptions left, CreateRuleOptions right)
         {
             if (ReferenceEquals(left, right))
@@ -146,7 +146,7 @@ public bool Equals(CreateRuleOptions other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="CreateRuleOptions"/> values for inequality.</summary>
         public static bool operator !=(CreateRuleOptions left, CreateRuleOptions right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/FalseRuleFilter.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/FalseRuleFilter.cs
@@ -46,7 +46,7 @@ public override bool Equals(RuleFilter other)
             return other is FalseRuleFilter;
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="FalseRuleFilter"/> values for equality.</summary>
         public static bool operator ==(FalseRuleFilter left, FalseRuleFilter right)
         {
             if (ReferenceEquals(left, right))
@@ -62,7 +62,7 @@ public override bool Equals(RuleFilter other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="FalseRuleFilter"/> values for inequality.</summary>
         public static bool operator !=(FalseRuleFilter left, FalseRuleFilter right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/RuleProperties.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/RuleProperties.cs
@@ -121,8 +121,7 @@ public bool Equals(RuleProperties other)
             return false;
         }
 
-        /// <inheritdoc/>
-
+        /// <summary>Compares two <see cref="RuleProperties"/> values for equality.</summary>
         public static bool operator ==(RuleProperties left, RuleProperties right)
         {
             if (ReferenceEquals(left, right))
@@ -138,8 +137,7 @@ public bool Equals(RuleProperties other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
-
+        /// <summary>Compares two <see cref="RuleProperties"/> values for inequality.</summary>
         public static bool operator !=(RuleProperties left, RuleProperties right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/SqlRuleAction.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/SqlRuleAction.cs
@@ -97,8 +97,7 @@ public override bool Equals(RuleAction other)
             return false;
         }
 
-        /// <inheritdoc/>
-
+        /// <summary>Compares two <see cref="SqlRuleAction"/> values for equality.</summary>
         public static bool operator ==(SqlRuleAction left, SqlRuleAction right)
         {
             if (ReferenceEquals(left, right))
@@ -114,8 +113,7 @@ public override bool Equals(RuleAction other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
-
+        /// <summary>Compares two <see cref="SqlRuleAction"/> values for inequality.</summary>
         public static bool operator !=(SqlRuleAction left, SqlRuleAction right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/SqlRuleFilter.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/SqlRuleFilter.cs
@@ -104,7 +104,7 @@ public override bool Equals(RuleFilter other)
             return false;
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="SqlRuleFilter"/> values for equality.</summary>
         public static bool operator ==(SqlRuleFilter left, SqlRuleFilter right)
         {
             if (ReferenceEquals(left, right))
@@ -120,7 +120,7 @@ public override bool Equals(RuleFilter other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Compares two <see cref="SqlRuleFilter"/> values for inequality.</summary>
         public static bool operator !=(SqlRuleFilter left, SqlRuleFilter right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/TrueRuleFilter.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/TrueRuleFilter.cs
@@ -48,8 +48,7 @@ public override bool Equals(RuleFilter other)
             return other is TrueRuleFilter;
         }
 
-        /// <inheritdoc/>
-
+        /// <summary>Compares two <see cref="TrueRuleFilter"/> values for equality.</summary>
         public static bool operator ==(TrueRuleFilter left, TrueRuleFilter right)
         {
             if (ReferenceEquals(left, right))
@@ -65,8 +64,7 @@ public override bool Equals(RuleFilter other)
             return left.Equals(right);
         }
 
-        /// <inheritdoc/>
-
+        /// <summary>Compares two <see cref="TrueRuleFilter"/> values for inequality.</summary>
         public static bool operator !=(TrueRuleFilter left, TrueRuleFilter right)
         {
             return !(left == right);

diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ServiceBusErrorSource.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ServiceBusErrorSource.cs
@@ -6,25 +6,25 @@ namespace Azure.Messaging.ServiceBus
     /// <summary>The source of the error when <see cref="ProcessErrorEventArgs"/> is raised.</summary>
     public enum ServiceBusErrorSource
     {
-        /// <summary>Message completion operation</summary>
+        /// <summary>Message completion operation.</summary>
         Complete,
 
-        /// <summary>Message abandon operation</summary>
+        /// <summary>Message abandon operation.</summary>
         Abandon,
 
-        /// <summary>Process message handler invocation</summary>
+        /// <summary>Process message handler invocation.</summary>
         ProcessMessageCallback,
 
-        /// <summary>Message receive operation</summary>
+        /// <summary>Message receive operation.</summary>
         Receive,
 
-        /// <summary>Lock renewal operation</summary>
+        /// <summary>Lock renewal operation.</summary>
         RenewLock,
 
-        /// <summary>Session start operation</summary>
+        /// <summary>Session start operation.</summary>
         AcceptSession,
 
-        /// <summary>Session close operation</summary>
+        /// <summary>Session close operation.</summary>
         CloseSession
     }
 }
diff --git a/sdk/servicebus/Microsoft.Azure.ServiceBus/src/ExceptionReceivedEventArgsAction.cs b/sdk/servicebus/Microsoft.Azure.ServiceBus/src/ExceptionReceivedEventArgsAction.cs
@@ -6,25 +6,25 @@ namespace Microsoft.Azure.ServiceBus
     /// <summary>Action taking place when <see cref="ExceptionReceivedEventArgs"/> is raised.</summary>
     public static class ExceptionReceivedEventArgsAction
     {
-        /// <summary>Message completion operation</summary>
+        /// <summary>Message completion operation.</summary>
         public const string Complete = "Complete";
 
-        /// <summary>Message abandon operation</summary>
+        /// <summary>Message abandon operation.</summary>
         public const string Abandon = "Abandon";
 
-        /// <summary>User message handler invocation</summary>
+        /// <summary>User message handler invocation.</summary>
         public const string UserCallback = "UserCallback";
 
-        /// <summary>Message receive operation</summary>
+        /// <summary>Message receive operation.</summary>
         public const string Receive = "Receive";
 
-        /// <summary>Message lock renewal operation</summary>
+        /// <summary>Message lock renewal operation.</summary>
         public const string RenewLock = "RenewLock";
 
-        /// <summary>Session start operation</summary>
+        /// <summary>Session start operation.</summary>
         public const string AcceptMessageSession = "AcceptMessageSession";
 
-        /// <summary>Session close operation</summary>
+        /// <summary>Session close operation.</summary>
         public const string CloseMessageSession = "CloseMessageSession";
     }
 }