Skip to content

Document ByteBuffer primitive reads - #566

Merged
jonathanpeppers merged 1 commit into
mainfrom
jonathanpeppers-document-java-nio-apis
Aug 16, 2026
Merged

Document ByteBuffer primitive reads#566
jonathanpeppers merged 1 commit into
mainfrom
jonathanpeppers-document-java-nio-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document the return values for ByteBuffer relative primitive-read properties: Char, Double, Float, Int, Long, and Short.
  • Add an exact Android reference anchor for each documented member.

Sources

Validation

  • Parsed docs/xml/Java.Nio/ByteBuffer.xml as XML.
  • Confirmed CRLF-only line endings (lf-only=0, cr-only=0).
  • Ran git diff --check.
  • Reduced To be added. occurrences in ByteBuffer.xml from 12 to 6; the remaining placeholders are outside this member scope.

Refs #234

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 improves the Java.Nio.ByteBuffer XML documentation by replacing To be added. placeholders with concrete return-value descriptions for the relative primitive-read properties, and by adding direct Android reference anchors for each documented member.

Changes:

  • Replaced placeholder <value>To be added.</value> text with specific return-value descriptions for Char, Double, Float, Int, Long, and Short.
  • Added Android reference links (exact anchors) in <remarks> for each of those members.

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

@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

1 similar comment
@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 ByteBuffer return contracts match the Android APIs and managed signatures, with complete source/generated parity and no remaining blocking issue.

@jonathanpeppers
jonathanpeppers merged commit 2321816 into main Aug 16, 2026
4 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-java-nio-apis 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