Automatically port System.Composition triple slash comments (#2680)

* Automatically port System.Composition triple slash comments

* Documented some exception conditions.

* Revised exception condition.

* suggestion by maryamariyan

* remarks

Author: carlossanlop

xml/System.Composition.Hosting.Core/CompositionOperation.xml

@@ -22,7 +22,15 @@
   </Interfaces>
   <Docs>
     <summary>Represents a single composition operation.</summary>
-    <remarks></remarks>
+    <remarks>
+      <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+Instances of this class are not safe for access by multiple threads.
+
+      ]]></format>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName="AddNonPrerequisiteAction">
@@ -152,4 +160,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

xml/System.Composition.Hosting.Core/ExportDescriptorProvider.xml

@@ -18,7 +18,15 @@
   <Interfaces />
   <Docs>
     <summary>Provides the description of an export for a part known to the composition engine.</summary>
-    <remarks></remarks>
+    <remarks>
+      <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+Instances of this class are not required to be safe for concurrent access by multiple threads.
+
+      ]]></format>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">
@@ -155,4 +163,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

xml/System.Composition.Hosting.Core/LifetimeContext.xml

@@ -241,10 +241,10 @@ A bound part instance is always protected by locking <see langword="this" />, an
         <param name="contract">The contract.</param>
         <param name="export">After this method returns, contains the contract instance if available; otherwise, <see langword="null" />.</param>
         <summary>Retrieves a contract instance from the composition context.</summary>
-        <returns>
-          <see langword="true" /> if the instance was retrieved; otherwise, <see langword="false" />.</returns>
+        <returns><see langword="true" /> if the instance was retrieved; otherwise, <see langword="false" />.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

xml/System.Composition/CompositionContext.xml

@@ -74,7 +74,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves the export that matches the specified contract.</summary>
         <returns>The exported value.</returns>
         <remarks></remarks>
-        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export found for <paramref name="contract" />.</exception>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExport">
@@ -103,6 +103,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves the export that matches the specified type.</summary>
         <returns>The exported value.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="exportType" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExport">
@@ -133,6 +134,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves the export that matches the specified name and type.</summary>
         <returns>The exported value.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="exportType" /> and <paramref name="contractName" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExport&lt;TExport&gt;">
@@ -162,6 +164,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves the export that matches the specified generic type parameter.</summary>
         <returns>The exported value.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <typeparamref name="TExport" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExport&lt;TExport&gt;">
@@ -194,6 +197,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves the export that matches the specified generic type parameter and contract name.</summary>
         <returns>The exported value.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <typeparamref name="TExport" /> and <paramref name="contractName" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExports">
@@ -222,6 +226,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves a collection of all exports that match the specified type.</summary>
         <returns>A collection of exported values.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No exports were found for <paramref name="exportType" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExports">
@@ -252,6 +257,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves all exports that match the specified contract name and type.</summary>
         <returns>A collection of exported values.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No exports were found for <paramref name="exportType" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExports&lt;TExport&gt;">
@@ -281,6 +287,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves all exports that match the specified generic type parameter.</summary>
         <returns>A collection of exported values.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No exports were found for <typeparamref name="TExport" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="GetExports&lt;TExport&gt;">
@@ -313,6 +320,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <summary>Retrieves all exports that match the specified generic type parameter and contract name.</summary>
         <returns>A collection of exported values.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No exports were found for <typeparamref name="TExport" /> and <paramref name="contractName" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="TryGetExport">
@@ -344,6 +352,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <returns>
           <see langword="true" /> if an export was found; otherwise, <see langword="false" />.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="TryGetExport">
@@ -375,6 +384,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <returns>
           <see langword="true" /> if an export was found; otherwise, <see langword="false" />.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="TryGetExport">
@@ -408,6 +418,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <returns>
           <see langword="true" /> if an export was found; otherwise, <see langword="false" />.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="TryGetExport&lt;TExport&gt;">
@@ -441,6 +452,7 @@ Note that this constructor is protected; it can only be called by classes derive
         <returns>
           <see langword="true" /> if an export was found; otherwise, <see langword="false" />.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
     <Member MemberName="TryGetExport&lt;TExport&gt;">
@@ -476,7 +488,8 @@ Note that this constructor is protected; it can only be called by classes derive
         <returns>
           <see langword="true" /> if an export was found; otherwise, <see langword="false" />.</returns>
         <remarks></remarks>
+        <exception cref="T:System.Composition.Hosting.CompositionFailedException">No export was found for <paramref name="contract" />.</exception>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>

xml/System.Composition/CompositionContextExtensions.xml

@@ -46,7 +46,15 @@
         <param name="compositionContext">The context to draw exports from.</param>
         <param name="objectWithLooseImports">The object to satisfy imports on.</param>
         <summary>Satisfies the imports of the specified object from the specified context.</summary>
-        <remarks></remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+Because this method uses reflection, it is slow. Caching can help improve performance.
+
+          ]]></format>
+        </remarks>
         <exception cref="T:System.ArgumentNullException">
           <paramref name="compositionContext" /> is <see langword="null" />.</exception>
         <exception cref="T:System.ArgumentNullException">
@@ -82,7 +90,15 @@
         <param name="objectWithLooseImports">The object to satisfy imports on.</param>
         <param name="conventions">Conventions to use when satisfying imports.</param>
         <summary>Satisfies the imports of the specified object from the specified context, using the specified conventions.</summary>
-        <remarks></remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+Because this method uses reflection, it is slow. Caching can help improve performance.
+
+          ]]></format>
+        </remarks>
         <exception cref="T:System.ArgumentNullException">
           <paramref name="compositionContext" /> is <see langword="null" />.</exception>
         <exception cref="T:System.ArgumentNullException">
@@ -94,4 +110,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>