Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions xml/Microsoft.CSharp/Compiler.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ Each string in the sourceTexts parameter is the equivalent of a single source fi

The file names in the sourceTextNames parameter are used for compiler diagnostics and debug information. The array is required, but it can be locally overridden by use of the \#line directive. The array must have the same number of elements as the sourceTexts parameter.

The imports parameter is the same as the /reference compiler option. This parameter can be <see langword="null" />.
The imports parameter is the same as the /reference compiler option. This parameter `null`.

For the options parameter, the key is the short form of the compiler option. The value is the value desired for the option. The options parameter can be <see langword="null" />. Some compiler options are not recognized. Recognized options and value:
For the options parameter, the key is the short form of the compiler option. The value is the value desired for the option. The options parameter can be `null`. Some compiler options are not recognized. Recognized options and value:

| Key Name | Usage |
| --- | --- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,7 @@

<xref:System.Net.Http.HttpClient> instances that apply the provided configuration can be retrieved using <xref:System.Net.Http.IHttpClientFactory.CreateClient(System.String)> and providing the matching name.

<typeparamref name="TClient> instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing <typeparamref name="TClient> as the service type.
`TClient` instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing `TClient` as the service type.

]]></format>
</remarks>
Expand Down Expand Up @@ -805,7 +805,7 @@

<xref:System.Net.Http.HttpClient> instances that apply the provided configuration can be retrieved using <xref:System.Net.Http.IHttpClientFactory.CreateClient(System.String)> and providing the matching name.

<typeparamref name="TClient> instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing <typeparamref name="TClient> as the service type.
`TClient` instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing `TClient` as the service type.

]]></format>
</remarks>
Expand Down Expand Up @@ -1062,7 +1062,7 @@

<xref:System.Net.Http.HttpClient> instances that apply the provided configuration can be retrieved using <xref:System.Net.Http.IHttpClientFactory.CreateClient(System.String)> and providing the matching name.

<typeparamref name="TClient> instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing <typeparamref name="TClient> as the service type.
`TClient` instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing `TClient` as the service type.

]]></format>
</remarks>
Expand Down Expand Up @@ -1117,10 +1117,7 @@

<xref:System.Net.Http.HttpClient> instances that apply the provided configuration can be retrieved using <xref:System.Net.Http.IHttpClientFactory.CreateClient(System.String)> and providing the matching name.

<typeparamref name="TClient> instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing <typeparamref name="TClient> as the service type.

<typeparamref name="TImplementation"></typeparamref>

`TClient` instances constructed with the appropriate <xref:System.Net.Http.HttpClient> can be retrieved from <xref:System.IServiceProvider.GetService(System.Type)> (and related methods) by providing `TClient` as the service type.
]]></format>
</remarks>
</Docs>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -563,15 +563,12 @@
<Parameters />
<Docs>
<summary>Returns the type of a control in a control array.</summary>
<returns>This method must be overridden.
<returns>The type of a control in a control array.</returns>
<remarks>This method must be overridden.

The <see cref="T:Microsoft.VisualBasic.Compatibility.VB6.BaseControlArray" /> class is the base class for all control arrays that are used in applications upgraded from Visual Basic 6.0. Because this class is not typically used to create an instance of the class, this <see langword="Protected" /> method is usually not called directly but is instead called by a derived class.

<block subset="none" type="note"><para>
Functions and objects in the <see cref="N:Microsoft.VisualBasic.Compatibility.VB6" /> namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation.

</para></block></returns>
<remarks>To be added.</remarks>
The <see cref="T:Microsoft.VisualBasic.Compatibility.VB6.BaseControlArray" /> class is the base class for all control arrays that are used in applications upgraded from Visual Basic 6.0. Because this class is not typically used to create an instance of the class, this <see langword="Protected" /> method is usually not called directly but is instead called by a derived class.

