Skip to content

Document AccessibilityRecord properties - #564

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-accessibility-docs
Aug 16, 2026
Merged

Document AccessibilityRecord properties#564
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-accessibility-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #246

Documents AccessibilityRecord.BeforeText, ClassName, and ContentDescription using their Android getter and setter reference entries. Unsupported generated binding documentation remains untouched.

Sources

Validation

  • Parsed docs/xml/Android.Views.Accessibility/AccessibilityRecord.xml with System.Xml.XmlDocument: passed.
  • Checked git diff --check: passed.
  • Counted To be added. in docs/xml/Android.Views.Accessibility/*.xml: 598 remain (3 in AccessibilityRecord.xml, including unsupported binding infrastructure and an unmodified parameter placeholder).
  • Confirmed CRLF-only line endings in the edited XML: 1,953 CRLF lines and 0 LF-only lines.

Refs #246

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 improves the generated XML documentation for Android.Views.Accessibility.AccessibilityRecord by replacing To be added. placeholders with property documentation sourced from the corresponding Android Java getter/setter reference entries.

Changes:

  • Documented AccessibilityRecord.BeforeText getter/setter with Java reference links.
  • Documented AccessibilityRecord.ClassName getter/setter with Java reference links.
  • Documented AccessibilityRecord.ContentDescription getter/setter with Java reference links.
Suppressed comments (2)

docs/xml/Android.Views.Accessibility/AccessibilityRecord.xml:473

  • The setter link uses java.lang.CharSequence in the URL, but the displayed <code> signature uses the unqualified CharSequence. Other members in this file display the fully-qualified type for these setter links; aligning this avoids mixed signatures in the generated docs.
              <a href="https://developer.android.com/reference/android/view/accessibility/AccessibilityRecord#setContentDescription(java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.accessibility.AccessibilityRecord.setContentDescription(CharSequence)</code>.</a>

docs/xml/Android.Views.Accessibility/AccessibilityRecord.xml:385

  • The setter link uses java.lang.CharSequence in the URL, but the displayed <code> signature uses the unqualified CharSequence. Elsewhere in this file (e.g., ClassNameFormatted) the displayed signature includes java.lang.CharSequence; updating this keeps the doc links consistent.
              <a href="https://developer.android.com/reference/android/view/accessibility/AccessibilityRecord#setClassName(java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.accessibility.AccessibilityRecord.setClassName(CharSequence)</code>.</a>

💡 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.Accessibility/AccessibilityRecord.xml Outdated
Refs #246

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 16:39

@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 AccessibilityRecord property contracts and displayed signatures now match the platform and managed APIs, with the accepted generated-binding scope preserved.

@jonathanpeppers
jonathanpeppers merged commit c988878 into main Aug 16, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-accessibility-docs branch August 16, 2026 01:21
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