Skip to content

Document Android.Window back events - #424

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-android-window-api-docs
Aug 14, 2026
Merged

Document Android.Window back events#424
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-android-window-api-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document the public value contracts for Android.Window.BackEvent frame time, progress, swipe edge, and touch coordinates.
  • Document Android.Window.BackEventEdge and all of its values from the Android BackEvent reference.
  • Leave binding-only members and the remaining Android.Window placeholders for follow-up work.

Sources

Validation

  • Parsed both changed XML files with System.Xml.XmlDocument.
  • Confirmed CRLF line endings and ran git diff --check.
  • Confirmed the focused diff removes ten public documentation placeholders.

Refs #194

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 Android.Window XML reference documentation to replace “To be added.” placeholders with concrete value-contract documentation for BackEvent and the BackEventEdge enum, aligning the bindings docs more closely with the Android reference.

Changes:

  • Added enum-level and member-level documentation for Android.Window.BackEventEdge.
  • Filled in <value> documentation for several Android.Window.BackEvent properties (frame time, progress, swipe edge, touch coordinates).

Reviewed changes

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

File Description
docs/xml/Android.Window/BackEventEdge.xml Replaces placeholder type/member docs with descriptive summaries/remarks for the enum and its values.
docs/xml/Android.Window/BackEvent.xml Replaces placeholder <value> docs with explicit value contracts for several properties.
Suppressed comments (1)

docs/xml/Android.Window/BackEvent.xml:587

  • <see langword="…" /> is intended for language keywords (e.g., null, true), not numeric constants. Using langword="NaN" may not render as intended in generated docs. Use inline code formatting (consistent with the surrounding docs) or a cref to the NaN constant instead.
        <value>The absolute Y location of the touch point, or <see langword="NaN" /> for a button press.</value>

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

Comment thread docs/xml/Android.Window/BackEvent.xml Outdated
Comment thread docs/xml/Android.Window/BackEventEdge.xml
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 back-event values and edge semantics match Android, with formatting and attribution findings resolved.

@jonathanpeppers
jonathanpeppers merged commit 0ff7bab into main Aug 14, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-android-window-api-docs branch August 14, 2026 21:19
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