Skip to content

Commit 87c6687

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
Automatically port System.ComponentModel triple slash comments (#2669)
* Automatically port System.ComponentModel triple slash comments * rpetrusha suggestions Co-Authored-By: Ron Petrusha <ronpet@microsoft.com> * Corrected badly formed XML. * Update VersionConverter.xml * removed bad para tag
1 parent 34f9a3a commit 87c6687

29 files changed

+298
-69
lines changed

‎xml/System.ComponentModel.Composition.Hosting/AggregateExportProvider.xml

+3
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,9 @@
109109
110110
]]></format>
111111
</remarks>
112+
<exception cref="T:System.ArgumentException">
113+
<paramref name="providers" /> contains an element that is <see langword="null" />.
114+
</exception>
112115
</Docs>
113116
</Member>
114117
<MemberGroup MemberName="Dispose">

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

+26-5
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,11 @@
223223
<param name="codeBase">A string that specifies the code base of the assembly (that is, the path to the assembly file) that contains the attributed <see cref="T:System.Type" /> objects to add to the <see cref="T:System.ComponentModel.Composition.Hosting.AssemblyCatalog" /> object.</param>
224224
<param name="definitionOrigin">The element used by diagnostics to identify the sources of parts.</param>
225225
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AssemblyCatalog" /> class with the specified code base.</summary>
226-
<remarks>To be added.</remarks>
226+
<remarks>
227+
<format type="text/markdown"><![CDATA[
228+
The assembly referenced by `codeBase` is loaded into the Load context.
229+
]]></format>
230+
</remarks>
227231
<exception cref="T:System.BadImageFormatException">
228232
<paramref name="codeBase" /> is not a valid assembly.
229233

@@ -266,7 +270,9 @@
266270
<param name="codeBase">A string that specifies the code base of the assembly (that is, the path to the assembly file) that contains the attributed <see cref="T:System.Type" /> objects to add to the <see cref="T:System.ComponentModel.Composition.Hosting.AssemblyCatalog" /> object.</param>
267271
<param name="reflectionContext">The context used by the catalog to interpret types.</param>
268272
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AssemblyCatalog" /> class with the specified code base and reflection context.</summary>
269-
<remarks>To be added.</remarks>
273+
<remarks>
274+
<format type="text/markdown"><![CDATA[The assembly referenced by`codebase` is loaded into the Load context.]]></format>
275+
</remarks>
270276
<exception cref="T:System.BadImageFormatException">
271277
<paramref name="codeBase" /> is not a valid assembly.
272278

@@ -342,7 +348,9 @@
342348
<param name="reflectionContext">The context used by the catalog to interpret types.</param>
343349
<param name="definitionOrigin">The element used by diagnostics to identify the sources of parts.</param>
344350
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.AssemblyCatalog" /> class with the specified code base and reflection context.</summary>
345-
<remarks>To be added.</remarks>
351+
<remarks>
352+
<format type="text/markdown"><![CDATA[The assembly referenced by `codebase` is loaded into the Load context.]]></format>
353+
</remarks>
346354
<exception cref="T:System.BadImageFormatException">
347355
<paramref name="codeBase" /> is not a valid assembly.
348356

@@ -459,7 +467,20 @@
459467
<param name="definition">Conditions that specify which exports to match.</param>
460468
<summary>Gets a collection of exports that match the conditions specified by the import definition.</summary>
461469
<returns>A collection of exports that match the conditions specified by <paramref name="definition" />.</returns>
462-
<remarks>To be added.</remarks>
470+
<remarks>
471+
<format type="text/markdown"><![CDATA[
472+
## Notes to inheritors
473+
Overriders of this property should never return `null` if no
474+
<xref:System.ComponentModel.Composition.Primitives.ExportDefinition> matches the conditions defined by
475+
`definition`; instead, return an empty <xref:System.Collections.Generic.IEnumerable%601>.
476+
]]></format>
477+
</remarks>
478+
<exception cref="T:System.ArgumentNullException">
479+
<paramref name="definition" /> is <see langword="null" />.
480+
</exception>
481+
<exception cref="T:System.ObjectDisposedException">
482+
The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.
483+
</exception>
463484
</Docs>
464485
</Member>
465486
<Member MemberName="Parts">
@@ -583,4 +604,4 @@
583604
</Docs>
584605
</Member>
585606
</Members>
586-
</Type>
607+
</Type>

