Document Android ranging session APIs - #603
Conversation
Refs #159 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the XML documentation for the Android.Ranging namespace to replace “To be added” placeholders with usable API docs for key session and capability entry points, aligned with the official Android reference pages.
Changes:
- Documented
RangingManager.CreateRangingSession(...)parameters, return value, and behavior. - Documented capabilities callback registration/unregistration APIs.
- Documented
RangingSession.Close()and added reference/license attribution blocks.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/xml/Android.Ranging/RangingSession.xml | Replaces placeholder docs for Close() with descriptive summary/remarks plus reference/license attribution. |
| docs/xml/Android.Ranging/RangingManager.xml | Replaces placeholder docs for session creation and capabilities callback registration/unregistration with detailed remarks and reference/license attribution. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #159 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
dalexsoto
left a comment
There was a problem hiding this comment.
Two ranging-session contracts remain inaccurate:
- Session creation can return null when a session cannot be created; the managed signature is nullable.
- Unregistering a capabilities callback cannot cancel callbacks already queued on its executor, so it must not guarantee an immediate callback cutoff.
Please document both the nullable result and possible pending/in-flight callback delivery.
|
@dalexsoto Thank you for the ranging contract corrections. I am applying and validating the nullable session-creation result and the queued-callback behavior before the requested review; the PR retains squash auto-merge. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 59d8bac3-4d1e-4af6-9b60-b12951db8cec
|
@dalexsoto The requested contract corrections are now in a2b0b76: CreateRangingSession documents its nullable failure result, and capabilities callbacks already queued or in progress may still run after unregistration. XML, CRLF, diff, and official Android source-anchor validation passed. |
dalexsoto
left a comment
There was a problem hiding this comment.
Ranging session creation now documents its nullable failure result, and callback unregistration correctly allows queued or in-flight callbacks to complete.
Pull request was closed
Summary
Sources
Validation
git diff --check.@dalexsoto please review this focused Android.Ranging documentation update.