Functions and objects in the <see cref="N:Microsoft.VisualBasic.Compatibility.VB6" /> namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the .NET Framework. They are necessary only when the Visual Basic 6.0 code model differs significantly from the .NET Framework implementation.</remarks>
<block subset="none" type="overrides">
<para>When you override <see langword="GetControlInstanceType" /> in a derived class, do not call the <see langword="GetControlInstanceType" /> method of the base class.</para>
</block>
Expand Down
7 changes: 1 addition & 6 deletions xml/System.Buffers/ReadOnlySequence`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,7 @@
<Docs>
<param name="memory">A read-only block of memory of elements of type <typeparamref name="T" />.</param>
<summary>Creates an instance of <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a <see cref="T:System.ReadOnlyMemory`1" />. </summary>
<remarks>
<format type="text/markdown"><![CDATA[
The consumer is expected to manage the lifetime of memory until <see cref="T:System.Buffers.ReadOnlySequence`1" /> is not used anymore.

]]></format>
</remarks>
<remarks>The consumer is expected to manage the lifetime of memory until <see cref="T:System.Buffers.ReadOnlySequence`1" /> is not used anymore.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.ComponentModel.Design/ObjectSelectorEditor.xml
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,9 @@
</Parameters>
<Docs>
<param name="treeView">The tree view control to modify.</param>
<summary>Modify a Windows Forms <see cref="T:System.Windows.Forms.TreeView" /> control to use the <related type="Article" href="/dotnet/framework/winforms/controls/creating-an-explorer-style-interface-with-the-listview-and-treeview"> new Explorer style theme</related>.</summary>
<summary>Modify a Windows Forms <see cref="T:System.Windows.Forms.TreeView" /> control to use the new Explorer style theme.</summary>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/framework/winforms/controls/creating-an-explorer-style-interface-with-the-listview-and-treeview">Walkthrough: Create an Explorer Style Interface with the ListView and TreeView Controls</related>
</Docs>
</Member>
<Member MemberName="currValue">
Expand Down
9 changes: 2 additions & 7 deletions xml/System.ComponentModel/AsyncOperation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,7 @@

The `d` parameter wraps the delegate you want called when you want to post an update about the status of the asynchronous task. The <xref:System.ComponentModel.AsyncOperation> object will ensure that your delegate is invoked on the thread or context appropriate for the application model. Your method can optionally raise an event that notifies clients of a status change, progress update, or newly available incremental results.

The `arg` parameter should be used to pass state to the delegate wrapped by the `d` parameter. It might be a reference to an <xref:System.ComponentModel.AsyncOperation>, or it might be a <xref:System.ComponentModel.ProgressChangedEventArgs?displayProperty=nameWithType> object. It may be desirable to derive your own class from <xref:System.ComponentModel.ProgressChangedEventArgs?displayProperty=nameWithType> to provide additional state storage.


The `arg` parameter should be used to pass state to the delegate wrapped by the `d` parameter. It might be a reference to an <xref:System.ComponentModel.AsyncOperation>, or it might be a <xref:System.ComponentModel.ProgressChangedEventArgs?displayProperty=nameWithType> object. It may be desirable to derive your own class from <xref:System.ComponentModel.ProgressChangedEventArgs?displayProperty=nameWithType> to provide additional state storage.

## Examples
The following code example demonstrates using the <xref:System.ComponentModel.AsyncOperation.Post%2A> method for reporting progress and incremental results of an asynchronous operation. This code example is part of a larger example provided for the <xref:System.ComponentModel.AsyncOperationManager?displayProperty=nameWithType> class.
Expand All @@ -221,10 +219,7 @@
<block subset="none" type="overrides">
<para>Inheritors must make the <see cref="M:System.ComponentModel.AsyncOperation.Post(System.Threading.SendOrPostCallback,System.Object)" /> invocation asynchronous, so that class library providers do not need to concern themselves with potential stack overflows if they assume asynchrony but a particular application model happens to be synchronous.

