Skip to content

Document ZIP checksum parameter values - #581

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-java-zip-apis-6cd
Aug 16, 2026
Merged

jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-java-zip-apis-6cd

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #256

Sources

Validation

  • Parsed both modified XML files with PowerShell's XML parser.
  • Confirmed CRLF-only line endings and no lone LF bytes in both modified files.
  • Ran git diff --check.

Refs #256

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings August 16, 2026 13:38
@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 16, 2026 13:38

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 generated XML documentation for Java.Util.Zip checksum APIs by replacing placeholder text with concrete parameter/value descriptions, aligning the docs more closely with the underlying Java/Android reference semantics.

Changes:

  • Documented off/len parameter meanings for Update(byte[] b, int off, int len) in CRC32 and Adler32.
  • Documented the Value property description for Adler32.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/xml/Java.Util.Zip/CRC32.xml Replaces placeholder parameter docs for Update(byte[], int, int).
docs/xml/Java.Util.Zip/Adler32.xml Replaces placeholder parameter docs for Update(byte[], int, int) and fills in the Value property <value> description.

💡 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.Util.Zip/CRC32.xml Outdated
Comment thread docs/xml/Java.Util.Zip/Adler32.xml Outdated
Refs #256

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@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 Adler32 and CRC32 update parameter/value contracts now match Android and the managed signatures.

@jonathanpeppers
jonathanpeppers merged commit 8c06ef3 into main Aug 16, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-java-zip-apis-6cd branch August 16, 2026 22:36
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