Document AccessibilityRecord properties - #564
Conversation
Refs #246 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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.BeforeTextgetter/setter with Java reference links. - Documented
AccessibilityRecord.ClassNamegetter/setter with Java reference links. - Documented
AccessibilityRecord.ContentDescriptiongetter/setter with Java reference links.
Suppressed comments (2)
docs/xml/Android.Views.Accessibility/AccessibilityRecord.xml:473
- The setter link uses
java.lang.CharSequencein the URL, but the displayed<code>signature uses the unqualifiedCharSequence. 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.CharSequencein the URL, but the displayed<code>signature uses the unqualifiedCharSequence. Elsewhere in this file (e.g.,ClassNameFormatted) the displayed signature includesjava.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.
Refs #246 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
dalexsoto
left a comment
There was a problem hiding this comment.
The AccessibilityRecord property contracts and displayed signatures now match the platform and managed APIs, with the accepted generated-binding scope preserved.
Refs #246
Documents
AccessibilityRecord.BeforeText,ClassName, andContentDescriptionusing their Android getter and setter reference entries. Unsupported generated binding documentation remains untouched.Sources
Validation
docs/xml/Android.Views.Accessibility/AccessibilityRecord.xmlwithSystem.Xml.XmlDocument: passed.git diff --check: passed.To be added.indocs/xml/Android.Views.Accessibility/*.xml: 598 remain (3 inAccessibilityRecord.xml, including unsupported binding infrastructure and an unmodified parameter placeholder).