Skip to content

Document BufferedInputStream fields - #562

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-java-io-api-docs
Aug 16, 2026
Merged

Document BufferedInputStream fields#562
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-java-io-api-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

Documents the Android-backed BufferedInputStream protected field values for �uf, count, marklimit, markpos, and pos.

Refs #237

Sources

Validation

  • [xml](Get-Content -Raw 'docs\xml\Java.IO\BufferedInputStream.xml') — parsed successfully.
  • git diff --check — passed.
  • CRLF check — 513 CRLF lines and 0 LF-only lines.
  • Scoped placeholder count (summary, �alue,
    eturns, and param To be added. entries): Java.IO 769 before, 764 after; edited file 7 before, 2 after. The remaining two in BufferedInputStream.xml are generated JniPeerMembers binding entries and were intentionally left undocumented.

Refs #237

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the XML documentation for Java.IO.BufferedInputStream to replace placeholder <value> entries with concrete descriptions for several Android-backed protected fields/properties.

Changes:

  • Filled in <value> documentation for buf, count, marklimit, markpos, and pos in BufferedInputStream.xml.
  • Reduced “To be added.” placeholders in the Java.IO XML docs set (scoped to the edited file/entries).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Java.IO/BufferedInputStream.xml Outdated
Refs #237

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 15:07
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The BufferedInputStream field contracts now use the correct byte-oriented terminology, and the accepted generated-member scope remains intact.

@jonathanpeppers
jonathanpeppers merged commit 223f23e into main Aug 16, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-java-io-api-docs branch August 16, 2026 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants