Skip to content

Commit ae3396c

Browse files
authored
Reinstate remarks that were never ported to dotnet/docs (dotnet#9755)
1 parent ba5b6bb commit ae3396c

File tree

7 files changed

+64
-25
lines changed

7 files changed

+64
-25
lines changed

xml/System.ComponentModel.Composition.Hosting/AssemblyCatalog.xml

+8-1
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,14 @@ The assembly referenced by `codeBase` is loaded into the Load context.
496496
<param name="definition">Conditions that specify which exports to match.</param>
497497
<summary>Gets a collection of exports that match the conditions specified by the import definition.</summary>
498498
<returns>A collection of exports that match the conditions specified by <paramref name="definition" />.</returns>
499-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-composition-hosting-assemblycatalog-getexports"&gt;Supplemental API remarks for System.ComponentModel.Composition.Hosting.AssemblyCatalog.GetExports&lt;/see&gt;.</remarks>
499+
<remarks>
500+
<format type="text/markdown"><![CDATA[
501+
## Notes to inheritors
502+
503+
Overriders of this property should never return `null` if no <xref:System.ComponentModel.Composition.Primitives.ExportDefinition> matches the conditions defined by `definition`; instead, return an empty <xref:System.Collections.Generic.IEnumerable%601>.
504+
505+
]]></format>
506+
</remarks>
500507
<exception cref="T:System.ArgumentNullException">
501508
<paramref name="definition" /> is <see langword="null" />.</exception>
502509
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.</exception>

xml/System.ComponentModel.Composition.Hosting/CompositionScopeDefinition.xml

+10-6
Original file line numberDiff line numberDiff line change
@@ -306,13 +306,17 @@ For more information, see [Implementing a Dispose method](/dotnet/standard/garba
306306
<param name="definition">Conditions that specify which exports to match.</param>
307307
<summary>Gets a collection of exports that match the conditions specified by the import definition.</summary>
308308
<returns>A collection of exports that match the specified conditions.</returns>
309-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-composition-hosting-compositionscopedefinition-getexports"&gt;Supplemental API remarks for System.ComponentModel.Composition.Hosting.CompositionScopeDefinition.GetExports&lt;/see&gt;.</remarks>
309+
<remarks>
310+
<format type="text/markdown"><![CDATA[
311+
## Note to inheritors
312+
313+
Overriders of this property should never return `null`. If there is no <xref:System.ComponentModel.Composition.Primitives.ExportDefinition> that matches the conditions defined by `definition`, return an empty <xref:System.Collections.Generic.IEnumerable%601>.
314+
315+
]]></format>
316+
</remarks>
310317
<exception cref="T:System.ArgumentNullException">
311-
<paramref name="definition" /> is <see langword="null" />.
312-
</exception>
313-
<exception cref="T:System.ObjectDisposedException">
314-
The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.
315-
</exception>
318+
<paramref name="definition" /> is <see langword="null" />.</exception>
319+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.</exception>
316320
</Docs>
317321
</Member>
318322
<Member MemberName="OnChanged">

xml/System.ComponentModel.Composition.Hosting/FilteredCatalog.xml

+10-6
Original file line numberDiff line numberDiff line change
@@ -246,13 +246,17 @@
246246
<param name="definition">The import to match.</param>
247247
<summary>Gets the exported parts from this catalog that match the specified import.</summary>
248248
<returns>A collection of matching parts.</returns>
249-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-composition-hosting-filteredcatalog-getexports"&gt;Supplemental API remarks for System.ComponentModel.Composition.Hosting.FilteredCatalog.GetExports&lt;/see&gt;.</remarks>
249+
<remarks>
250+
<format type="text/markdown"><![CDATA[
251+
## Notes to inheritors
252+
253+
Overriders of this property should never return `null` if no <xref:System.ComponentModel.Composition.Primitives.ExportDefinition> matches the conditions defined by `definition`; instead, return an empty <xref:System.Collections.Generic.IEnumerable%601>.
254+
255+
]]></format>
256+
</remarks>
250257
<exception cref="T:System.ArgumentNullException">
251-
<paramref name="definition" /> is <see langword="null" />.
252-
</exception>
253-
<exception cref="T:System.ObjectDisposedException">
254-
The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.
255-
</exception>
258+
<paramref name="definition" /> is <see langword="null" />.</exception>
259+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.</exception>
256260
</Docs>
257261
</Member>
258262
<MemberGroup MemberName="IncludeDependencies">

xml/System.ComponentModel.Composition.Primitives/ContractBasedImportDefinition.xml

+10-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,16 @@
5757
<Parameters />
5858
<Docs>
5959
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition" /> class.</summary>
60-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-composition-primitives-contractbasedimportdefinition--ctor"&gt;Supplemental API remarks for System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition..ctor&lt;/see&gt;.</remarks>
60+
<remarks>
61+
<format type="text/markdown"><![CDATA[
62+
63+
## Note to inheritors
64+
65+
Derived types calling this constructor can optionally override the <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.ContractName>, <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredTypeIdentity>,
66+
<xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredMetadata>, <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.Cardinality>, <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.IsPrerequisite>, <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.IsRecomposable>, and <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredCreationPolicy> properties.
67+
68+
]]></format>
69+
</remarks>
6170
</Docs>
6271
</Member>
6372
<Member MemberName=".ctor">

xml/System.ComponentModel.Composition.Primitives/Export.xml

+9-3
Original file line numberDiff line numberDiff line change
@@ -256,11 +256,17 @@
256256
<Docs>
257257
<summary>Returns the exported object the export provides.</summary>
258258
<returns>The exported object the export provides.</returns>
259-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-composition-primitives-export-getexportedvaluecore"&gt;Supplemental API remarks for System.ComponentModel.Composition.Primitives.Export.GetExportedValueCore&lt;/see&gt;.</remarks>
259+
<remarks>
260+
<format type="text/markdown"><![CDATA[
261+
## Note to inheritors
262+
263+
Overrides of this method should never return `null`.
264+
265+
]]></format>
266+
</remarks>
260267
<exception cref="T:System.NotImplementedException">The <see cref="M:System.ComponentModel.Composition.Primitives.Export.GetExportedValueCore" /> method was not overridden by a derived class.</exception>
261268
<exception cref="T:System.ComponentModel.Composition.CompositionException">An error occurred during composition. <see cref="P:System.ComponentModel.Composition.CompositionException.Errors" /> will contain a collection of errors that occurred.</exception>
262-
<exception cref="T:System.ComponentModel.Composition.CompositionContractMismatchException">The current instance is an instance of <see cref="T:System.Lazy`1" />, and the underlying exported value cannot be cast to <c>T</c>.
263-
</exception>
269+
<exception cref="T:System.ComponentModel.Composition.CompositionContractMismatchException">The current instance is an instance of <see cref="T:System.Lazy`1" />, and the underlying exported value cannot be cast to <c>T</c>.</exception>
264270
</Docs>
265271
</Member>
266272
<Member MemberName="Metadata">

xml/System.ComponentModel.Composition.Primitives/ImportDefinition.xml

+9-3
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,16 @@
276276
<summary>Gets a value that indicates whether the export represented by the specified definition satisfies the constraints of this import definition.</summary>
277277
<returns>
278278
<see langword="true" /> if the constraints are satisfied; otherwise, <see langword="false" />.</returns>
279-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-composition-primitives-importdefinition-isconstraintsatisfiedby"&gt;Supplemental API remarks for System.ComponentModel.Composition.Primitives.ImportDefinition.IsConstraintSatisfiedBy&lt;/see&gt;.</remarks>
279+
<remarks>
280+
<format type="text/markdown"><![CDATA[
281+
## Note to inheritors
282+
283+
Overrides of this method can provide a more optimized execution of the <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.Constraint> property, but the result should remain consistent.
284+
285+
]]></format>
286+
</remarks>
280287
<exception cref="T:System.ArgumentNullException">
281-
<paramref name="exportDefinition" /> is <see langword="null" />.
282-
</exception>
288+
<paramref name="exportDefinition" /> is <see langword="null" />.</exception>
283289
</Docs>
284290
</Member>
285291
<Member MemberName="IsPrerequisite">

xml/System.ComponentModel.DataAnnotations/ValidationAttribute.xml

+8-5
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,12 @@
9393
<Parameters />
9494
<Docs>
9595
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.DataAnnotations.ValidationAttribute" /> class.</summary>
96-
<remarks>For more information about this API, see &lt;see href="/dotnet/fundamentals/runtime-libraries/system-componentmodel-dataannotations-validationattribute--ctor"&gt;Supplemental API remarks for System.ComponentModel.DataAnnotations.ValidationAttribute..ctor&lt;/see&gt;.</remarks>
96+
<remarks>
97+
<format type="text/markdown"><![CDATA[
98+
This constructor chooses a generic validation error message. If you subclass `ValidationAttribute`, use other constructors or supply a better message.
99+
100+
]]></format>
101+
</remarks>
97102
</Docs>
98103
</Member>
99104
<Member MemberName=".ctor">
@@ -138,8 +143,7 @@
138143
<remarks>
139144
<format type="text/markdown"><![CDATA[
140145
141-
## Remarks
142-
This constructor provides a resource accessor function that is used by the <xref:System.ComponentModel.DataAnnotations.ValidationAttribute.ErrorMessageString%2A> property to retrieve an error message.
146+
This constructor provides a resource accessor function that is used by the <xref:System.ComponentModel.DataAnnotations.ValidationAttribute.ErrorMessageString%2A> property to retrieve an error message.
143147
144148
]]></format>
145149
</remarks>
@@ -232,8 +236,7 @@
232236
<remarks>
233237
<format type="text/markdown"><![CDATA[
234238
235-
## Remarks
236-
This property is the error message that you associate with the validation control. It is used for non-localized error messages.
239+
This property is the error message that you associate with the validation control. It is used for non-localized error messages.
237240
238241
]]></format>
239242
</remarks>

0 commit comments

Comments
 (0)