Skip to content

Commit ee9bd45

Browse files
author
Ron Petrusha
committed
Documented StandardFormat structure
1 parent c3e74ef commit ee9bd45

File tree

1 file changed

+97
-47
lines changed

1 file changed

+97
-47
lines changed

‎xml/System.Buffers/StandardFormat.xml

Lines changed: 97 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,14 @@
2929
</Attribute>
3030
</Attributes>
3131
<Docs>
32-
<summary>To be added.</summary>
33-
<remarks>To be added.</remarks>
32+
<summary>Represents a standard format string without using an actual string.</summary>
33+
<remarks>
34+
<format type="text/markdown"><![CDATA[
35+
36+
A `StandardFormat` object consists of a single character standard format specifier (such as 'G', 'D', or 'X') and an optional precision specifier. The precision specifier can range from 0 to 9, or it can be the special <xref:System.Buffers.StandardFormat.NoPrecision?displayProperty=nameWithType> value.
37+
38+
]]></format>
39+
</remarks>
3440
</Docs>
3541
<Members>
3642
<Member MemberName=".ctor">
@@ -55,10 +61,17 @@
5561
<Parameter Name="precision" Type="System.Byte" />
5662
</Parameters>
5763
<Docs>
58-
<param name="symbol">To be added.</param>
59-
<param name="precision">To be added.</param>
60-
<summary>To be added.</summary>
64+
<param name="symbol">A type-specific format specifier, such as 'G', 'D', or 'X'.</param>
65+
<param name="precision">An optional precision ranging from 0 to 99, or the special value <see cref="F:System.Buffers.StandardFormat.NoPrecision" /> (the default).</param>
66+
<summary>Initializes a new instance of the <see cref="T:System.Buffers.StandardFormat" /> structure.</summary>
6167
<remarks>To be added.</remarks>
68+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="symbol" /> is not <see cref="F:System.Buffers.StandardFormat.NoPrecision" />, and its value is greater than <see cref="F:System.Buffers.StandardFormat.MaxPrecision" />.
69+
70+
-or-
71+
72+
<paramref name="symbol" /> cannot be converted to a <xref:System.Byte>.
73+
74+
</exception>
6275
</Docs>
6376
</Member>
6477
<Member MemberName="Equals">
@@ -90,9 +103,15 @@
90103
</Parameters>
91104
<Docs>
92105
<param name="other">To be added.</param>
93-
<summary>To be added.</summary>
94-
<returns>To be added.</returns>
95-
<remarks>To be added.</remarks>
106+
<summary>Indicates whether the current instances is equal to another <see cref="T:System.Buffers.StandardFormat" /> instance.</summary>
107+
<returns><see langword="true" /> if the two instances are equal; otherwise, <see langword="false" />.</returns>
108+
<remarks>
109+
<format type="text/markdown"><![CDATA[
110+
111+
Two <xref:System.Buffers.StandardFormat> instances are equal if their <xref:System.Buffers.StandardFormat.Symbol> and <xref:System.Buffers.StandardFormat.Precision> properties are equal.
112+
113+
]]></format>
114+
</remarks>
96115
</Docs>
97116
</Member>
98117
<Member MemberName="Equals">
@@ -120,10 +139,16 @@
120139
<Parameter Name="obj" Type="System.Object" />
121140
</Parameters>
122141
<Docs>
123-
<param name="obj">To be added.</param>
124-
<summary>To be added.</summary>
125-
<returns>To be added.</returns>
126-
<remarks>To be added.</remarks>
142+
<param name="obj">An object to compare to the current instance.</param>
143+
<summary>Returns a value that indicates whether a specified object is a <see cref="T:System.Buffers.StandardFormat"> object that is equal to the current instance.</summary>
144+
<returns><see langword="true" /> if the two instances are equal; otherwise, <see langword="false" />.</returns>
145+
<remarks>
146+
<format type="text/markdown"><![CDATA[
147+
148+
Two <xref:System.Buffers.StandardFormat> instances are equal if their <xref:System.Buffers.StandardFormat.Symbol> and <xref:System.Buffers.StandardFormat.Precision> properties are equal.
149+
150+
]]></format>
151+
</remarks>
127152
</Docs>
128153
</Member>
129154
<Member MemberName="GetHashCode">
@@ -149,8 +174,8 @@
149174
</ReturnValue>
150175
<Parameters />
151176
<Docs>
152-
<summary>To be added.</summary>
153-
<returns>To be added.</returns>
177+
<summary>Returns the hash code for this instance.</summary>
178+
<returns>The hash code for this instance.</returns>
154179
<remarks>To be added.</remarks>
155180
</Docs>
156181
</Member>
@@ -174,10 +199,10 @@
174199
</AssemblyInfo>
175200
<ReturnValue>
176201
<ReturnType>System.Boolean</ReturnType>
177-
</ReturnValue>
202+
</ReturnValue>a
178203
<Docs>
179-
<summary>To be added.</summary>
180-
<value>To be added.</value>
204+
<summary>Gets a value that indicates whether a format has a defined precision.</summary>
205+
<value><see langword="true" /> if the format has a precision other than <see cref="F:System.Buffers.StandardFormat.NoPrecision">; otherwise, <see langword="false" />.</value>
181206
<remarks>To be added.</remarks>
182207
</Docs>
183208
</Member>
@@ -203,9 +228,15 @@
203228
<ReturnType>System.Boolean</ReturnType>
204229
</ReturnValue>
205230
<Docs>
206-
<summary>To be added.</summary>
207-
<value>To be added.</value>
208-
<remarks>To be added.</remarks>
231+
<summary>Gets a value that indicates whether the current instance is a default format.</summary>
232+
<value><see langword="true" /> if the current instance is a default format; otherwise, <see langword="false" />.</value>
233+
<remarks>
234+
<format type="text/markdown"><![CDATA[
235+
236+
A default format has a format specifier whose <xref:System.Byte> value is 0 and whose precision is <xref:System.Buffers.StandardFormat.NoPrecision>.
237+
238+
]]></format>
239+
</remarks>
209240
</Docs>
210241
</Member>
211242
<Member MemberName="MaxPrecision">
@@ -231,8 +262,8 @@
231262
</ReturnValue>
232263
<MemberValue>99</MemberValue>
233264
<Docs>
234-
<summary>To be added.</summary>
235-
<remarks>To be added.</remarks>
265+
<summary>Defines the maximum valid precision value.</summary>
266+
<remarks>The maximum valid precision is 99.</remarks>
236267
</Docs>
237268
</Member>
238269
<Member MemberName="NoPrecision">
@@ -258,7 +289,7 @@
258289
</ReturnValue>
259290
<MemberValue>255</MemberValue>
260291
<Docs>
261-
<summary>To be added.</summary>
292+
<summary>Indicates that a format doesn't use a precision or that the precision is unspecified.</summary>
262293
<remarks>To be added.</remarks>
263294
</Docs>
264295
</Member>
@@ -290,9 +321,15 @@
290321
<Docs>
291322
<param name="left">To be added.</param>
292323
<param name="right">To be added.</param>
293-
<summary>To be added.</summary>
294-
<returns>To be added.</returns>
295-
<remarks>To be added.</remarks>
324+
<summary>Returns a value that indicates whether two <see cref="T:System.Buffers.StandardFormat"> instances are equal.</summary>
325+
<returns><see langword="true" /> if the two instances are equal; otherwise, <see langword="false" />.</returns>
326+
<remarks>
327+
<format type="text/markdown"><![CDATA[
328+
329+
Two <xref:System.Buffers.StandardFormat> instances are equal if their <xref:System.Buffers.StandardFormat.Symbol> and <xref:System.Buffers.StandardFormat.Precision> properties are equal.
330+
331+
]]></format>
332+
</remarks>
296333
</Docs>
297334
</Member>
298335
<Member MemberName="op_Implicit">
@@ -321,8 +358,8 @@
321358
</Parameters>
322359
<Docs>
323360
<param name="symbol">To be added.</param>
324-
<summary>To be added.</summary>
325-
<returns>To be added.</returns>
361+
<summary>Converts a character to a <see cref="T:System.Buffers.StandardFormat" /> instance using <see cref="F:System.Buffers.StandardFormat.NoPrecision" /> precision.</summary>
362+
<returns>A format with a <see cref="P:System.Buffers.StandardFormat.Symbol" /> property equal to <paramref name="symbol" /> and a <see cref="P:System.Buffers.StandardFormat.Precision" /> property equal to <see cref="F:System.Buffers.StandardFormat.NoPrecision" />.</returns>
326363
<remarks>To be added.</remarks>
327364
</Docs>
328365
</Member>
@@ -352,11 +389,17 @@
352389
<Parameter Name="right" Type="System.Buffers.StandardFormat" />
353390
</Parameters>
354391
<Docs>
355-
<param name="left">To be added.</param>
356-
<param name="right">To be added.</param>
357-
<summary>To be added.</summary>
358-
<returns>To be added.</returns>
359-
<remarks>To be added.</remarks>
392+
<param name="left">The first format to compare.</param>
393+
<param name="right">The second format to compare.</param>
394+
<summary>Determines whether two <see cref="T:System.Buffers.StandardFormat" /> instances are unequal.</summary>
395+
<returns><see langword="true" /> if the two formats are unequal; otherwise, see <langword="false" />.</returns>
396+
<remarks>
397+
<format type="text/markdown"><![CDATA[
398+
399+
Two <xref:System.Buffers.StandardFormat> instances are unequal if their <xref:System.Buffers.StandardFormat.Symbol> and <xref:System.Buffers.StandardFormat.Precision> properties are not identical.
400+
401+
]]></format>
402+
</remarks>
360403
</Docs>
361404
</Member>
362405
<Member MemberName="Parse">
@@ -385,7 +428,7 @@
385428
</Parameters>
386429
<Docs>
387430
<param name="format">To be added.</param>
388-
<summary>To be added.</summary>
431+
<summary>Converts a <see cref="T:System.ReadOnlySpan{System.Char}" /> into a <see cref="T:System.Buffers.StandardFormat" /> instance using <see cref="F:System.Buffers.StandardFormat.NoPrecision" /> precision.</summary>
389432
<returns>To be added.</returns>
390433
<remarks>To be added.</remarks>
391434
</Docs>
@@ -415,10 +458,11 @@
415458
<Parameter Name="format" Type="System.String" />
416459
</Parameters>
417460
<Docs>
418-
<param name="format">To be added.</param>
419-
<summary>To be added.</summary>
420-
<returns>To be added.</returns>
461+
<param name="format">A classic .NET standard format string.</param>
462+
<summary>Converts a classic .NET standard format string to a <see cref="T:System.Buffers.StandardFormat" /> instance.</summary>
463+
<returns>A format.</returns>
421464
<remarks>To be added.</remarks>
465+
<exception cref="T:System.FormatException"><paramref name="format" /> is not a valid standard format string.</exception>
422466
</Docs>
423467
</Member>
424468
<Member MemberName="Precision">
@@ -443,8 +487,8 @@
443487
<ReturnType>System.Byte</ReturnType>
444488
</ReturnValue>
445489
<Docs>
446-
<summary>To be added.</summary>
447-
<value>To be added.</value>
490+
<summary>Gets the precision component of the format.</summary>
491+
<value>The precision component, which can be <see cref="F:System.Buffers.StandardFormat.NoPrecision" ?>, or can range from 0 to 9.</value>
448492
<remarks>To be added.</remarks>
449493
</Docs>
450494
</Member>
@@ -470,7 +514,7 @@
470514
<ReturnType>System.Char</ReturnType>
471515
</ReturnValue>
472516
<Docs>
473-
<summary>To be added.</summary>
517+
<summary>Gets the character component of the format.</summary>
474518
<value>To be added.</value>
475519
<remarks>To be added.</remarks>
476520
</Docs>
@@ -498,9 +542,15 @@
498542
</ReturnValue>
499543
<Parameters />
500544
<Docs>
501-
<summary>To be added.</summary>
502-
<returns>To be added.</returns>
503-
<remarks>To be added.</remarks>
545+
<summary>Returns the string representation of this format.</summary>
546+
<returns>The string representation of this format.</returns>
547+
<remarks>
548+
<format type="text/markdown"><![CDATA[
549+
550+
The string representation of a <xref:System.Buffers.StandardFormat> instance is a standard .NET format string.
551+
552+
]]></format>
553+
</remarks>
504554
</Docs>
505555
</Member>
506556
<Member MemberName="TryParse">
@@ -526,10 +576,10 @@
526576
<Parameter Name="result" Type="System.Buffers.StandardFormat" RefType="out" Index="1" FrameworkAlternate="netcore-3.0" />
527577
</Parameters>
528578
<Docs>
529-
<param name="format">To be added.</param>
530-
<param name="result">To be added.</param>
531-
<summary>To be added.</summary>
532-
<returns>To be added.</returns>
579+
<param name="format">A read-only span that contains the character to convert.</param>
580+
<param name="result">When the method returns, contains the parsed <see cref="T:System.Buffers.StandardFormat" /> instance if the operation was successful.</param>
581+
<summary>Attempts to convert a <see cref="T:System.ReadOnlySpan{Char}" /> to a <see cref="T:System.Buffers.StandardFormat" /> instance and returns a value that indicates whether the parsing operation succeeded.</summary>
582+
<returns><see langword="true" /> if the parsing operation was successful; otherwise, <see langword="false" />.</returns>
533583
<remarks>To be added.</remarks>
534584
</Docs>
535585
</Member>

0 commit comments

Comments
 (0)