Merge pull request #10368 from dotnet/main

Merge main into live
dotnet · Sep 6, 2024 · f84cf77 · f84cf77
2 parents 6807978 + e1ba32a
commit f84cf77
Show file tree

Hide file tree

Showing 139 changed files with 27,014 additions and 26,971 deletions.
diff --git a/xml/System.Security.Cryptography/CngKeyCreationOptions.xml b/xml/System.Security.Cryptography/CngKeyCreationOptions.xml
@@ -205,7 +205,7 @@
       </ReturnValue>
       <MemberValue>65536</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Indicates a key should be protected with Virtualization-based security (VBS).</summary>
       </Docs>
     </Member>
     <Member MemberName="RequireVbs">
@@ -231,7 +231,7 @@
       </ReturnValue>
       <MemberValue>131072</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Indicates a key must be protected with Virtualization-based security (VBS).</summary>
       </Docs>
     </Member>
     <Member MemberName="UsePerBootKey">
@@ -257,7 +257,9 @@
       </ReturnValue>
       <MemberValue>262144</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
+          <para>Instructs Virtualization-based security (VBS) to protect the client key with a per-boot key when combined with <see cref="F:System.Security.Cryptography.CngKeyCreationOptions.RequireVbs" /> or <see cref="F:System.Security.Cryptography.CngKeyCreationOptions.PreferVbs" />.</para>
+        </summary>
       </Docs>
     </Member>
   </Members>

diff --git a/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml b/xml/System.Security.Cryptography/SafeEvpPKeyHandle.xml
@@ -260,11 +260,21 @@
         <Parameter Name="keyUri" Type="System.String" Index="1" FrameworkAlternate="net-9.0" />
       </Parameters>
       <Docs>
-        <param name="providerName">To be added.</param>
-        <param name="keyUri">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="providerName">The name of the <code>OSSL_PROVIDER</code> to process the key open request.</param>
+        <param name="keyUri">The URI assigned by the <code>OSSL_PROVIDER</code> of the key to open.</param>
+        <summary>Opens a named key using a named <code>OSSL_PROVIDER</code>.</summary>
+        <returns>The opened key.</returns>
+        <remarks>
+          <para>Both <paramref name="providerName" /> and <paramref name="keyUri" /> must be trusted inputs.</para>
+          <para>This operation will fail if OpenSSL cannot successfully load the named <code>OSSL_PROVIDER</code>, or if the named <code>OSSL_PROVIDER</code> cannot load the named key.</para>
+          <para>The syntax for <paramref name="keyUri" /> is determined by each individual named <code>OSSL_PROVIDER</code>.</para>
+        </remarks>
+        <exception cref="T:System.ArgumentNullException">
+          <paramref name="providerName" /> or <paramref name="keyUri" /> is <see langword="null" />.</exception>
+        <exception cref="T:System.ArgumentException">
+          <paramref name="providerName" /> or <paramref name="keyUri" /> is the empty string.</exception>
+        <exception cref="T:System.PlatformNotSupportedException">The current platform does not support OpenSSL Providers.</exception>
+        <exception cref="T:System.Security.Cryptography.CryptographicException">The key could not be opened via the specified named <code>OSSL_PROVIDER</code>.</exception>
       </Docs>
     </Member>
     <Member MemberName="OpenPrivateKeyFromEngine">

diff --git a/xml/System.Windows.Annotations.Storage/AnnotationStore.xml b/xml/System.Windows.Annotations.Storage/AnnotationStore.xml
diff --git a/xml/System.Windows.Controls.Primitives/MenuBase.xml b/xml/System.Windows.Controls.Primitives/MenuBase.xml
@@ -33,13 +33,13 @@
   <Docs>
     <summary>Represents a control that defines choices for users to select.</summary>
     <remarks>
-      <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- The <xref:System.Windows.Controls.Primitives.MenuBase> is the base class for controls that define choices for users to select. The <xref:System.Windows.Controls.Menu> and <xref:System.Windows.Controls.ContextMenu> inherit from <xref:System.Windows.Controls.Primitives.MenuBase> and allow the user to select an item to invoke some action.  
-  
- <xref:System.Windows.Controls.Primitives.MenuBase> is an <xref:System.Windows.Controls.ItemsControl>, which means it can contain a collection of objects of any type (such as string, image, or panel). For more information, see the <xref:System.Windows.Controls.ItemsControl> class.  
-  
+      <format type="text/markdown"><![CDATA[
+
+## Remarks
+ The <xref:System.Windows.Controls.Primitives.MenuBase> is the base class for controls that define choices for users to select. The <xref:System.Windows.Controls.Menu> and <xref:System.Windows.Controls.ContextMenu> inherit from <xref:System.Windows.Controls.Primitives.MenuBase> and allow the user to select an item to invoke some action.
+
+ <xref:System.Windows.Controls.Primitives.MenuBase> is an <xref:System.Windows.Controls.ItemsControl>, which means it can contain a collection of objects of any type (such as string, image, or panel). For more information, see the <xref:System.Windows.Controls.ItemsControl> class.
+
  ]]></format>
     </remarks>
   </Docs>
@@ -181,19 +181,19 @@
         <summary>Gets or sets the custom logic for choosing a template used to display each item.</summary>
         <value>A custom object that provides logic and returns an item container.</value>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- Use an <xref:System.Windows.Controls.ItemContainerTemplateSelector> to choose different item containers if the items in your collection are the same type and you need to provide custom logic to choose the item container.  
