You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: xml/System.ComponentModel.Composition/ExportAttribute.xml
+10-2Lines changed: 10 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -191,7 +191,15 @@
191
191
<paramname="contractName">The contract name that is used to export the type or member marked with this attribute, or <seelangword="null" /> or an empty string ("") to use the default contract name.</param>
192
192
<paramname="contractType">The type to export.</param>
193
193
<summary>Initializes a new instance of the <seecref="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
+
<formattype="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>.
Copy file name to clipboardExpand all lines: xml/System.ComponentModel.Composition/InheritedExportAttribute.xml
+39-5Lines changed: 39 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,15 @@
54
54
<Parameters />
55
55
<Docs>
56
56
<summary>Initializes a new instance of the <seecref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class.</summary>
57
-
<remarks>To be added.</remarks>
57
+
<remarks>
58
+
<formattype="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>
58
66
</Docs>
59
67
</Member>
60
68
<MemberMemberName=".ctor">
@@ -81,7 +89,15 @@
81
89
<Docs>
82
90
<paramname="contractName">The name of the contract.</param>
83
91
<summary>Initializes a new instance of the <seecref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class with the specified contract name.</summary>
84
-
<remarks>To be added.</remarks>
92
+
<remarks>
93
+
<formattype="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>
85
101
</Docs>
86
102
</Member>
87
103
<MemberMemberName=".ctor">
@@ -108,7 +124,17 @@
108
124
<Docs>
109
125
<paramname="contractType">The type of the contract.</param>
110
126
<summary>Initializes a new instance of the <seecref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class with the specified contract type.</summary>
111
-
<remarks>To be added.</remarks>
127
+
<remarks>
128
+
<formattype="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>
112
138
</Docs>
113
139
</Member>
114
140
<MemberMemberName=".ctor">
@@ -137,8 +163,16 @@
137
163
<paramname="contractName">The name of the contract.</param>
138
164
<paramname="contractType">The type of the contract.</param>
139
165
<summary>Initializes a new instance of the <seecref="T:System.ComponentModel.Composition.InheritedExportAttribute" /> class with the specified contract name and type.</summary>
140
-
<remarks>To be added.</remarks>
166
+
<remarks>
167
+
<formattype="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>.
Copy file name to clipboardExpand all lines: xml/System.ComponentModel.Composition/MetadataViewImplementationAttribute.xml
+8-2Lines changed: 8 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,13 @@
50
50
<Docs>
51
51
<paramname="implementationType">The type of the metadata view.</param>
52
52
<summary>Initializes a new instance of the <seecref="T:System.ComponentModel.Composition.MetadataViewImplementationAttribute" /> class.</summary>
53
-
<remarks>To be added.</remarks>
53
+
<remarks>
54
+
<formattype="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.
0 commit comments