<block subset="none" type="note"><para>
Console applications do not synchronize the execution of <see cref="M:System.ComponentModel.AsyncOperation.Post(System.Threading.SendOrPostCallback,System.Object)" /> calls. This can cause <see langword="ProgressChanged" /> events to be raised out of order. If you wish to have serialized execution of <see cref="M:System.ComponentModel.AsyncOperation.Post(System.Threading.SendOrPostCallback,System.Object)" /> calls, implement and install a <see cref="T:System.Threading.SynchronizationContext" /> class.

</para></block>
Note: Console applications do not synchronize the execution of <see cref="M:System.ComponentModel.AsyncOperation.Post(System.Threading.SendOrPostCallback,System.Object)" /> calls. This can cause <see langword="ProgressChanged" /> events to be raised out of order. If you wish to have serialized execution of <see cref="M:System.ComponentModel.AsyncOperation.Post(System.Threading.SendOrPostCallback,System.Object)" /> calls, implement and install a <see cref="T:System.Threading.SynchronizationContext" /> class.

For more information about implementing asynchronous classes, see [Implementing the Event-based Asynchronous Pattern](/dotnet/standard/asynchronous-programming-patterns/implementing-the-event-based-asynchronous-pattern).</para>
</block>
Expand Down
4 changes: 1 addition & 3 deletions xml/System.ComponentModel/PropertyDescriptor.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1649,9 +1649,7 @@
<block subset="none" type="overrides">
<para>When overridden in a derived class, this method returns <see langword="true" /> if the current value of the property is different from its default value. It looks for a default value by first looking for a <see cref="T:System.ComponentModel.DefaultValueAttribute" />. If the method finds this attribute, it compares the value of the attribute with the property's current value. If this method cannot find a <see cref="T:System.ComponentModel.DefaultValueAttribute" />, it looks for a "ShouldSerializeMyProperty" method that you need to implement. If it is found, <see cref="M:System.ComponentModel.PropertyDescriptor.ShouldSerializeValue(System.Object)" /> invokes it. If this method cannot find a <see cref="T:System.ComponentModel.DefaultValueAttribute" /> or a "ShouldSerializeMyProperty" method, it cannot create optimizations and it returns <see langword="true" />.

<block subset="none" type="note"><para>
The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class implements special serialization logic for inherited components. For more information, see <see cref="T:System.ComponentModel.Design.ComponentDesigner" />.
</para></block></para>
Note: The <see cref="T:System.ComponentModel.Design.ComponentDesigner" /> class implements special serialization logic for inherited components. For more information, see <see cref="T:System.ComponentModel.Design.ComponentDesigner" />.</para>
</block>
<altmember cref="T:System.ComponentModel.Design.ComponentDesigner" />
</Docs>
Expand Down
5 changes: 1 addition & 4 deletions xml/System.ComponentModel/TypeConverter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,7 @@

- To convert types that support standard values, override the <see cref="M:System.ComponentModel.TypeConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" />, <see cref="M:System.ComponentModel.TypeConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)" />, <see cref="M:System.ComponentModel.TypeConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)" /> and <see cref="M:System.ComponentModel.TypeConverter.IsValid(System.ComponentModel.ITypeDescriptorContext,System.Object)" /> methods.

<block subset="none" type="note"><para>
Your derived type might be marked as <see langword="internal" /> or <see langword="private" />, but an instance of your type can be created with the <see cref="T:System.ComponentModel.TypeDescriptor" /> class. Do not write insecure code by assuming the caller is trusted. Assume instead that callers might create instances of your type in partial trust.

</para></block>
Note: Your derived type might be marked as <see langword="internal" /> or <see langword="private" />, but an instance of your type can be created with the <see cref="T:System.ComponentModel.TypeDescriptor" /> class. Do not write insecure code by assuming the caller is trusted. Assume instead that callers might create instances of your type in partial trust.