‎xml/System.ComponentModel.Composition.Hosting/ComposablePartCatalogChangeEventArgs.xml

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
<param name="atomicComposition">The composition transaction to use, or <see langword="null" /> to disable transactional composition.</param>
4343
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.ComposablePartCatalogChangeEventArgs" /> class with the specified changes.</summary>
4444
<remarks>To be added.</remarks>
45+
<exception cref="T:System.ArgumentNullException"><paramref name="addedDefinitions" /> or <paramref name="removedDefinitions" /> is <see langword="null" />.</exception>
4546
</Docs>
4647
</Member>
4748
<Member MemberName="AddedDefinitions">

‎xml/System.ComponentModel.Composition.Hosting/CompositionContainer.xml

+13
Original file line numberDiff line numberDiff line change
@@ -521,6 +521,7 @@
521521
<param name="export">An indirect reference to the export to remove.</param>
522522
<summary>Removes the specified export from composition and releases its resources if possible.</summary>
523523
<remarks>To be added.</remarks>
524+
<exception cref="T:System.ArgumentNullException"><paramref name="export" /> is <see langword="null" />.</exception>
524525
</Docs>
525526
</Member>
526527
<Member MemberName="ReleaseExports">
@@ -586,6 +587,12 @@
586587
<param name="exports">A collection of indirect references to the exports to be removed.</param>
587588
<summary>Removes a collection of exports from composition and releases their resources if possible.</summary>
588589
<remarks>To be added.</remarks>
590+
<exception cref="T:System.ArgumentNullException">
591+
<paramref name="exports" /> is <see langword="null" />.
592+
</exception>
593+
<exception cref="T:System.ArgumentException">
594+
<paramref name="exports" /> contains an element that is <see langword="null" />.
595+
</exception>
589596
</Docs>
590597
</Member>
591598
<Member MemberName="ReleaseExports&lt;T,TMetadataView&gt;">
@@ -617,6 +624,12 @@
617624
<param name="exports">A collection of indirect references to the exports to be removed and their metadata.</param>
618625
<summary>Removes a collection of exports from composition and releases their resources if possible.</summary>
619626
<remarks>To be added.</remarks>
627+
<exception cref="T:System.ArgumentNullException">
628+
<paramref name="exports" /> is <see langword="null" />.
629+
</exception>
630+
<exception cref="T:System.ArgumentException">
631+
<paramref name="exports" /> contains an element that is <see langword="null" />.
632+
</exception>
620633
</Docs>
621634
</Member>
622635
<Member MemberName="SatisfyImportsOnce">

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

+19-3
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,19 @@ For more information, see [Implementing a Dispose method](~/docs/standard/garbag
270270
<param name="definition">Conditions that specify which exports to match.</param>
271271
<summary>Gets a collection of exports that match the conditions specified by the import definition.</summary>
272272
<returns>A collection of exports that match the specified conditions.</returns>
273-
<remarks>To be added.</remarks>
273+
<remarks>
274+
<format type="text/markdown"><![CDATA[
275+
## Note to inheritors
276+
277+
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>.
278+
]]></format>
279+
</remarks>
280+
<exception cref="T:System.ArgumentNullException">
281+
<paramref name="definition" /> is <see langword="null" />.
282+
</exception>
283+
<exception cref="T:System.ObjectDisposedException">
284+
The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.
285+
</exception>
274286
</Docs>
275287
</Member>
276288
<Member MemberName="OnChanged">
@@ -342,8 +354,12 @@ For more information, see [Implementing a Dispose method](~/docs/standard/garbag
342354
<Docs>
343355
<summary>Gets a collection of parts visible to the parent scope of this catalog.</summary>
344356
<value>A collection of parts visible to the parent scope of this catalog.</value>
345-
<remarks>To be added.</remarks>
357+
<remarks>
358+
<format type="text/markdown"><![CDATA[
359+
Overriders of this property must not return `null`.
360+
]]></format>
361+
</remarks>
346362
</Docs>
347363
</Member>
348364
</Members>
349-
</Type>
365+
</Type>

‎xml/System.ComponentModel.Composition.Hosting/DirectoryCatalog.xml

+1
Original file line numberDiff line numberDiff line change
@@ -657,6 +657,7 @@
657657
658658
]]></format>
659659
</remarks>
660+
<exception cref="T:System.IO.DirectoryNotFoundException">The specified path has been removed since object construction.</exception>
660661
</Docs>
661662
</Member>
662663
<Member MemberName="SearchPattern">

‎xml/System.ComponentModel.Composition.Hosting/ExportsChangeEventArgs.xml

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
<param name="atomicComposition">The composition transaction that contains the change.</param>
4343
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Hosting.ExportsChangeEventArgs" /> class.</summary>
4444
<remarks>To be added.</remarks>
45+
<exception cref="T:System.ArgumentNullException"><paramref name="addedExports" /> or <paramref name="removedExports" /> is <see langword="null" />.</exception>
4546
</Docs>
4647
</Member>
4748
<Member MemberName="AddedExports">

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

