From 822d4a31507e1c3ebec68d03daf218a09aac1594 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 6 Aug 2021 13:02:42 -0700 Subject: [PATCH 1/2] html tag cleanup --- xml/Microsoft.CSharp/Compiler.xml | 4 ++-- ...HttpClientFactoryServiceCollectionExtensions.xml | 11 ++++------- .../BaseControlArray.xml | 13 +++++-------- xml/System.Buffers/ReadOnlySequence`1.xml | 7 +------ .../ObjectSelectorEditor.xml | 3 ++- xml/System.ComponentModel/AsyncOperation.xml | 9 ++------- xml/System.ComponentModel/PropertyDescriptor.xml | 4 +--- xml/System.ComponentModel/TypeConverter.xml | 5 +---- .../LifetimeContext.xml | 2 +- xml/System.Composition/CompositionContext.xml | 2 +- xml/System.Configuration/Configuration.xml | 5 +---- xml/System.Configuration/ConfigurationSection.xml | 9 ++------- xml/System.Configuration/ConfigurationSettings.xml | 7 +------ xml/System.Configuration/SectionInformation.xml | 10 +++------- 14 files changed, 27 insertions(+), 64 deletions(-) diff --git a/xml/Microsoft.CSharp/Compiler.xml b/xml/Microsoft.CSharp/Compiler.xml index 3aaa9a2d40c..984d818ea8e 100644 --- a/xml/Microsoft.CSharp/Compiler.xml +++ b/xml/Microsoft.CSharp/Compiler.xml @@ -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 . +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 . 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 | | --- | --- | diff --git a/xml/Microsoft.Extensions.DependencyInjection/HttpClientFactoryServiceCollectionExtensions.xml b/xml/Microsoft.Extensions.DependencyInjection/HttpClientFactoryServiceCollectionExtensions.xml index 404733cb0a3..eca12ee8933 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/HttpClientFactoryServiceCollectionExtensions.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/HttpClientFactoryServiceCollectionExtensions.xml @@ -752,7 +752,7 @@ instances that apply the provided configuration can be retrieved using and providing the matching name. - as the service type. + `TClient` instances constructed with the appropriate can be retrieved from (and related methods) by providing `TClient` as the service type. ]]> @@ -805,7 +805,7 @@ instances that apply the provided configuration can be retrieved using and providing the matching name. - as the service type. + `TClient` instances constructed with the appropriate can be retrieved from (and related methods) by providing `TClient` as the service type. ]]> @@ -1062,7 +1062,7 @@ instances that apply the provided configuration can be retrieved using and providing the matching name. - as the service type. + `TClient` instances constructed with the appropriate can be retrieved from (and related methods) by providing `TClient` as the service type. ]]> @@ -1117,10 +1117,7 @@ instances that apply the provided configuration can be retrieved using and providing the matching name. - as the service type. - - - + `TClient` instances constructed with the appropriate can be retrieved from (and related methods) by providing `TClient` as the service type. ]]> diff --git a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml index 33d43194e6c..de19a3a0d75 100644 --- a/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml +++ b/xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml @@ -563,15 +563,12 @@ Returns the type of a control in a control array. - This method must be overridden. + The type of a control in a control array. + This method must be overridden. - The 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 method is usually not called directly but is instead called by a derived class. - - - Functions and objects in the 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. - - - To be added. + The 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 method is usually not called directly but is instead called by a derived class. + + Functions and objects in the 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. When you override in a derived class, do not call the method of the base class. diff --git a/xml/System.Buffers/ReadOnlySequence`1.xml b/xml/System.Buffers/ReadOnlySequence`1.xml index 7dedc6f5356..01ba69d7b1f 100644 --- a/xml/System.Buffers/ReadOnlySequence`1.xml +++ b/xml/System.Buffers/ReadOnlySequence`1.xml @@ -66,12 +66,7 @@ A read-only block of memory of elements of type . Creates an instance of from a . - - is not used anymore. - -]]> - + The consumer is expected to manage the lifetime of memory until is not used anymore. diff --git a/xml/System.ComponentModel.Design/ObjectSelectorEditor.xml b/xml/System.ComponentModel.Design/ObjectSelectorEditor.xml index 6a99728ba2f..92c8e25f33b 100644 --- a/xml/System.ComponentModel.Design/ObjectSelectorEditor.xml +++ b/xml/System.ComponentModel.Design/ObjectSelectorEditor.xml @@ -145,8 +145,9 @@ The tree view control to modify. - Modify a Windows Forms control to use the new Explorer style theme. + Modify a Windows Forms control to use the new Explorer style theme. To be added. + Walkthrough: Create an Explorer Style Interface with the ListView and TreeView Controls diff --git a/xml/System.ComponentModel/AsyncOperation.xml b/xml/System.ComponentModel/AsyncOperation.xml index 24a94f9818d..837b2f00613 100644 --- a/xml/System.ComponentModel/AsyncOperation.xml +++ b/xml/System.ComponentModel/AsyncOperation.xml @@ -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 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 , or it might be a object. It may be desirable to derive your own class from 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 , or it might be a object. It may be desirable to derive your own class from to provide additional state storage. ## Examples The following code example demonstrates using the method for reporting progress and incremental results of an asynchronous operation. This code example is part of a larger example provided for the class. @@ -221,10 +219,7 @@ Inheritors must make the 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. - - Console applications do not synchronize the execution of calls. This can cause events to be raised out of order. If you wish to have serialized execution of calls, implement and install a class. - - +Note: Console applications do not synchronize the execution of calls. This can cause events to be raised out of order. If you wish to have serialized execution of calls, implement and install a 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). diff --git a/xml/System.ComponentModel/PropertyDescriptor.xml b/xml/System.ComponentModel/PropertyDescriptor.xml index 474c2317900..fa63278a5ca 100644 --- a/xml/System.ComponentModel/PropertyDescriptor.xml +++ b/xml/System.ComponentModel/PropertyDescriptor.xml @@ -1649,9 +1649,7 @@ When overridden in a derived class, this method returns if the current value of the property is different from its default value. It looks for a default value by first looking for a . 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 , it looks for a "ShouldSerializeMyProperty" method that you need to implement. If it is found, invokes it. If this method cannot find a or a "ShouldSerializeMyProperty" method, it cannot create optimizations and it returns . - - The class implements special serialization logic for inherited components. For more information, see . - +Note: The class implements special serialization logic for inherited components. For more information, see . diff --git a/xml/System.ComponentModel/TypeConverter.xml b/xml/System.ComponentModel/TypeConverter.xml index faa3008085b..fb5554a0c74 100644 --- a/xml/System.ComponentModel/TypeConverter.xml +++ b/xml/System.ComponentModel/TypeConverter.xml @@ -101,10 +101,7 @@ - To convert types that support standard values, override the , , and methods. - - Your derived type might be marked as or , but an instance of your type can be created with the 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. - - +Note: Your derived type might be marked as or , but an instance of your type can be created with the 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)). diff --git a/xml/System.Composition.Hosting.Core/LifetimeContext.xml b/xml/System.Composition.Hosting.Core/LifetimeContext.xml index 4331b079db7..cf260470b89 100644 --- a/xml/System.Composition.Hosting.Core/LifetimeContext.xml +++ b/xml/System.Composition.Hosting.Core/LifetimeContext.xml @@ -32,7 +32,7 @@ The 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 , and should never be written to after disposal. A bound part instance is set to under a lock in the 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 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. ]]> diff --git a/xml/System.Composition/CompositionContext.xml b/xml/System.Composition/CompositionContext.xml index 3678be7a822..c0a80485afc 100644 --- a/xml/System.Composition/CompositionContext.xml +++ b/xml/System.Composition/CompositionContext.xml @@ -48,7 +48,7 @@ ## Remarks -Note that this constructor is protected; it can only be called by classes derived from the class. +This constructor is protected; it can only be called by classes derived from the `System.Composition.CompositionContext` class. ]]> diff --git a/xml/System.Configuration/Configuration.xml b/xml/System.Configuration/Configuration.xml index a4256b43756..f74fda6ca6f 100644 --- a/xml/System.Configuration/Configuration.xml +++ b/xml/System.Configuration/Configuration.xml @@ -74,10 +74,7 @@ These methods provide access to the cached configuration values for the current application, which has better performance than the class. - - If you use a static 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. - - +Note: If you use a static 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 methods to write configuration information. Note that the user or process that writes must have the following permissions: diff --git a/xml/System.Configuration/ConfigurationSection.xml b/xml/System.Configuration/ConfigurationSection.xml index e3de5db8035..d932fbb50dc 100644 --- a/xml/System.Configuration/ConfigurationSection.xml +++ b/xml/System.Configuration/ConfigurationSection.xml @@ -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 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 class. ## Examples The following example shows how to implement a custom section programmatically. @@ -80,10 +78,7 @@ These methods provide access to the cached configuration values for the current application, which has better performance than the class. - - If you use a static method that takes a parameter, the 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. - - +Note: If you use a static method that takes a parameter, the 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 methods to write configuration information. Note that the user or process that writes must have the following permissions: diff --git a/xml/System.Configuration/ConfigurationSettings.xml b/xml/System.Configuration/ConfigurationSettings.xml index 9f7f93883be..674e5725cc7 100644 --- a/xml/System.Configuration/ConfigurationSettings.xml +++ b/xml/System.Configuration/ConfigurationSettings.xml @@ -141,12 +141,7 @@ A configuration name and path, such as "system.net/settings". Returns the object for the passed configuration section name and path. - The object for the passed configuration section name and path. - - - The class provides backward compatibility only. Use the class or class instead. - - + The object for the passed configuration section name and path. object contains the metadata about an individual section within the configuration hierarchy. This object can be used in order to validate and change the properties of an individual section. - - + The object contains the metadata about an individual section within the configuration hierarchy. This object can be used in order to validate and change the properties of an individual section. ## Examples The following example shows how to get the metadata that is associated with a object. @@ -501,10 +499,8 @@ if the associated object will be saved even if it has not been modified; otherwise, . The default is . - - If the configuration file is saved (even if there are no modifications), ASP.NET restarts the application. - - +Note: If the configuration file is saved (even if there are no modifications), ASP.NET restarts the application1.exe.config. + Date: Fri, 6 Aug 2021 13:14:44 -0700 Subject: [PATCH 2/2] add xref: --- xml/System.Composition/CompositionContext.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/xml/System.Composition/CompositionContext.xml b/xml/System.Composition/CompositionContext.xml index c0a80485afc..873c10ee0c6 100644 --- a/xml/System.Composition/CompositionContext.xml +++ b/xml/System.Composition/CompositionContext.xml @@ -48,7 +48,8 @@ ## Remarks -This constructor is protected; it can only be called by classes derived from the `System.Composition.CompositionContext` class. +This constructor is protected; it can only be called by classes derived from the class. + ]]>