Skip to content

style guide + missing sections #2827

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 2 commits into from
Jul 26, 2019
Merged

style guide + missing sections #2827

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eef4d2a
style guide + missing sections
mairaw Jul 25, 2019
f8f4fd0
Merge branch 'master' into mairaw-patch-1
mairaw Jul 25, 2019
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
32 changes: 18 additions & 14 deletions xml/System.Buffers/SequenceReader`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,9 @@
<Docs>
<param name="next">The span to compare the next items to.</param>
<param name="advancePast">
<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>
<see langword="true" /> to move past the <paramref name="next" /> values if they are found; otherwise, <see langword="false" />.</param>
<summary>Checks whether the values specified in a read-only span are next in the sequence.</summary>
<returns>To be added.</returns>
<returns><see langword="true" /> if the values are next in sequence; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -369,9 +369,9 @@
<Docs>
<param name="next">The value to compare the next items to.</param>
<param name="advancePast">
<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>
<see langword="true" /> to move past the <paramref name="next" /> values if they are found; otherwise, <see langword="false" />.</param>
<summary>Checks whether a specified value is next in the sequence.</summary>
<returns>To be added.</returns>
<returns><see langword="true" /> if the values are next in sequence; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -557,7 +557,7 @@
<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>
<summary>Searches for any of a number of specified delimiters and optionally advances past the first one to be found.</summary>
<returns>
<see langword="true" /> if any of the given <paramref name="delimiters" /> was found.</returns>
<see langword="true" /> if any of the given <paramref name="delimiters" /> was found; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -591,7 +591,11 @@
<see langword="true" /> if there is enough data to completely fill the <paramref name="destination" /> span; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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)>.

]]></format>
</remarks>
</Docs>
Expand Down Expand Up @@ -676,7 +680,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="sequence">When the method returns, contains the data read, if any.</param>
<param name="delimiter">A read-only span that contains one or more delimiters.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
<summary>Tries to read data until the entire delimiter specified as a read-only span matches.</summary>
<returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -706,7 +710,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="sequence">When the method returns, contains the data read, if any.</param>
<param name="delimiter">The delimiter to look for.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
<summary>Tries to read everything up to the given <paramref name="delimiter" />.</summary>
<returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -736,10 +740,10 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="span">When the method returns, contains the data read, if any.</param>
<param name="delimiter">The delimiter to look for.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
<summary>Tries to read everything up to the given <paramref name="delimiter" />.</summary>
<returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found.</returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -768,7 +772,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="delimiter">The delimiter to look for.</param>
<param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
<summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary>
<returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -800,7 +804,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="delimiter">The delimiter to look for.</param>
<param name="delimiterEscape">A value that indicates that an immediately following <paramref name="delimiter" /> is to be skipped.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the <paramref name="delimiter" /> if found.</param>
<see langword="true" /> to move past the <paramref name="delimiter" /> if found; otherwise, <see langword="false" />.</param>
<summary>Tries to read everything up to the given <paramref name="delimiter" />, ignoring delimiters that are preceded by <paramref name="delimiterEscape" />.</summary>
<returns>
<see langword="true" /> if the <paramref name="delimiter" /> was found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -830,7 +834,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="sequence">When the method returns, contains the data read, if any.</param>
<param name="delimiters">The delimiters to look for.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />.</param>
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />; otherwise, <see langword="false" />.</param>
<summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary>
<returns>
<see langword="true" /> if any of the <paramref name="delimiters" /> were found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -860,7 +864,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<param name="span">When the method returns, contains the data read, if any.</param>
<param name="delimiters">The delimiters to look for.</param>
<param name="advancePastDelimiter">
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />.</param>
<see langword="true" /> to move past the first found instance of any of the given <paramref name="delimiters" />; otherwise, <see langword="false" />.</param>
<summary>Tries to read everything up to any of the specified <paramref name="delimiters" />.</summary>
<returns>
<see langword="true" /> if any of the <paramref name="delimiters" /> were found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -889,7 +893,7 @@ This method copies a fixed amount of data out of the sequence if possible. It do
</ReturnValue>
<Docs>
<summary>Gets the unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</summary>
<value>To be added.</value>
<value>The unread portion of the <see cref="P:System.Buffers.SequenceReader`1.CurrentSpan" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down