Skip to content
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

Jump to bottom

Port System.Text documentation #9198

Merged
merged 5 commits into from
Aug 22, 2023
Merged

Port System.Text documentation #9198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f8ffc2d
Port System.Text documentation
carlossanlop Aug 17, 2023
1ed7917
Range - range
carlossanlop Aug 17, 2023
5c8061a
Update StringBuilder.xml
gewarren Aug 21, 2023
fa742e2
Apply suggestions from code review
carlossanlop Aug 22, 2023
4f0abda
Update xml/System.Text/Ascii.xml
carlossanlop Aug 22, 2023
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
3,732 changes: 1,867 additions & 1,865 deletions xml/System.Text/ASCIIEncoding.xml
View file
Open in desktop

Large diffs are not rendered by default.

1,807 changes: 921 additions & 886 deletions xml/System.Text/Ascii.xml
View file
Open in desktop

Large diffs are not rendered by default.

216 changes: 110 additions & 106 deletions xml/System.Text/CompositeFormat.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,106 +1,110 @@
<Type Name="CompositeFormat" FullName="System.Text.CompositeFormat">
<TypeSignature Language="C#" Value="public sealed class CompositeFormat" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CompositeFormat extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Text.CompositeFormat" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CompositeFormat" />
<TypeSignature Language="F#" Value="type CompositeFormat = class" />
<TypeSignature Language="C++ CLI" Value="public ref class CompositeFormat sealed" />
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(1)&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Format">
<MemberSignature Language="C#" Value="public string Format { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Format" />
<MemberSignature Language="DocId" Value="P:System.Text.CompositeFormat.Format" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Format As String" />
<MemberSignature Language="F#" Value="member this.Format : string" Usage="System.Text.CompositeFormat.Format" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Format { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinimumArgumentCount">
<MemberSignature Language="C#" Value="public int MinimumArgumentCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinimumArgumentCount" />
<MemberSignature Language="DocId" Value="P:System.Text.CompositeFormat.MinimumArgumentCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MinimumArgumentCount As Integer" />
<MemberSignature Language="F#" Value="member this.MinimumArgumentCount : int" Usage="System.Text.CompositeFormat.MinimumArgumentCount" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property int MinimumArgumentCount { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static System.Text.CompositeFormat Parse (string format);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Text.CompositeFormat Parse(string format) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.CompositeFormat.Parse(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Parse (format As String) As CompositeFormat" />
<MemberSignature Language="F#" Value="static member Parse : string -&gt; System.Text.CompositeFormat" Usage="System.Text.CompositeFormat.Parse format" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Text::CompositeFormat ^ Parse(System::String ^ format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.CompositeFormat</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.StringSyntax("CompositeFormat")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Diagnostics.CodeAnalysis.StringSyntax("CompositeFormat")&gt;]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
<Type Name="CompositeFormat" FullName="System.Text.CompositeFormat">
<TypeSignature Language="C#" Value="public sealed class CompositeFormat" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CompositeFormat extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Text.CompositeFormat" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CompositeFormat" />
<TypeSignature Language="F#" Value="type CompositeFormat = class" />
<TypeSignature Language="C++ CLI" Value="public ref class CompositeFormat sealed" />
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(1)&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a parsed composite format string.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Format">
<MemberSignature Language="C#" Value="public string Format { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Format" />
<MemberSignature Language="DocId" Value="P:System.Text.CompositeFormat.Format" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Format As String" />
<MemberSignature Language="F#" Value="member this.Format : string" Usage="System.Text.CompositeFormat.Format" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Format { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the original composite format string used to create this <see cref="T:System.Text.CompositeFormat" /> instance.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinimumArgumentCount">
<MemberSignature Language="C#" Value="public int MinimumArgumentCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinimumArgumentCount" />
<MemberSignature Language="DocId" Value="P:System.Text.CompositeFormat.MinimumArgumentCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MinimumArgumentCount As Integer" />
<MemberSignature Language="F#" Value="member this.MinimumArgumentCount : int" Usage="System.Text.CompositeFormat.MinimumArgumentCount" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property int MinimumArgumentCount { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the minimum number of arguments that must be passed to a formatting operation using this <see cref="T:System.Text.CompositeFormat" />.</summary>
<value>To be added.</value>
<remarks>It's permissible to supply more arguments than this value, but it's an error to pass fewer.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static System.Text.CompositeFormat Parse (string format);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Text.CompositeFormat Parse(string format) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.CompositeFormat.Parse(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Parse (format As String) As CompositeFormat" />
<MemberSignature Language="F#" Value="static member Parse : string -&gt; System.Text.CompositeFormat" Usage="System.Text.CompositeFormat.Parse format" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Text::CompositeFormat ^ Parse(System::String ^ format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.CompositeFormat</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.StringSyntax("CompositeFormat")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Diagnostics.CodeAnalysis.StringSyntax("CompositeFormat")&gt;]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="format">The string to parse.</param>
<summary>Parses the specified composite format string.</summary>

<returns>The parsed <see cref="T:System.Text.CompositeFormat" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="format" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">A format item in <paramref name="format" /> is invalid.</exception>
</Docs>
</Member>
</Members>
</Type>
Loading
Loading