-  
-<a name="dependencyPropertyInfo_ItemContainerTemplateSelector"></a>   
-## Dependency Property Information  
-  
-|||  
-|-|-|  
-|Identifier field|<xref:System.Windows.Controls.Primitives.MenuBase.ItemContainerTemplateSelectorProperty>|  
-|Metadata properties set to `true`|None|  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ Use an <xref:System.Windows.Controls.ItemContainerTemplateSelector> to choose different item containers if the items in your collection are the same type and you need to provide custom logic to choose the item container.
+
+<a name="dependencyPropertyInfo_ItemContainerTemplateSelector"></a>
+## Dependency Property Information
+
+|||
+|-|-|
+|Identifier field|<xref:System.Windows.Controls.Primitives.MenuBase.ItemContainerTemplateSelectorProperty>|
+|Metadata properties set to `true`|None|
+
  ]]></format>
         </remarks>
       </Docs>
@@ -281,11 +281,11 @@
         <param name="e">The event data for the <see cref="E:System.Windows.UIElement.KeyDown" /> event.</param>
         <summary>Provides class handling for the <see cref="E:System.Windows.UIElement.KeyDown" /> routed event that occurs when the user presses a key.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- If the user presses ESC, ALT+ALT, or ALT+F10, this implementation marks the <xref:System.Windows.UIElement.KeyDown> event as handled by setting the <xref:System.Windows.RoutedEventArgs.Handled%2A> property of the event data to `true`.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ If the user presses ESC, ALT+ALT, or ALT+F10, this implementation marks the <xref:System.Windows.UIElement.KeyDown> event as handled by setting the <xref:System.Windows.RoutedEventArgs.Handled%2A> property of the event data to `true`.
+
  ]]></format>
         </remarks>
         <block subset="none" type="overrides">
@@ -321,11 +321,11 @@
         <param name="e">The event data for the <see cref="E:System.Windows.UIElement.MouseLeave" /> event.</param>
         <summary>Provides class handling for the <see cref="E:System.Windows.UIElement.MouseLeave" /> routed event that occurs when the mouse leaves the control.</summary>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- This implementation does not change the handled state (the <xref:System.Windows.RoutedEventArgs.Handled%2A> property) of the <xref:System.Windows.UIElement.MouseLeave> event data.  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ This implementation does not change the handled state (the <xref:System.Windows.RoutedEventArgs.Handled%2A> property) of the <xref:System.Windows.UIElement.MouseLeave> event data.
+
  ]]></format>
         </remarks>
         <block subset="none" type="overrides">
@@ -356,23 +356,23 @@
       <Docs>
         <summary>Gets or sets a value that indicates whether the menu selects different item containers, depending on the type of the item in the underlying collection or some other heuristic.</summary>
         <value>
-          <see langword="true" /> the menu selects different item containers; otherwise, <see langword="false" />.  
-  
- The registered default is <see langword="false" />. For more information about what can influence the value, see [Dependency Property Value Precedence](/dotnet/framework/wpf/advanced/dependency-property-value-precedence).</value>
+          <see langword="true" /> the menu selects different item containers; otherwise, <see langword="false" />.
+
+ The registered default is <see langword="false" />. For more information about what can influence the value, see <see href="/dotnet/framework/wpf/advanced/dependency-property-value-precedence">Dependency Property Value Precedence</see>.</value>
         <remarks>
-          <format type="text/markdown"><![CDATA[  
-  
-## Remarks  
- This property is useful if you want to create a menu by binding to a collection.  The item container is the UI element that displays the object in a collection. If you want to bind to a collection to create a menu that contains <xref:System.Windows.Controls.MenuItem> objects and <xref:System.Windows.Controls.Separator> objects, set the <xref:System.Windows.Controls.Primitives.MenuBase.UsesItemContainerTemplate%2A> property to true and create an <xref:System.Windows.Controls.ItemContainerTemplate> for each type of object in your collection.  Each <xref:System.Windows.Controls.ItemContainerTemplate> must contain either a <xref:System.Windows.Controls.MenuItem> or a <xref:System.Windows.Controls.Separator>.  
-  
-<a name="dependencyPropertyInfo_UsesItemContainerTemplate"></a>   
-## Dependency Property Information  
-  
-|||  
-|-|-|  
-|Identifier field|<xref:System.Windows.Controls.Primitives.MenuBase.UsesItemContainerTemplateProperty>|  
-|Metadata properties set to `true`|None|  
-  
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ This property is useful if you want to create a menu by binding to a collection.  The item container is the UI element that displays the object in a collection. If you want to bind to a collection to create a menu that contains <xref:System.Windows.Controls.MenuItem> objects and <xref:System.Windows.Controls.Separator> objects, set the <xref:System.Windows.Controls.Primitives.MenuBase.UsesItemContainerTemplate%2A> property to true and create an <xref:System.Windows.Controls.ItemContainerTemplate> for each type of object in your collection.  Each <xref:System.Windows.Controls.ItemContainerTemplate> must contain either a <xref:System.Windows.Controls.MenuItem> or a <xref:System.Windows.Controls.Separator>.
+
+<a name="dependencyPropertyInfo_UsesItemContainerTemplate"></a>
+## Dependency Property Information
+
+|||
+|-|-|
+|Identifier field|<xref:System.Windows.Controls.Primitives.MenuBase.UsesItemContainerTemplateProperty>|
+|Metadata properties set to `true`|None|
+
  ]]></format>
         </remarks>
       </Docs>