Skip to content

Commit d49449e

Browse files
carlossanlopRon Petrusha
andcommitted
Port System.ComponentModel.Composition source comments to Docs (#2489)
* Port System.ComponentModel.Composition source comments to Docs * Apply suggestions from code review Suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]>
1 parent 6d84d5e commit d49449e

File tree

3 files changed

+57
-9
lines changed

3 files changed

+57
-9
lines changed

xml/System.ComponentModel.Composition/ExportAttribute.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,15 @@
191191
<param name="contractName">The contract name that is used to export the type or member marked with this attribute, or <see langword="null" /> or an empty string ("") to use the default contract name.</param>
192192
<param name="contractType">The type to export.</param>
193193
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.ExportAttribute" /> class, exporting the specified type under the specified contract name.</summary>
194-
<remarks>To be added.</remarks>
194+
<remarks>
195+
<format type="text/markdown"><![CDATA[
196+
197+
The default contract name is the result of calling <xref:System.ComponentModel.Composition.AttributedModelServices.GetContractName(System.Type)?displayProperty=nameWithType> on the property or field type, or on the type itself that this is marked with this attribute.
198+
199+
The contract name is compared using a case-sensitive, non-linguistic comparison using <xref:System.StringComparer.Ordinal?displayProperty=nameWithType>.
200+
201+
]]></format>
202+
</remarks>
195203
</Docs>
196204
</Member>
197205
<Member MemberName="ContractName">
@@ -249,4 +257,4 @@
249257
</Docs>
250258
</Member>
251259
</Members>
252-
</Type>
260+
</Type>

xml/System.ComponentModel.Composition/InheritedExportAttribute.xml

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,15 @@
5454
<Parameters />
5555
<Docs>
5656
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class.</summary>
57-
<remarks>To be added.</remarks>
57+
<remarks>
58+
<format type="text/markdown"><![CDATA[
59+
60+
The default contract name is the result of calling <xref:System.ComponentModel.Composition.AttributedModelServices.GetContractName(System.Type)?displayProperty=nameWithType> on the type itself that is marked with this attribute.
61+
62+
The contract name is compared using a case-sensitive, non-linguistic comparison using <xref:System.StringComparer.Ordinal?displayProperty=nameWithType>.
63+
64+
]]></format>
65+
</remarks>
5866
</Docs>
5967
</Member>
6068
<Member MemberName=".ctor">
@@ -81,7 +89,15 @@
8189
<Docs>
8290
<param name="contractName">The name of the contract.</param>
8391
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class with the specified contract name.</summary>
84-
<remarks>To be added.</remarks>
92+
<remarks>
93+
<format type="text/markdown"><![CDATA[
94+
95+
The default contract name is the result of calling <xref:System.ComponentModel.Composition.AttributedModelServices.GetContractName(System.Type)?displayProperty=nameWithType> on the type itself that this is marked with this attribute.
96+
97+
The contract name is compared using a case-sensitive, non-linguistic comparison using <xref:System.StringComparer.Ordinal?displayProperty=nameWithType>.
98+
99+
]]></format>
100+
</remarks>
85101
</Docs>
86102
</Member>
87103
<Member MemberName=".ctor">
@@ -108,7 +124,17 @@
108124
<Docs>
109125
<param name="contractType">The type of the contract.</param>
110126
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class with the specified contract type.</summary>
111-
<remarks>To be added.</remarks>
127+
<remarks>
128+
<format type="text/markdown"><![CDATA[
129+
130+
The contract name is the result of calling <xref:System.ComponentModel.Composition.AttributedModelServices.GetContractName(System.Type)?displayProperty=nameWithType> on `contractType`.
131+
132+
The default contract name is the result of calling <xref:System.ComponentModel.Composition.AttributedModelServices.GetContractName(System.Type)?displayProperty=nameWithType> on the type itself that is marked with this attribute.
133+
134+
The contract name is compared using a case-sensitive, non-linguistic comparison using <xref:System.StringComparer.Ordinal?displayProperty=nameWithType>.
135+
136+
]]></format>
137+
</remarks>
112138
</Docs>
113139
</Member>
114140
<Member MemberName=".ctor">
@@ -137,8 +163,16 @@
137163
<param name="contractName">The name of the contract.</param>
138164
<param name="contractType">The type of the contract.</param>
139165
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class with the specified contract name and type.</summary>
140-
<remarks>To be added.</remarks>
166+
<remarks>
167+
<format type="text/markdown"><![CDATA[
168+
169+
The default contract name is the result of calling <xref:System.ComponentModel.Composition.AttributedModelServices.GetContractName(System.Type)?displayProperty=nameWithType> on the type itself that this is marked with this attribute.
170+
171+
The contract name is compared using a case-sensitive, non-linguistic comparison using <xref:System.StringComparer.Ordinal?displayProperty=nameWithType>.
172+
173+
]]></format>
174+
</remarks>
141175
</Docs>
142176
</Member>
143177
</Members>
144-
</Type>
178+
</Type>

xml/System.ComponentModel.Composition/MetadataViewImplementationAttribute.xml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,13 @@
5050
<Docs>
5151
<param name="implementationType">The type of the metadata view.</param>
5252
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.MetadataViewImplementationAttribute" /> class.</summary>
53-
<remarks>To be added.</remarks>
53+
<remarks>
54+
<format type="text/markdown"><![CDATA[
55+
56+
By default, MetadataViews are generated using reflection emit. This attribute allows the developer to specify the type that implements the view rather than using a generated type.
57+
58+
]]></format>
59+
</remarks>
5460
</Docs>
5561
</Member>
5662
<Member MemberName="ImplementationType">
@@ -76,4 +82,4 @@
7682
</Docs>
7783
</Member>
7884
</Members>
79-
</Type>
85+
</Type>

0 commit comments

Comments
 (0)