Skip to content

Code example cleanup #11234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2025
Merged

Code example cleanup #11234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5b0049
code example cleanup
gewarren Apr 24, 2025
109c07f
encode angle brackets
gewarren Apr 24, 2025
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
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Configuration.Ini/IniConfigurationProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

INI files are simple line structures ([INI Files on Wikipedia](https://en.wikipedia.org/wiki/INI_file)). The following example demonstrates a structure of the INI file:

```
```ini
[Section:Header]
key1=value1
key2 = " value2 "
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Http/PolicyHttpMessageHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ The <xref:Microsoft.Extensions.DependencyInjection.PollyHttpClientBuilderExtensi
<xref:Microsoft.Extensions.Http.PolicyHttpMessageHandler> and the <xref:Microsoft.Extensions.DependencyInjection.PollyHttpClientBuilderExtensions> convenience methods only accept the generic <xref:Polly.IAsyncPolicy`1>. Generic policy instances can be created by using the generic methods on <xref:Polly.Policy> such as <xref:Polly.Policy.TimeoutAsync``1(System.Int32)>.

To adapt an existing non-generic <xref:Polly.IAsyncPolicy>, use code like the following:
```

```csharp
policy.AsAsyncPolicy&lt;HttpResponseMessage&gt;()
```

Expand Down
5 changes: 3 additions & 2 deletions xml/System.Runtime.CompilerServices/InlineArrayAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
This attribute can be used to annotate a `struct` type with a single field. The runtime replicates that field in the actual type layout as many times as is specified.

> [!IMPORTANT]
> .NET 9 and later, the default implementations of `Equals()` and `GetHashCode()` for types marked with this attribute throw <xref:System.NotSupportedException>. You must override both <xref:System.ValueType.Equals(System.Object)> and <xref:System.ValueType.GetHashCode%2A> if they will be used.
> In .NET 9 and later versions, the default implementations of `Equals()` and `GetHashCode()` for types marked with this attribute throw <xref:System.NotSupportedException>. You must override both <xref:System.ValueType.Equals(System.Object)> and <xref:System.ValueType.GetHashCode%2A> if they will be used.

]]></format>
</remarks>
Expand All @@ -46,7 +46,8 @@ This attribute can be used to annotate a `struct` type with a single field. The
{
private float _value;
}
</code></example>
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
14 changes: 8 additions & 6 deletions xml/System.Runtime.InteropServices.Swift/SwiftError.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@
</Attributes>
<Docs>
<summary>Represents the Swift error context, indicating that the argument is the error context.</summary>
<remarks>
<para> This struct is used to retrieve the 'error' context from Swift functions in the context of interop with .NET.
</para>
<para> Here's an example of how a SwiftError can be declared:
<code lang="csharp"> [UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])] [DllImport("SwiftLibrary", EntryPoint = "export")] public static extern void swiftFunction(SwiftError* error); </code></para>
</remarks>
<remarks>This struct is used to retrieve the 'error' context from Swift functions in the context of interop with .NET.</remarks>
<example>Here's an example of how a SwiftError can be declared:
<code lang="csharp">
[UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])]
[DllImport("SwiftLibrary", EntryPoint = "export")]
public static extern void swiftFunction(SwiftError* error);
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Runtime.InteropServices.Swift/SwiftIndirectResult.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
</Attributes>
<Docs>
<summary>Represents the Swift return buffer context.</summary>
<remarks>This struct is used to access the return buffer when interoping with Swift functions that return non-frozen structs.
It provides a pointer to the memory location where the result should be stored.</remarks>
<remarks>This struct is used to access the return buffer when interoping with Swift functions that return non-frozen structs. It provides a pointer to the memory location where the result should be stored.</remarks>
<example>Here's an example of how a SwiftIndirectResult can be declared:
<code lang="csharp">
<code lang="csharp">
[UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])]
[LibraryImport("SwiftLibrary", EntryPoint = "export")]
public static extern void swiftFunction(SwiftIndirectResult result);
</code></example>
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
14 changes: 8 additions & 6 deletions xml/System.Runtime.InteropServices.Swift/SwiftSelf.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@
</Attributes>
<Docs>
<summary>Represents the Swift 'self' context, indicating that the argument is the self context.</summary>
<remarks>
<para> This struct is used to pass the 'self' context to Swift functions in the context of interop with .NET.
</para>
<para> Here's an example of how a SwiftSelf context can be declared:
<code lang="csharp"> [UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])] [DllImport("SwiftLibrary", EntryPoint = "export")] public static extern void swiftFunction(SwiftSelf self); </code></para>
</remarks>
<remarks>This struct is used to pass the 'self' context to Swift functions in the context of interop with .NET.</remarks>
<example>Here's an example of how a SwiftSelf context can be declared:
<code lang="csharp">
[UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])]
[DllImport("SwiftLibrary", EntryPoint = "export")]
public static extern void swiftFunction(SwiftSelf self);
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
14 changes: 8 additions & 6 deletions xml/System.Runtime.InteropServices.Swift/SwiftSelf`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@
<Docs>
<typeparam name="T">The type of the frozen struct to pass in the 'self' context.</typeparam>
<summary>Represents the Swift 'self' context when the argument is Swift frozen struct T, which is either enregistered into multiple registers, or passed by reference in the 'self' register.</summary>
<remarks>
<para> This struct is used to pass the Swift frozen struct T to Swift functions in the context of interop with .NET.
</para>
<para> Here's an example of how a SwiftSelf&lt;T&gt; context can be declared:
<code lang="csharp"> [UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])] [LibraryImport("SwiftLibrary", EntryPoint = "export")] public static extern void swiftFunction(SwiftSelf&lt;T&gt; self); </code></para>
</remarks>
<remarks>This struct is used to pass the Swift frozen struct T to Swift functions in the context of interop with .NET.</remarks>
<example>Here's an example of how a SwiftSelf&lt;T&gt; context can be declared:
<code lang="csharp">
[UnmanagedCallConv(CallConvs = [typeof(CallConvSwift)])]
[LibraryImport("SwiftLibrary", EntryPoint = "export")]
public static extern void swiftFunction(SwiftSelf&lt;T&gt; self);
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down