Document inspector API contracts - #625
Merged
jonathanpeppers merged 2 commits intoAug 18, 2026
Merged
Conversation
Refs #243 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 17, 2026 02:27
jonathanpeppers
enabled auto-merge (squash)
August 17, 2026 02:27
There was a problem hiding this comment.
Pull request overview
This PR refines XML documentation for Android.Views.Inspectors members to better match the Android reference contracts (notably nullability/emptiness guarantees) and to improve wording consistency.
Changes:
- Updated
WindowInspector.GetGlobalWindowViews()docs to clarify it returns a non-null list. - Updated
IntFlagMapping.Add(...)andIntFlagMapping.Get(int)docs to align phrasing with the Android reference (including non-null / empty-set semantics).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/xml/Android.Views.Inspectors/WindowInspector.xml | Tightens summary/value wording for GetGlobalWindowViews() to reflect the API contract (non-null list). |
| docs/xml/Android.Views.Inspectors/IntFlagMapping.xml | Improves parameter/return contract wording for Add/Get and updates summaries accordingly. |
Suppressed comments (1)
docs/xml/Android.Views.Inspectors/IntFlagMapping.xml:157
- In the
Getmember docs, the first remarks paragraph uses imperative phrasing ("Get …") while the summary uses third-person present tense ("Gets …"). Also, the<returns>text currently reads like it returns the names themselves rather than a collection; rewording to explicitly describe a (non-null, possibly empty) set improves clarity and matches the Android reference wording.
<summary>Gets a set of the names of enabled flags for a given property value.</summary>
<returns>The non-null names of the enabled flags, or an empty set if no flags are enabled.</returns>
<remarks>
<para>Get a set of the names of enabled flags for a given property value.</para>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Refs #243 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and removed request for
dalexsoto
August 17, 2026 02:38
Member
Author
|
@dalexsoto review |
dalexsoto
approved these changes
Aug 18, 2026
dalexsoto
left a comment
Member
There was a problem hiding this comment.
The inspector contracts, managed signatures, API metadata, and generated documentation match Android.
jonathanpeppers
deleted the
jonathanpeppers-document-view-inspectors-apis
branch
August 18, 2026 00:09
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sources
Validation
git diff --check.To be added.occurrences remain indocs/xml/Android.Views.Inspectors; they are unrelated binding-runtime members without Android reference documentation.Refs #243