Skip to content

Commit 67552e6

Browse files
authored
style guide + missing sections (#2827)
1 parent e0ff280 commit 67552e6

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

xml/System.Buffers/SequenceReader`1.xml

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -342,9 +342,9 @@
342342
<Docs>
343343
<param name="next">The span to compare the next items to.</param>
344344
<param name="advancePast">
345-
<see langword="true" /> to move past the <paramref name="next" /> values if they are found, or <see langword="false" /> to not move past them. </param>
345+
<see langword="true" /> to move past the <paramref name="next" /> values if they are found; otherwise, <see langword="false" />.</param>
346346
<summary>Checks whether the values specified in a read-only span are next in the sequence.</summary>
347-
<returns>To be added.</returns>
347+
<returns><see langword="true" /> if the values are next in sequence; otherwise, <see langword="false" />.</returns>
348348
<remarks>To be added.</remarks>
349349
</Docs>
350350
</Member>
@@ -369,9 +369,9 @@
369369
<Docs>
370370
<param name="next">The value to compare the next items to.</param>
371371
<param name="advancePast">
372-
<see langword="true" /> to move past the <paramref name="next" /> values if they are found, or <see langword="false" /> to not move past them. </param>
372+
<see langword="true" /> to move past the <paramref name="next" /> values if they are found; otherwise, <see langword="false" />.</param>
373373
<summary>Checks whether a specified value is next in the sequence.</summary>
374-
<returns>To be added.</returns>
374+
<returns><see langword="true" /> if the values are next in sequence; otherwise, <see langword="false" />.</returns>
375375
<remarks>To be added.</remarks>
376376
</Docs>
377377
</Member>
@@ -557,7 +557,7 @@
557557
<param name="advancePastDelimiter"><see langword="true" /> to move past the first instance of any of the given <paramref name="delimiters" />; <see lanword="false" /> to not move past the delimiter.</param>
558558
<summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary>
559559
<returns>
560-
<see langword="true" /> if any of the given <paramref name="delimiters" /> was found.</returns>
560+
<see langword="true" /> if any of the given <paramref name="delimiters" /> was found; otherwise, <see langword="false" />.</returns>
561561
<remarks>To be added.</remarks>
562562
</Docs>
563563
</Member>
@@ -591,7 +591,11 @@
591591
<see langword="true" /> if there is enough data to completely fill the <paramref name="destination" /> span; otherwise, <see langword="false" />.</returns>
592592
<remarks>
593593
<format type="text/markdown"><![CDATA[
594+
595+
## Remarks
596+
594597
This method copies a fixed amount of data out of the sequence if possible. It does not advance the reader. To look ahead for a specific stream of data, use <xref:System.Buffers.SequenceReader`1.IsNext(System.ReadOnlySpan{`0},System.Boolean)>.
598+
595599
]]></format>
596600
</remarks>
597601
</Docs>
@@ -676,7 +680,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
676680
<param name="sequence">When the method returns, contains the data read, if any.</param>
677681
<param name="delimiter">A read-only span that contains one or more delimiters.</param>
678682
<param name="advancePastDelimiter">
679-
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
683+
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
680684
<summary>Tries to read data until the entire delimiter specified as a read-only span matches.</summary>
681685
<returns>
682686
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
@@ -706,7 +710,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
706710
<param name="sequence">When the method returns, contains the data read, if any.</param>
707711
<param name="delimiter">The delimiter to look for.</param>
708712
<param name="advancePastDelimiter">
709-
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
713+
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
710714
<summary>Tries to read everything up to the given <paramref name="delimiter" />.</summary>
711715
<returns>
712716
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
@@ -736,10 +740,10 @@ This method copies a fixed amount of data out of the sequence if possible. It do
736740
<param name="span">When the method returns, contains the data read, if any.</param>
737741
<param name="delimiter">The delimiter to look for.</param>
738742
<param name="advancePastDelimiter">
739-
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
743+
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
740744
<summary>Tries to read everything up to the given <paramref name="delimiter" />.</summary>
741745
<returns>
742-
<see langword="true" /> if the <paramref name="delimiter" /> was found.</returns>
746+
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
743747
<remarks>To be added.</remarks>
744748
</Docs>
745749
</Member>
@@ -768,7 +772,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
768772
<param name="delimiter">The delimiter to look for.</param>
769773
<param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
770774
<param name="advancePastDelimiter">
771-
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
775+
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
772776
<summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary>
773777
<returns>
774778
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
@@ -800,7 +804,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
800804
<param name="delimiter">The delimiter to look for.</param>
801805
<param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
802806
<param name="advancePastDelimiter">
803-
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
807+
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
804808
<summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary>
805809
<returns>
806810
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
@@ -830,7 +834,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
830834
<param name="sequence">When the method returns, contains the data read, if any.</param>
831835
<param name="delimiters">The delimiters to look for.</param>
832836
<param name="advancePastDelimiter">
833-
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />.</param>
837+
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />; otherwise, <see langword="false" />.</param>
834838
<summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary>
835839
<returns>
836840
<see langword="true" /> if any of the <paramref name="delimiters" /> were found; otherwise, <see langword="false" />.</returns>
@@ -860,7 +864,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
860864
<param name="span">When the method returns, contains the data read, if any.</param>
861865
<param name="delimiters">The delimiters to look for.</param>
862866
<param name="advancePastDelimiter">
863-
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />.</param>
867+
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />; otherwise, <see langword="false" />.</param>
864868
<summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary>
865869
<returns>
866870
<see langword="true" /> if any of the <paramref name="delimiters" /> were found; otherwise, <see langword="false" />.</returns>
@@ -889,7 +893,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
889893
</ReturnValue>
890894
<Docs>
891895
<summary>Gets the unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</summary>
892-
<value>To be added.</value>
896+
<value>The unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</value>
893897
<remarks>To be added.</remarks>
894898
</Docs>
895899
</Member>

0 commit comments

Comments
 (0)