+14-2
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,19 @@
211211
<param name="definition">The import to match.</param>
212212
<summary>Gets the exported parts from this catalog that match the specified import.</summary>
213213
<returns>A collection of matching parts.</returns>
214-
<remarks>To be added.</remarks>
214+
<remarks>
215+
<format type="text/markdown"><![CDATA[
216+
## Notes to inheritors
217+
218+
Overriders of this property should never return `null` if no Mxref:System.ComponentModel.Composition.Primitives.ExportDefinition> matches the conditions defined by `definition`; instead, return an empty <xref:System.Collections.Generic.IEnumerable%601>.
219+
]]></format>
220+
</remarks>
221+
<exception cref="T:System.ArgumentNullException">
222+
<paramref name="definition" /> is <see langword="null" />.
223+
</exception>
224+
<exception cref="T:System.ObjectDisposedException">
225+
The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePartCatalog" /> has been disposed.
226+
</exception>
215227
</Docs>
216228
</Member>
217229
<MemberGroup MemberName="IncludeDependencies">
@@ -383,4 +395,4 @@
383395
</Docs>
384396
</Member>
385397
</Members>
386-
</Type>
398+
</Type>

‎xml/System.ComponentModel.Composition.Hosting/ImportEngine.xml

+25-1
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,10 @@
218218
<param name="atomicComposition">The composition transaction to use, or <see langword="null" /> for no composition transaction.</param>
219219
<summary>Previews all the required imports for the specified part to make sure that they can be satisfied, without actually setting them.</summary>
220220
<remarks>To be added.</remarks>
221+
<exception cref="T:System.ComponentModel.Composition.CompositionException">
222+
An error occurred during previewing, and <paramref name="atomicComposition" /> is <see langword="null" />. <see cref="P:System.ComponentModel.Composition.CompositionException.Errors" /> will contain a collection of errors that occurred. The pre-existing composition is in an unknown state, depending on the errors that occurred.</exception>
223+
<exception cref="T:System.ComponentModel.Composition.ChangeRejectedException">An error occurred during previewing, and <paramref name="atomicComposition" /> is not <see langword="null" />. <see cref="P:System.ComponentModel.Composition.CompositionException.Errors" /> will contain a collection of errors that occurred. The pre-existing composition remains in valid state.</exception>
224+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.ComponentModel.Composition.Hosting.ImportEngine" /> has been disposed.</exception>
221225
</Docs>
222226
</Member>
223227
<Member MemberName="ReleaseImports">
@@ -269,6 +273,16 @@
269273
<param name="part">The part to satisfy the imports of.</param>
270274
<summary>Satisfies the imports of the specified part.</summary>
271275
<remarks>To be added.</remarks>
276+
<exception cref="T:System.ArgumentNullException">
277+
<paramref name="part" /> is <see langword="null" />.
278+
</exception>
279+
<exception cref="T:System.ComponentModel.Composition.CompositionException">
280+
An error occurred during composition. <see cref="P:System.ComponentModel.Composition.CompositionException.Errors" /> will
281+
contain a collection of errors that occurred.
282+
</exception>
283+
<exception cref="T:System.ObjectDisposedException">
284+
The <see cref="T:System.ComponentModel.Composition.Hosting.ImportEngine" /> has been disposed.
285+
</exception>
272286
</Docs>
273287
</Member>
274288
<Member MemberName="SatisfyImportsOnce">
@@ -297,7 +311,17 @@
297311
<param name="part">The part to satisfy the imports of.</param>
298312
<summary>Satisfies the imports of the specified part without registering them for recomposition.</summary>
299313
<remarks>To be added.</remarks>
314+
<exception cref="T:System.ArgumentNullException">
315+
<paramref name="part" /> is <see langword="null" />.
316+
</exception>
317+
<exception cref="T:System.ComponentModel.Composition.CompositionException">
318+
An error occurred during composition. <see cref="P:System.ComponentModel.Composition.CompositionException.Errors" /> will
319+
contain a collection of errors that occurred.
320+
</exception>
321+
<exception cref="T:System.ObjectDisposedException">
322+
The <see cref="T:System.ComponentModel.Composition.ICompositionService" /> has been disposed.
323+
</exception>
300324
</Docs>
301325
</Member>
302326
</Members>
303-
</Type>
327+
</Type>

‎xml/System.ComponentModel.Composition.Primitives/ComposablePart.xml

