Skip to content

Port IntPtr and MemoryExtensions triple slash to docs #7131

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 3 commits into from
Sep 9, 2021
Merged

Port IntPtr and MemoryExtensions triple slash to docs #7131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25eb449
Port IntPtr and MemoryExtensions triple slash to docs
carlossanlop Sep 9, 2021
c70e170
Apply suggestions from code review
carlossanlop Sep 9, 2021
c8f5fd4
Apply suggestions from code review
carlossanlop Sep 9, 2021
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
13 changes: 7 additions & 6 deletions xml/System/IntPtr.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2193,12 +2193,13 @@ This member is an explicit interface member implementation. It can be used only
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">The span where this instance's value formatted as a span of characters should be written.</param>
<param name="charsWritten">When this method returns, contains the number of characters that were written in <paramref name="destination" />.</param>
<param name="format">The characters that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current instance into the provided span of characters.</summary>
<returns>
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
73 changes: 37 additions & 36 deletions xml/System/MemoryExtensions+TryWriteInterpolatedStringHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides a handler used by the language compiler to format interpolated strings into character spans.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -135,9 +135,9 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The value to write.</param>
<summary>Writes the specified value to the handler.</summary>
<returns><see langword="true"/> on success; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -161,11 +161,11 @@
<Parameter Name="format" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="alignment">To be added.</param>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The value to write.</param>
<param name="alignment">The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
<param name="format">The format string.</param>
<summary>Writes the specified value to the handler.</summary>
<returns><see langword="true"/> on success; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -217,11 +217,11 @@
<Parameter Name="format" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="alignment">To be added.</param>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The value to write.</param>
<param name="alignment">The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
<param name="format">The format string.</param>
<summary>Writes a specified value to the handler using a specified format string.</summary>
<returns><see langword="true"/> on success; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -247,10 +247,10 @@
<Parameter Name="value" Type="T" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the value to write.</typeparam>
<param name="value">The value to write.</param>
<summary>Writes the specified value to the handler.</summary>
<returns><see langword="true"/> on success; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -277,10 +277,10 @@
<Parameter Name="alignment" Type="System.Int32" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<param name="alignment">To be added.</param>
<summary>To be added.</summary>
<typeparam name="T">The type of the value to write.</typeparam>
<param name="value">The value to write.</param>
<param name="alignment">The minimum number of characters that should be written for this value.A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
<summary>Writes the specified value to the handler.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -308,11 +308,11 @@
<Parameter Name="format" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the value to write.</typeparam>
<param name="value">The value to write.</param>
<param name="format">The format string.</param>
<summary>Writes a specified value to the handler using a specified format string.</summary>
<returns><see langword="true"/> on success; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -340,12 +340,12 @@
<Parameter Name="format" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<param name="alignment">To be added.</param>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the value to write.</typeparam>
<param name="value">The value to write.</param>
<param name="alignment">The minimum number of characters that should be written for this value. A negative value indicates left-aligned, and the required minimum is the absolute value.</param>
<param name="format">The format string.</param>
<summary>Writes a specified value to the handler using a specified format string.</summary>
<returns><see langword="true"/> on success; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -368,9 +368,10 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The string to write.</param>
<summary>Writes the specified string to the handler.</summary>
<returns>
<see langword="true" /> if the value could be formatted to the span; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down