Skip to content

Document inspector API contracts - #625

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-view-inspectors-apis
Aug 18, 2026
Merged

Document inspector API contracts#625
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-document-view-inspectors-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Sources

Validation

  • Parsed the changed XML files successfully.
  • Confirmed CRLF line endings with no lone LF bytes.
  • Ran git diff --check.
  • Confirmed 70 To be added. occurrences remain in docs/xml/Android.Views.Inspectors; they are unrelated binding-runtime members without Android reference documentation.

Refs #243

Refs #243

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 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(...) and IntFlagMapping.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 Get member 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.

Comment thread docs/xml/Android.Views.Inspectors/IntFlagMapping.xml Outdated
Refs #243

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 17, 2026 02:38
@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 inspector contracts, managed signatures, API metadata, and generated documentation match Android.

@jonathanpeppers
jonathanpeppers merged commit 54f1dc6 into main Aug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-view-inspectors-apis branch August 18, 2026 00:09
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