Skip to content

Commit

Permalink
Add table headers for accessibility (#10778)
Browse files Browse the repository at this point in the history
  • Loading branch information
gewarren authored Dec 20, 2024
1 parent d09267e commit 4530175
Show file tree
Hide file tree
Showing 31 changed files with 6,179 additions and 6,000 deletions.
138 changes: 69 additions & 69 deletions xml/System.AddIn.Hosting/AddInProcess.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@
<Docs>
<summary>Provides an external process for running add-ins out-of-process from the host application.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To activate an add-in in an external process, pass an <xref:System.AddIn.Hosting.AddInProcess> object to the appropriate <xref:System.AddIn.Hosting.AddInToken.Activate%60%601%28System.AddIn.Hosting.AddInProcess%2CSystem.Security.PermissionSet%29?displayProperty=nameWithType> method overload.
The executable that runs the add-in is obtained from one of two files installed with the .NET Framework under the Windows directory. By default, the executable that matches the bits-per-word of the host application is used. If the host is a 64-bit process, AddInProcess.exe is run; otherwise, AddInProcess32.exe is run. To specify the way the executable is selected, use the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor to create the <xref:System.AddIn.Hosting.AddInProcess> object.
## Examples
The following example activates an add-in in an external process.
<format type="text/markdown"><![CDATA[
## Remarks
To activate an add-in in an external process, pass an <xref:System.AddIn.Hosting.AddInProcess> object to the appropriate <xref:System.AddIn.Hosting.AddInToken.Activate%60%601%28System.AddIn.Hosting.AddInProcess%2CSystem.Security.PermissionSet%29?displayProperty=nameWithType> method overload.
The executable that runs the add-in is obtained from one of two files installed with the .NET Framework under the Windows directory. By default, the executable that matches the bits-per-word of the host application is used. If the host is a 64-bit process, AddInProcess.exe is run; otherwise, AddInProcess32.exe is run. To specify the way the executable is selected, use the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor to create the <xref:System.AddIn.Hosting.AddInProcess> object.
## Examples
The following example activates an add-in in an external process.
:::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet10":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10":::
]]></format>
</remarks>
<related type="Article" href="/previous-versions/dotnet/netframework-4.0/bb384200(v=vs.100)">Add-Ins and Extensibility</related>
Expand Down Expand Up @@ -72,11 +72,11 @@
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor has the same effect as using the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor with the <xref:System.AddIn.Hosting.Platform.Host?displayProperty=nameWithType> flag, to specify that the process that runs the add-in will have the same bits-per-word as the host process.
<format type="text/markdown"><![CDATA[
## Remarks
This constructor has the same effect as using the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor with the <xref:System.AddIn.Hosting.Platform.Host?displayProperty=nameWithType> flag, to specify that the process that runs the add-in will have the same bits-per-word as the host process.
]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -106,24 +106,24 @@
<param name="platform">A value that specifies the bits-per-word of the process that runs the add-in.</param>
<summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class, specifying the bits-per-word of the process in which the add-in runs.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows how `platform` affects the bits-per-word of the process on different operating systems:
||32-bit operating system|64-bit operating system|
|-|------------------------------|------------------------------|
|Host|32-bit|Same as the host process|
|AnyCPU|32-bit|64-bit|
|X86|32-bit|32-bit|
|X64|Exception is thrown|64-bit|
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows how `platform` affects the bits-per-word of the process on different operating systems:
| `platform` | 32-bit operating system | 64-bit operating system |
|------------|-------------------------|--------------------------|
| Host | 32-bit | Same as the host process |
| AnyCPU | 32-bit | 64-bit |
| X86 | 32-bit | 32-bit |
| X64 | Exception is thrown | 64-bit |
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The registry entry for the path to the executable (AddInProcess.exe or AddInProcess32.exe) is missing.
-or-
<exception cref="T:System.InvalidOperationException">The registry entry for the path to the executable (AddInProcess.exe or AddInProcess32.exe) is missing.

-or-

The executable is missing.</exception>
</Docs>
</Member>
Expand All @@ -148,22 +148,22 @@
<value>
<see langword="true" /> if the <see cref="T:System.AddIn.Hosting.AddInProcess" /> object corresponds to the current process; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the value of this property is `true`, the add-in is running in-process with the host application. In that case, using the <xref:System.AddIn.Hosting.AddInProcess.Start%2A> or <xref:System.AddIn.Hosting.AddInProcess.Shutdown%2A> method throws an <xref:System.InvalidOperationException>.
<format type="text/markdown"><![CDATA[
## Remarks
If the value of this property is `true`, the add-in is running in-process with the host application. In that case, using the <xref:System.AddIn.Hosting.AddInProcess.Start%2A> or <xref:System.AddIn.Hosting.AddInProcess.Shutdown%2A> method throws an <xref:System.InvalidOperationException>.
> [!NOTE]
> The <xref:System.AddIn.Hosting.AddInEnvironment.Process%2A?displayProperty=nameWithType> property returns an <xref:System.AddIn.Hosting.AddInProcess> object that represents the host application process if the add-in is running in-process.
## Examples
The following example activates an add-in in an external process and uses the <xref:System.AddIn.Hosting.AddInProcess.IsCurrentProcess%2A> property to determine whether the add-in is in the same process as the host application process.
> The <xref:System.AddIn.Hosting.AddInEnvironment.Process%2A?displayProperty=nameWithType> property returns an <xref:System.AddIn.Hosting.AddInProcess> object that represents the host application process if the add-in is running in-process.
## Examples
The following example activates an add-in in an external process and uses the <xref:System.AddIn.Hosting.AddInProcess.IsCurrentProcess%2A> property to determine whether the add-in is in the same process as the host application process.
:::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet10":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10":::
]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -199,11 +199,11 @@
<value>
<see langword="true" /> if the external process should be kept alive; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Set this property to `false` to aggressively shut down the external process after the last add-in inside the process has been shut down.
<format type="text/markdown"><![CDATA[
## Remarks
Set this property to `false` to aggressively shut down the external process after the last add-in inside the process has been shut down.
]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -233,11 +233,11 @@
<summary>Gets the bits-per-word of the process in which the out-of-process add-in is run.</summary>
<value>The bits-per-word of the process that runs the add-in.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The bits-per-word is set when the <xref:System.AddIn.Hosting.AddInProcess> object is initialized, and cannot be changed.
<format type="text/markdown"><![CDATA[
## Remarks
The bits-per-word is set when the <xref:System.AddIn.Hosting.AddInProcess> object is initialized, and cannot be changed.
]]></format>
</remarks>
</Docs>
Expand All @@ -262,11 +262,11 @@
<summary>Gets the process ID of the external process.</summary>
<value>The process ID, or -1 if the external process has not started.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this property for debugging.
<format type="text/markdown"><![CDATA[
## Remarks
Use this property for debugging.
]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -374,11 +374,11 @@
<summary>Gets or sets the number of seconds to allow for the process to start.</summary>
<value>The number of seconds to allow for process startup.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value is 10 seconds. This property is usually used during debugging, to increase the startup time for the process that runs the out-of-process add-in.
<format type="text/markdown"><![CDATA[
## Remarks
The default value is 10 seconds. This property is usually used during debugging, to increase the startup time for the process that runs the out-of-process add-in.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The process is already running.</exception>
Expand Down
25 changes: 12 additions & 13 deletions xml/System.AddIn.Hosting/Platform.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,18 @@
<Docs>
<summary>Specifies the bits-per-word of the process in which an out-of-process add-in is run.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows how the enumeration value affects the bits-per-word of the process on different operating systems:
||32-bit operating system|64-bit operating system|
|-|------------------------------|------------------------------|
|Host|32-bit|Same as host process|
|AnyCPU|32-bit|64-bit|
|X86|32-bit|32-bit|
|X64|Exception is thrown|64-bit|
||32-bit|N/A|
<format type="text/markdown"><![CDATA[
The following table shows how the enumeration value affects the bits-per-word of the process on different operating systems:
| Platform | 32-bit operating system | 64-bit operating system |
|----------|-------------------------|-------------------------|
| Host | 32-bit | Same as host process |
| AnyCPU | 32-bit | 64-bit |
| X86 | 32-bit | 32-bit |
| X64 | Exception is thrown | 64-bit |
| | 32-bit | N/A |
]]></format>
</remarks>
</Docs>
Expand Down
10 changes: 5 additions & 5 deletions xml/System.Buffers.Text/Utf8Formatter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -765,11 +765,11 @@ If the method fails, iteratively increase the size of the buffer and retry until
Formats supported:
|Format string|Result string|Comments|
|--|--|--|
|c/t/T (default)|[-][d.]hh:mm:ss[.fffffff]|(constant format)|
|G|[-]d:hh:mm:ss.fffffff||(general long)|
|g|[-][d:][h]h:mm:ss[.f[f[f[f[f[f[f]]]]]]|(general short)|
| Format string | Result string | Comments |
|-----------------|----------------------------------------|-------------------|
| c/t/T (default) | [-][d.]hh:mm:ss[.fffffff] | (constant format) |
| G | [-]d:hh:mm:ss.fffffff | (general long) |
| g | [-][d:][h]h:mm:ss[.f[f[f[f[f[f[f]]]]]] | (general short) |
If the method fails, iteratively increase the size of the buffer and retry until it succeeds.
Expand Down
40 changes: 20 additions & 20 deletions xml/System.Buffers.Text/Utf8Parser.xml
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,13 @@ The parsing is case insensitive. The format parameter is validated to ensure it
<remarks>
<format type="text/markdown"><![CDATA[
Formats supported:
Formats supported:
|Format string|Example expected format|
|--|--|
|G/g (default)| |
|D/d|122|
|N/n|122|
|N/n|122|
|X/x|7a|
]]></format>
Expand Down Expand Up @@ -302,7 +302,7 @@ Formats supported:
|Format string|Example expected format|Comments|
|--|--|--|
|G/g (default)| |
|G/g (default)| |
|F/f|12.45|Fixed point|
|E/e|1.245000e1|Exponential|
Expand Down Expand Up @@ -357,7 +357,7 @@ Formats supported:
|Format string|Example expected format|Comments|
|--|--|--|
|G/g (default)| |
|G/g (default)| |
|F/f|12.45|Fixed point|
|E/e|1.245000e1|Exponential|
Expand Down Expand Up @@ -470,7 +470,7 @@ Formats supported:
|--|--|
|G/g (default)| |
|D/d|32767|
|N/n|32,767|
|N/n|32,767|
|X/x|7fff|
]]></format>
Expand Down Expand Up @@ -526,7 +526,7 @@ Formats supported:
|--|--|
|G/g (default)| |
|D/d|32767|
|N/n|32,767|
|N/n|32,767|
|X/x|7fff|
]]></format>
Expand Down Expand Up @@ -582,7 +582,7 @@ Formats supported:
|--|--|
|G/g (default)| |
|D/d|32767|
|N/n|32,767|
|N/n|32,767|
|X/x|7fff|
]]></format>
Expand Down Expand Up @@ -638,13 +638,13 @@ Formats supported:
<remarks>
<format type="text/markdown"><![CDATA[
Formats supported:
Formats supported:
|Format string|Example expected format|
|--|--|
|G/g (default)| |
|D/d|122|
|N/n|122|
|N/n|122|
|X/x|7a|
]]></format>
Expand Down Expand Up @@ -694,11 +694,11 @@ Formats supported:
<remarks>
<format type="text/markdown"><![CDATA[
Formats supported:
Formats supported:
Format string|Example expected fornmat|Comments|
|--|--|--|
|G/g (default)| |
|G/g (default)| |
|F/f|12.45|Fixed point|
|E/e|1.245000e1|Exponential|
Expand Down Expand Up @@ -749,13 +749,13 @@ Format string|Example expected fornmat|Comments|
<remarks>
<format type="text/markdown"><![CDATA[
Formats supported:
Formats supported:
|Format string|Expected format|Comments|
|--|--|--|
|c/t/T (default)|[-][d.]hh:mm:ss[.fffffff]|(constant format)|
|G|[-]d:hh:mm:ss.fffffff||(general long)|
|g|[-][d:][h]h:mm:ss[.f[f[f[f[f[f[f]]]]]]|(general short)|
| Format string | Expected format | Comments |
|-----------------|----------------------------------------|-------------------|
| c/t/T (default) | [-][d.]hh:mm:ss[.fffffff] | (constant format) |
| G | [-]d:hh:mm:ss.fffffff | (general long) |
| g | [-][d:][h]h:mm:ss[.f[f[f[f[f[f[f]]]]]] | (general short) |
]]></format>
</remarks>
Expand Down Expand Up @@ -816,7 +816,7 @@ Formats supported:
|--|--|
|G/g (default)| |
|D/d|32767|
|N/n|32,767|
|N/n|32,767|
|X/x|7fff|
]]></format>
Expand Down Expand Up @@ -878,7 +878,7 @@ Formats supported:
|--|--|
|G/g (default)| |
|D/d|32767|
|N/n|32,767|
|N/n|32,767|
|X/x|7fff|
]]></format>
Expand Down Expand Up @@ -940,7 +940,7 @@ Formats supported:
|--|--|
|G/g (default)| |
|D/d|32767|
|N/n|32,767|
|N/n|32,767|
|X/x|7fff|
]]></format>
Expand Down
Loading

0 comments on commit 4530175

Please sign in to comment.