Skip to content

Document Android.Window APIs - #554

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-android-window
Open

Document Android.Window APIs#554
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-android-window

Conversation

@jonathanpeppers

@jonathanpeppers jonathanpeppers commented Aug 15, 2026

Copy link
Copy Markdown
Member

Summary

  • document the 34 Android.Window XML entries directly supported by the official Android API reference
  • deliberately retain generated binding-infrastructure and synthetic-wrapper placeholders where those references provide no equivalent API documentation
  • preserve CRLF line endings

Refs #194

Sources

Validation

  • Parsed all 18 scoped Android.Window XML files with PowerShell XML parsing.
  • Confirmed every scoped XML file uses CRLF line endings.
  • Confirmed 74 To be added. placeholders remain in docs/xml/Android.Window and docs/xml/ns-Android.Window.xml.
  • Ran git diff --check.

Coverage and gaps

  • Replaced 34 entries with documentation directly supported by the official Android references above.
  • Left 74 placeholders for generated binding infrastructure and synthetic wrappers that do not have equivalent official Android/Java reference coverage.
  • No AOSP source was used because it would not provide authoritative documentation for those .NET binding-generated members.

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 replaces remaining To be added. placeholders in the Android.Window XML documentation surface with meaningful summaries/remarks derived from the official Android API reference, improving the generated docs for window/predictive-back/splash screen/surface sync and related APIs.

Changes:

  • Updated Android.Window namespace documentation to describe the scope of the API surface.
  • Filled in documentation for key Android.Window types/members (parcelable plumbing, splash screen, surface synchronization, predictive-back related APIs).
  • Clarified parameter/return/value documentation for several members where placeholders previously existed.

Reviewed changes

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

Show a summary per file
File Description
docs/xml/ns-Android.Window.xml Replaces namespace-level placeholders with a scoped summary/remarks.
docs/xml/Android.Window/TrustedPresentationThresholds+InterfaceConsts.xml Documents legacy Parcelable-related constants guidance.
docs/xml/Android.Window/TrustedPresentationThresholds.xml Replaces member placeholders with concrete summaries/values/remarks.
docs/xml/Android.Window/SystemOnBackInvokedCallbacks.xml Documents return values and binding infrastructure members.
docs/xml/Android.Window/SurfaceSyncGroup.xml Documents parameters/returns/remarks for surface sync group APIs and binding infrastructure members.
docs/xml/Android.Window/SplashScreenView.xml Documents nullable value semantics for icon animation-related properties and binding infrastructure members.
docs/xml/Android.Window/SplashScreenStyle.xml Documents enum purpose and enum member meanings.
docs/xml/Android.Window/SplashScreenOnExitAnimationEventArgs.xml Documents event args purpose, constructor parameter, and property semantics.
docs/xml/Android.Window/SplashScreen.xml Documents type purpose and recommends ISplashScreen per obsoletion guidance.
docs/xml/Android.Window/InputTransferToken+InterfaceConsts.xml Documents legacy Parcelable-related constants guidance.
docs/xml/Android.Window/InputTransferToken.xml Replaces member placeholders with concrete summaries/values/remarks for parcelable-related members.
docs/xml/Android.Window/BackEvent.xml Documents binding infrastructure members for BackEvent.

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

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 14:55
@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.

Two Android.Window contracts are inaccurate:

  • SplashScreenView documents a non-animatable icon as returning only null, but Android also permits a non-null zero duration.
  • SystemOnBackInvokedCallbacks says the callback always removes the task; it always finishes the activity, but removes the task from Recents only when that activity is the task root.

Please document both outcomes in SplashScreenView.xml and the conditional task behavior in SystemOnBackInvokedCallbacks.xml.

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