For more information about type converters for general (non-XAML) purposes, see [How to: Implement a Type Converter](https://docs.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)) or [Generalized Type Conversion](/previous-versions/visualstudio/visual-studio-2013/yy580hbd(v=vs.120)).</para>
</block>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Composition.Hosting.Core/LifetimeContext.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The <xref:System.Composition.Hosting.Core.LifetimeContext> object is the unit of

This object contains two pieces of independently protected shared state: shared part instances and bound part instances.
A shared part instance is lock-free, readable, and does not result in issues if it is added to during disposal. It is protected by being locked itself. Activation logic is unavoidably called under this lock.
A bound part instance is always protected by locking <see langword="this" />, and should never be written to after disposal. A bound part instance is set to <see langword="null" /> under a lock in the <xref:System.Composition.Hosting.Core.LifetimeContext.Dispose> method. If writing were allowed after disposal for a bound part instance, it would result in disposable parts not being released. The dispose method on a bound part is called outside of the lock.
A bound part instance is always protected by locking `this`, and should never be written to after disposal. A bound part instance is set to `null` under a lock in the <xref:System.Composition.Hosting.Core.LifetimeContext.Dispose> method. If writing were allowed after disposal for a bound part instance, it would result in disposable parts not being released. The dispose method on a bound part is called outside of the lock.

]]></format>
</remarks>
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Composition/CompositionContext.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@

## Remarks

Note that this constructor is protected; it can only be called by classes derived from the <see cref="T:System.Composition.CompositionContext"/> class.
This constructor is protected; it can only be called by classes derived from the <xref:System.Composition.CompositionContext> class.

]]></format>
</remarks>
</Docs>
Expand Down
5 changes: 1 addition & 4 deletions xml/System.Configuration/Configuration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,7 @@

These methods provide access to the cached configuration values for the current application, which has better performance than the <see cref="T:System.Configuration.Configuration" /> class.

<block subset="none" type="note"><para>
If you use a static <see langword="GetSection" /> method that takes a path parameter, the path parameter must refer to the application in which the code is running, otherwise the parameter is ignored and configuration information for the currently running application is returned.

</para></block>
Note: If you use a static <see langword="GetSection" /> method that takes a path parameter, the path parameter must refer to the application in which the code is running, otherwise the parameter is ignored and configuration information for the currently running application is returned.

You use one of the <see cref="Overload:System.Configuration.Configuration.Save" /> methods to write configuration information. Note that the user or process that writes must have the following permissions:

Expand Down
9 changes: 2 additions & 7 deletions xml/System.Configuration/ConfigurationSection.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@
A section registers its handling type with an entry in the `configSections` element. For an example, see the configuration file excerpt shown in the Example section.

> [!NOTE]
> In previous versions of the .NET Framework, configuration section handlers were used to make changes to configuration settings programmatically. Now, all the default configuration sections are represented by classes that extend the <xref:System.Configuration.ConfigurationSection> class.


> In previous versions of the .NET Framework, configuration section handlers were used to make changes to configuration settings programmatically. Now, all the default configuration sections are represented by classes that extend the <xref:System.Configuration.ConfigurationSection> class.

## Examples
The following example shows how to implement a custom section programmatically.
Expand Down Expand Up @@ -80,10 +78,7 @@

These methods provide access to the cached configuration values for the current application, which has better performance than the <see cref="T:System.Configuration.Configuration" /> class.

<block subset="none" type="note"><para>
If you use a static <see langword="GetSection" /> method that takes a <paramref name="path" /> parameter, the <paramref name="path" /> parameter must refer to the application in which the code is running; otherwise, the parameter is ignored and configuration information for the currently-running application is returned.

</para></block>
Note: If you use a static <see langword="GetSection" /> method that takes a <paramref name="path" /> parameter, the <paramref name="path" /> parameter must refer to the application in which the code is running; otherwise, the parameter is ignored and configuration information for the currently-running application is returned.

- Writing. You use one of the <see cref="Overload:System.Configuration.Configuration.Save" /> methods to write configuration information. Note that the user or process that writes must have the following permissions:

Expand Down
Loading