+3
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@
6969
7070
]]></format>
7171
</remarks>
72+
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" /> has been disposed of.</exception>
73+
<exception cref="T:System.ComponentModel.Composition.Primitives.ComposablePartException">An error occurred activating the <see cref="T:System.ComponentModel.Composition.Primitives.ComposablePart" />.
74+
</exception>
7275
</Docs>
7376
</Member>
7477
<Member MemberName="ExportDefinitions">

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

+31-4
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,18 @@
4444
<Parameters />
4545
<Docs>
4646
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition" /> class.</summary>
47-
<remarks>To be added.</remarks>
47+
<remarks>
48+
<format type="text/markdown"><![CDATA[
49+
50+
## Note to inheritors
51+
52+
Derived types calling this constructor can optionally override the
53+
<xref:System.ComponentModel.Composition.Primitives.ImportDefinition.ContractName>, <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredTypeIdentity>,
54+
<xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredMetadata>, <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.Cardinality>,
55+
<xref:System.ComponentModel.Composition.Primitives.ImportDefinition.IsPrerequisite>, <xref:System.ComponentModel.Composition.Primitives.ImportDefinition.IsRecomposable>
56+
and <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredCreationPolicy> properties.
57+
]]></format>
58+
</remarks>
4859
</Docs>
4960
</Member>
5061
<Member MemberName=".ctor">
@@ -164,7 +175,14 @@
164175
<Docs>
165176
<summary>Gets an expression that defines conditions that must be matched to satisfy the import described by this import definition.</summary>
166177
<value>An expression that contains a <see cref="T:System.Func`2" /> object that defines the conditions that must be matched for the <see cref="T:System.ComponentModel.Composition.Primitives.ImportDefinition" /> to be satisfied by an <see cref="T:System.ComponentModel.Composition.Primitives.Export" />.</value>
167-
<remarks>To be added.</remarks>
178+
<remarks>
179+
<format type="text/markdown"><![CDATA[
180+
This property returns an expression that defines conditions based on the
181+
<xref:System.ComponentModel.Composition.Primitives.ImportDefinition.ContractName>, <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredTypeIdentity>,
182+
<xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredMetadata>, and <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.RequiredCreationPolicy>
183+
properties.
184+
]]></format>
185+
</remarks>
168186
</Docs>
169187
</Member>
170188
<Member MemberName="IsConstraintSatisfiedBy">
@@ -190,7 +208,16 @@
190208
<summary>Returns a value indicating whether the constraint represented by this object is satisfied by the export represented by the given export definition.</summary>
191209
<returns>
192210
<see langword="true" /> if the constraint is satisfied; otherwise, <see langword="false" />.</returns>
193-
<remarks>To be added.</remarks>
211+
<remarks>
212+
<format type="text/markdown"><![CDATA[
213+
## Note to inheritors
214+
215+
Overrides of this method can provide a more optimized execution of the <xref:System.ComponentModel.Composition.Primitives.ContractBasedImportDefinition.Constraint> property, but the result should remain consistent.
216+
]]></format>
217+
</remarks>
218+
<exception cref="T:System.ArgumentNullException">
219+
<paramref name="exportDefinition" /> is <see langword="null" />.
220+
</exception>
194221
</Docs>
195222
</Member>
196223
<Member MemberName="RequiredCreationPolicy">
@@ -306,4 +333,4 @@
306333
</Docs>
307334
</Member>
308335
</Members>
309-
</Type>
336+
</Type>

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

+13-2
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,17 @@
200200
<Docs>
201201
<summary>Returns the exported object the export provides.</summary>
202202
<returns>The exported object the export provides.</returns>
203-
<remarks>To be added.</remarks>
203+
<remarks>
204+
<format type="text/markdown"><![CDATA[
205+
## Note to inheritors
206+
207+
Overrides of this method should never return `null`.
208+
]]></format>
209+
</remarks>
204210
<exception cref="T:System.NotImplementedException">The <see cref="M:System.ComponentModel.Composition.Primitives.Export.GetExportedValueCore" /> method was not overridden by a derived class.</exception>
205211
<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>
212+
<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>.
213+
</exception>
206214
</Docs>
207215
</Member>
208216
<Member MemberName="Metadata">
@@ -255,7 +263,10 @@
255263
<summary>Provides the object this export represents.</summary>
256264
<value>The object this export represents.</value>
257265
<remarks>To be added.</remarks>
266+
<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>
267+
<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>
268+
<exception cref="T:System.NotImplementedException">The <see cref="M:System.ComponentModel.Composition.Primitives.Export.GetExportedValueCore" /> method was not overridden by a derived class.</exception>
258269
</Docs>
259270
</Member>
260271
</Members>
261-
</Type>
272+
</Type>

0 commit comments

Comments
 (0)