Skip to content

Commit 1058ca2

Browse files
christotheschristothes
authored
re-enable InheritDoc (#17259)
* re-enable inheritdoc and fix non-generated comment warnings
1 parent af4fa58 commit 1058ca2

File tree

14 files changed

+40
-46
lines changed

14 files changed

+40
-46
lines changed

‎eng/Directory.Build.Data.props‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
<GenerateAPIListing Condition="'$(IsShippingClientLibrary)' == 'true'">true</GenerateAPIListing>
5656
<UpdateSourceOnBuild Condition="'$(UpdateSourceOnBuild)' == ''">$(AZURE_DEV_UPDATESOURCESONBUILD)</UpdateSourceOnBuild>
5757
<PowerShellExe Condition="'$(PowerShellExe)' == ''">pwsh</PowerShellExe>
58-
<InheritDocEnabled>false</InheritDocEnabled>
58+
<InheritDocEnabled>true</InheritDocEnabled>
5959
</PropertyGroup>
6060

6161
<PropertyGroup Condition="'$(IsShippingClientLibrary)' == 'true' and '$(TF_BUILD)' == 'true'">

‎sdk/core/Azure.Core.Amqp/src/AmqpAddress.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,13 @@ public bool Equals(AmqpAddress other) =>
8686
public bool Equals(string other) =>
8787
_address == other;
8888

89-
/// <inheritdoc/>
89+
/// <summary>Compares two <see cref="AmqpAddress"/> values for equality.</summary>
9090
public static bool operator ==(AmqpAddress left, AmqpAddress right)
9191
{
9292
return left.Equals(right);
9393
}
9494

95-
/// <inheritdoc/>
95+
/// <summary>Compares two <see cref="AmqpAddress"/> values for inequality.</summary>
9696
public static bool operator !=(AmqpAddress left, AmqpAddress right)
9797
{
9898
return !(left == right);

‎sdk/core/Azure.Core.Amqp/src/AmqpMessageId.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ public bool Equals(AmqpMessageId other) =>
8787
public bool Equals(string other) =>
8888
_messageIdString == other;
8989

90-
/// <inheritdoc/>
90+
/// <summary>Compares two <see cref="AmqpMessageId"/> values for equality.</summary>
9191
public static bool operator ==(AmqpMessageId left, AmqpMessageId right)
9292
{
9393
return left.Equals(right);
9494
}
9595

96-
/// <inheritdoc/>
96+
/// <summary>Compares two <see cref="AmqpMessageId"/> values for inequality.</summary>
9797
public static bool operator !=(AmqpMessageId left, AmqpMessageId right)
9898
{
9999
return !(left == right);

‎sdk/eventgrid/Microsoft.Azure.WebJobs.Extensions.EventGrid/src/OutputBinding/EventGridAttribute.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace Microsoft.Azure.WebJobs.Extensions.EventGrid
88
{
9-
/// <summary>Attribute to specify parameters for the Event Grid output binding</summary>
9+
/// <summary>Attribute to specify parameters for the Event Grid output binding.</summary>
1010
/// <seealso cref="System.Attribute" />
1111
[AttributeUsage(AttributeTargets.Parameter | AttributeTargets.ReturnValue)]
1212
[Binding]

‎sdk/search/Azure.Search.Documents/src/SearchDocument/SearchDocument.Dictionary.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ public bool TryGetValue(string key, out object value) =>
3232
/// <inheritdoc />
3333
public ICollection<string> Keys => _values.Keys;
3434

35-
/// <inheritdoc />
35+
/// <inheritdoc cref="IDictionary{TKey, TValue}.Values" />
3636
ICollection<object> IDictionary<string, object>.Values => _values.Values;
3737

3838
/// <inheritdoc />
3939
public int Count => _values.Count;
4040

41-
/// <inheritdoc />
41+
/// <inheritdoc cref="ICollection{T}.IsReadOnly" />
4242
bool ICollection<KeyValuePair<string, object>>.IsReadOnly => _values.IsReadOnly;
4343

4444
/// <inheritdoc />
@@ -47,15 +47,15 @@ public bool TryGetValue(string key, out object value) =>
4747
/// <inheritdoc />
4848
public bool ContainsKey(string key) => _values.ContainsKey(key);
4949

50-
/// <inheritdoc />
50+
/// <inheritdoc cref="ICollection{T}.Add" />
5151
void ICollection<KeyValuePair<string, object>>.Add(KeyValuePair<string, object> item) =>
5252
SetValue(item.Key, item.Value);
5353

54-
/// <inheritdoc />
54+
/// <inheritdoc cref="ICollection{T}.Contains" />
5555
bool ICollection<KeyValuePair<string, object>>.Contains(KeyValuePair<string, object> item) =>
5656
_values.Contains(item);
5757

58-
/// <inheritdoc />
58+
/// <inheritdoc cref="ICollection{T}.CopyTo" />
5959
void ICollection<KeyValuePair<string, object>>.CopyTo(KeyValuePair<string, object>[] array, int arrayIndex) =>
6060
_values.CopyTo(array, arrayIndex);
6161

@@ -69,7 +69,7 @@ public IEnumerator<KeyValuePair<string, object>> GetEnumerator() =>
6969
/// <inheritdoc />
7070
public bool Remove(string key) => _values.Remove(key);
7171

72-
/// <inheritdoc />
72+
/// <inheritdoc cref="ICollection{T}.Remove" />
7373
bool ICollection<KeyValuePair<string, object>>.Remove(KeyValuePair<string, object> item) =>
7474
_values.Remove(item);
7575

‎sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/CorrelationRuleFilter.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ public override bool Equals(RuleFilter other)
265265
return false;
266266
}
267267

268-
/// <inheritdoc/>
268+
/// <summary>Compares two <see cref="CorrelationRuleFilter"/> values for equality.</summary>
269269
public static bool operator ==(CorrelationRuleFilter left, CorrelationRuleFilter right)
270270
{
271271
if (ReferenceEquals(left, right))
@@ -281,7 +281,7 @@ public override bool Equals(RuleFilter other)
281281
return left.Equals(right);
282282
}
283283

284-
/// <inheritdoc/>
284+
/// <summary>Compares two <see cref="CorrelationRuleFilter"/> values for inequality.</summary>
285285
public static bool operator !=(CorrelationRuleFilter left, CorrelationRuleFilter right)
286286
{
287287
return !(left == right);

‎sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/CreateRuleOptions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ public bool Equals(CreateRuleOptions other)
130130
return false;
131131
}
132132

133-
/// <inheritdoc/>
133+
/// <summary>Compares two <see cref="CreateRuleOptions"/> values for equality.</summary>
134134
public static bool operator ==(CreateRuleOptions left, CreateRuleOptions right)
135135
{
136136
if (ReferenceEquals(left, right))
@@ -146,7 +146,7 @@ public bool Equals(CreateRuleOptions other)
146146
return left.Equals(right);
147147
}
148148

149-
/// <inheritdoc/>
149+
/// <summary>Compares two <see cref="CreateRuleOptions"/> values for inequality.</summary>
150150
public static bool operator !=(CreateRuleOptions left, CreateRuleOptions right)
151151
{
152152
return !(left == right);

‎sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/FalseRuleFilter.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public override bool Equals(RuleFilter other)
4646
return other is FalseRuleFilter;
4747
}
4848

49-
/// <inheritdoc/>
49+
/// <summary>Compares two <see cref="FalseRuleFilter"/> values for equality.</summary>
5050
public static bool operator ==(FalseRuleFilter left, FalseRuleFilter right)
5151
{
5252
if (ReferenceEquals(left, right))
@@ -62,7 +62,7 @@ public override bool Equals(RuleFilter other)
6262
return left.Equals(right);
6363
}
6464

65-
/// <inheritdoc/>
65+
/// <summary>Compares two <see cref="FalseRuleFilter"/> values for inequality.</summary>
6666
public static bool operator !=(FalseRuleFilter left, FalseRuleFilter right)
6767
{
6868
return !(left == right);

‎sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/RuleProperties.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,7 @@ public bool Equals(RuleProperties other)
121121
return false;
122122
}
123123

124-
/// <inheritdoc/>
125-
124+
/// <summary>Compares two <see cref="RuleProperties"/> values for equality.</summary>
126125
public static bool operator ==(RuleProperties left, RuleProperties right)
127126
{
128127
if (ReferenceEquals(left, right))
@@ -138,8 +137,7 @@ public bool Equals(RuleProperties other)
138137
return left.Equals(right);
139138
}
140139

141-
/// <inheritdoc/>
142-
140+
/// <summary>Compares two <see cref="RuleProperties"/> values for inequality.</summary>
143141
public static bool operator !=(RuleProperties left, RuleProperties right)
144142
{
145143
return !(left == right);

‎sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/Rules/SqlRuleAction.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,7 @@ public override bool Equals(RuleAction other)
9797
return false;
9898
}
9999

100-
/// <inheritdoc/>
101-
100+
/// <summary>Compares two <see cref="SqlRuleAction"/> values for equality.</summary>
102101
public static bool operator ==(SqlRuleAction left, SqlRuleAction right)
103102
{
104103
if (ReferenceEquals(left, right))
@@ -114,8 +113,7 @@ public override bool Equals(RuleAction other)
114113
return left.Equals(right);
115114
}
116115

117-
/// <inheritdoc/>
118-
116+
/// <summary>Compares two <see cref="SqlRuleAction"/> values for inequality.</summary>
119117
public static bool operator !=(SqlRuleAction left, SqlRuleAction right)
120118
{
121119
return !(left == right);

0 commit comments

Comments
 (0)