|
342 | 342 | <Docs> |
343 | 343 | <param name="next">The span to compare the next items to.</param> |
344 | 344 | <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> |
346 | 346 | <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> |
348 | 348 | <remarks>To be added.</remarks> |
349 | 349 | </Docs> |
350 | 350 | </Member> |
|
369 | 369 | <Docs> |
370 | 370 | <param name="next">The value to compare the next items to.</param> |
371 | 371 | <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> |
373 | 373 | <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> |
375 | 375 | <remarks>To be added.</remarks> |
376 | 376 | </Docs> |
377 | 377 | </Member> |
|
557 | 557 | <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> |
558 | 558 | <summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary> |
559 | 559 | <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> |
561 | 561 | <remarks>To be added.</remarks> |
562 | 562 | </Docs> |
563 | 563 | </Member> |
|
591 | 591 | <see langword="true" /> if there is enough data to completely fill the <paramref name="destination" /> span; otherwise, <see langword="false" />.</returns> |
592 | 592 | <remarks> |
593 | 593 | <format type="text/markdown"><![CDATA[ |
| 594 | +
|
| 595 | +## Remarks |
| 596 | +
|
594 | 597 | 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 | +
|
595 | 599 | ]]></format> |
596 | 600 | </remarks> |
597 | 601 | </Docs> |
@@ -676,7 +680,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do |
676 | 680 | <param name="sequence">When the method returns, contains the data read, if any.</param> |
677 | 681 | <param name="delimiter">A read-only span that contains one or more delimiters.</param> |
678 | 682 | <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> |
680 | 684 | <summary>Tries to read data until the entire delimiter specified as a read-only span matches.</summary> |
681 | 685 | <returns> |
682 | 686 | <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 |
706 | 710 | <param name="sequence">When the method returns, contains the data read, if any.</param> |
707 | 711 | <param name="delimiter">The delimiter to look for.</param> |
708 | 712 | <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> |
710 | 714 | <summary>Tries to read everything up to the given <paramref name="delimiter" />.</summary> |
711 | 715 | <returns> |
712 | 716 | <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 |
736 | 740 | <param name="span">When the method returns, contains the data read, if any.</param> |
737 | 741 | <param name="delimiter">The delimiter to look for.</param> |
738 | 742 | <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> |
740 | 744 | <summary>Tries to read everything up to the given <paramref name="delimiter" />.</summary> |
741 | 745 | <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> |
743 | 747 | <remarks>To be added.</remarks> |
744 | 748 | </Docs> |
745 | 749 | </Member> |
@@ -768,7 +772,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do |
768 | 772 | <param name="delimiter">The delimiter to look for.</param> |
769 | 773 | <param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param> |
770 | 774 | <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> |
772 | 776 | <summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary> |
773 | 777 | <returns> |
774 | 778 | <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 |
800 | 804 | <param name="delimiter">The delimiter to look for.</param> |
801 | 805 | <param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param> |
802 | 806 | <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> |
804 | 808 | <summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary> |
805 | 809 | <returns> |
806 | 810 | <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 |
830 | 834 | <param name="sequence">When the method returns, contains the data read, if any.</param> |
831 | 835 | <param name="delimiters">The delimiters to look for.</param> |
832 | 836 | <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> |
834 | 838 | <summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary> |
835 | 839 | <returns> |
836 | 840 | <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 |
860 | 864 | <param name="span">When the method returns, contains the data read, if any.</param> |
861 | 865 | <param name="delimiters">The delimiters to look for.</param> |
862 | 866 | <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> |
864 | 868 | <summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary> |
865 | 869 | <returns> |
866 | 870 | <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 |
889 | 893 | </ReturnValue> |
890 | 894 | <Docs> |
891 | 895 | <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> |
893 | 897 | <remarks>To be added.</remarks> |
894 | 898 | </Docs> |
895 | 899 | </Member> |
|
0 commit comments