Skip to content

Document BufferedInputStream fields #562

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
jonathanpeppers merged 2 commits into from
Aug 16, 2026
Merged

Document BufferedInputStream fields #562

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46942cc
Document BufferedInputStream fields
jonathanpeppers Aug 15, 2026
75f2f99
Correct BufferedInputStream position wording
jonathanpeppers Aug 15, 2026
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
12 changes: 6 additions & 6 deletions docs/xml/Java.IO/BufferedInputStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
</ReturnValue>
<Docs>
<summary>The internal buffer array where the data is stored.</summary>
<value>To be added.</value>
<value>The internal buffer array where the data is stored.</value>
<remarks>
<para>The internal buffer array where the data is stored. When necessary,
it may be replaced by another array of
Expand Down Expand Up @@ -241,7 +241,7 @@
<Docs>
<summary>The index one greater than the index of the last valid byte in
the buffer.</summary>
<value>To be added.</value>
<value>The index one greater than the index of the last valid byte in the buffer.</value>
<remarks>
<para>The index one greater than the index of the last valid byte in
the buffer.
Expand Down Expand Up @@ -318,7 +318,7 @@
<summary>The maximum read ahead allowed after a call to the
<c>mark</c> method before subsequent calls to the
<c>reset</c> method fail.</summary>
<value>To be added.</value>
<value>The maximum read ahead allowed after a call to the <c>mark</c> method before subsequent calls to the <c>reset</c> method fail.</value>
<remarks>
<para>The maximum read ahead allowed after a call to the
<c>mark</c> method before subsequent calls to the
Expand Down Expand Up @@ -363,7 +363,7 @@
<Docs>
<summary>The value of the <c>pos</c> field at the time the last
<c>mark</c> method was called.</summary>
<value>To be added.</value>
<value>The value of the <c>pos</c> field at the time the last <c>mark</c> method was called.</value>
<remarks>
<para>The value of the <c>pos</c> field at the time the last
<c>mark</c> method was called.</para>
Expand Down Expand Up @@ -421,10 +421,10 @@
</ReturnValue>
<Docs>
<summary>The current position in the buffer.</summary>
<value>To be added.</value>
<value>The current position in the buffer.</value>
<remarks>
<para>The current position in the buffer. This is the index of the next
character to be read from the <c>buf</c> array.</para>
byte to be read from the <c>buf</c> array.</para>
<para>This value is always in the range <c>0</c>
through <c>count</c>. If it is less
than <c>count</c>, then <c>buf[pos]</c>
Expand Down