Skip to content

Commit acb2148

Browse files
authored
HTML tag cleanup (dotnet#6991)
1 parent 9f3f21a commit acb2148

File tree

14 files changed

+28
-64
lines changed

14 files changed

+28
-64
lines changed

xml/Microsoft.CSharp/Compiler.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ Each string in the sourceTexts parameter is the equivalent of a single source fi
7171
7272
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.
7373
74-
The imports parameter is the same as the /reference compiler option. This parameter can be <see langword="null" />.
74+
The imports parameter is the same as the /reference compiler option. This parameter `null`.
7575
76-
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:
76+
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:
7777
7878
| Key Name | Usage |
7979
| --- | --- |

xml/Microsoft.Extensions.DependencyInjection/HttpClientFactoryServiceCollectionExtensions.xml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -752,7 +752,7 @@
752752
753753
<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.
754754
755-
<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.
755+
`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.
756756
757757
]]></format>
758758
</remarks>
@@ -805,7 +805,7 @@
805805
806806
<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.
807807
808-
<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.
808+
`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.
809809
810810
]]></format>
811811
</remarks>
@@ -1062,7 +1062,7 @@
10621062
10631063
<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.
10641064
1065-
<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.
1065+
`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.
10661066
10671067
]]></format>
10681068
</remarks>
@@ -1117,10 +1117,7 @@
11171117
11181118
<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.
11191119
1120-
<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.
1121-
1122-
<typeparamref name="TImplementation"></typeparamref>
1123-
1120+
`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.
11241121
]]></format>
11251122
</remarks>
11261123
</Docs>

xml/Microsoft.VisualBasic.Compatibility.VB6/BaseControlArray.xml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -563,15 +563,12 @@
563563
<Parameters />
564564
<Docs>
565565
<summary>Returns the type of a control in a control array.</summary>
566-
<returns>This method must be overridden.
566+
<returns>The type of a control in a control array.</returns>
567+
<remarks>This method must be overridden.
567568

568-
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.
569-
570-
<block subset="none" type="note"><para>
571-
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.
572-
573-
</para></block></returns>
574-
<remarks>To be added.</remarks>
569+
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.
570+
571+
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>
575572
<block subset="none" type="overrides">
576573
<para>When you override <see langword="GetControlInstanceType" /> in a derived class, do not call the <see langword="GetControlInstanceType" /> method of the base class.</para>
577574
</block>

xml/System.Buffers/ReadOnlySequence`1.xml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,7 @@
6666
<Docs>
6767
<param name="memory">A read-only block of memory of elements of type <typeparamref name="T" />.</param>
6868
<summary>Creates an instance of <see cref="T:System.Buffers.ReadOnlySequence`1" /> from a <see cref="T:System.ReadOnlyMemory`1" />. </summary>
69-
<remarks>
70-
<format type="text/markdown"><![CDATA[
71-
The consumer is expected to manage the lifetime of memory until <see cref="T:System.Buffers.ReadOnlySequence`1" /> is not used anymore.
72-
73-
]]></format>
74-
</remarks>
69+
<remarks>The consumer is expected to manage the lifetime of memory until <see cref="T:System.Buffers.ReadOnlySequence`1" /> is not used anymore.</remarks>
7570
</Docs>
7671
</Member>
7772
<Member MemberName=".ctor">

xml/System.ComponentModel.Design/ObjectSelectorEditor.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,9 @@
145145
</Parameters>
146146
<Docs>
147147
<param name="treeView">The tree view control to modify.</param>
148-
<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>
148+
<summary>Modify a Windows Forms <see cref="T:System.Windows.Forms.TreeView" /> control to use the new Explorer style theme.</summary>
149149
<remarks>To be added.</remarks>
150+
<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>
150151
</Docs>
151152
</Member>
152153
<Member MemberName="currValue">

xml/System.ComponentModel/AsyncOperation.xml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -202,9 +202,7 @@
202202
203203
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.
204204
205-
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.
206-
207-
205+
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.
208206
209207
## Examples
210208
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.
@@ -221,10 +219,7 @@
221219
<block subset="none" type="overrides">
222220
<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.
223221

224-
<block subset="none" type="note"><para>
225-
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.
226-
227-
</para></block>
222+
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.
228223

229224
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>
230225
</block>

xml/System.ComponentModel/PropertyDescriptor.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1661,9 +1661,7 @@
16611661
<block subset="none" type="overrides">
16621662
<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" />.
16631663

1664-
<block subset="none" type="note"><para>
1665-
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" />.
1666-
</para></block></para>
1664+
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>
16671665
</block>
16681666
<altmember cref="T:System.ComponentModel.Design.ComponentDesigner" />
16691667
</Docs>

xml/System.ComponentModel/TypeConverter.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,7 @@
101101

102102
- 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.
103103

104-
<block subset="none" type="note"><para>
105-
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.
106-
107-
</para></block>
104+
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.
108105

109106
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>
110107
</block>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The <xref:System.Composition.Hosting.Core.LifetimeContext> object is the unit of
3232
3333
This object contains two pieces of independently protected shared state: shared part instances and bound part instances.
3434
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.
35-
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.
35+
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.
3636
3737
]]></format>
3838
</remarks>

xml/System.Composition/CompositionContext.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@
4848
4949
## Remarks
5050
51-
Note that this constructor is protected; it can only be called by classes derived from the <see cref="T:System.Composition.CompositionContext"/> class.
51+
This constructor is protected; it can only be called by classes derived from the <xref:System.Composition.CompositionContext> class.
52+
5253
]]></format>
5354
</remarks>
5455
</Docs>

0 commit comments

Comments
 (0)