Skip to content

Document MatrixCursor RowBuilder APIs - #569

Merged
jonathanpeppers merged 5 commits into
mainfrom
jonathanpeppers-android-database-xml-docs
Aug 18, 2026
Merged

Document MatrixCursor RowBuilder APIs#569
jonathanpeppers merged 5 commits into
mainfrom
jonathanpeppers-android-database-xml-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Documents the MatrixCursor.RowBuilder.Add overload parameter, return, and behavior descriptions.

Sources

Validation

  • Parsed docs/xml/Android.Database/MatrixCursor+RowBuilder.xml with PowerShell's XML parser.
  • Confirmed CRLF line endings and ran git diff --check.

Refs #87

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

CopilotAI 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 Android.Database.MatrixCursor.RowBuilder to replace placeholder text with concrete parameter/return descriptions aligned with the Android reference docs.

Changes:

  • Documented the Add(Object columnValue) overload’s parameter meaning and chaining return value.
  • Documented the Add(string columnName, Object value) overload’s parameters, chaining return value, and “offer-if-column-exists” behavior in the summary.

💡 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
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto 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.

RowBuilder.Add(string? columnName, object? value) accepts a nullable managed name, but Android dereferences it and throws NullPointerException for null; the new wording instead implies unmatched names are merely ignored. Please document the non-null requirement and exception contract, and consider correcting the binding nullability: MatrixCursor+RowBuilder.xml.

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

Copy link
Copy Markdown
MemberAuthor

@dalexsoto Addressed in 0d09543: Add(string columnName, ...) now has a non-null managed signature, its parameter documentation requires a non-null name, and its NullPointerException contract is documented. The unmatched-column behavior remains documented separately.

@dalexsotodalexsoto 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 nullability fix is incomplete:

  • The displayed string columnName signature no longer matches the shipping managed API, which remains string? across current monikers. Either restore string? or fix binding metadata upstream and regenerate.
  • A null name does not always throw: a valid zero-column cursor skips the dereference and returns normally. Keep the non-null precondition, but remove or qualify the unconditional NullPointerException claim.

jonathanpeppersand others added 2 commits August 18, 2026 15:01
…-xml-docs' into jonathanpeppers-complete-pr-569
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: bb29695e-6035-4ec4-9b39-419468fe8a78
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

Addressed the latest review on the refreshed branch: restored the shipping \string? columnName\ signature, retained the non-null precondition in the parameter documentation, and removed the unconditional \NullPointerException\ claim because zero-column cursors do not dereference the name.

@dalexsotodalexsoto 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 RowBuilder contract now preserves the shipping nullable signature while accurately documenting name matching and zero-column behavior.

@jonathanpeppers
jonathanpeppers merged commit 0e91fa7 into mainAug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-android-database-xml-docs branch August 18, 2026 21:22
Sign up for freeto 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

@jonathanpeppers@dalexsoto