Skip to content

Document Java reflection annotation APIs - #577

Merged
jonathanpeppers merged 5 commits into
mainfrom
jonathanpeppers-document-java-reflection
Aug 18, 2026
Merged

Document Java reflection annotation APIs#577
jonathanpeppers merged 5 commits into
mainfrom
jonathanpeppers-document-java-reflection

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

Documents the AnnotatedElement annotation-querying APIs implemented by Java.Lang.Reflect.Parameter and Java.Lang.Reflect.AccessibleObject.

Refs #197

Sources

Validation

  • Parsed both edited XML files with PowerShell's XML parser.
  • Confirmed CRLF line endings and git diff --check.
  • Confirmed all seven documented annotation-querying members in each type have no To be added placeholders; scoped placeholder count changed from 193 to 156.

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

CopilotAI 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 quality of the generated API reference documentation for Java.Lang.Reflect by replacing placeholder XML documentation with real descriptions for the AnnotatedElement-style annotation querying APIs on Java.Lang.Reflect.Parameter and Java.Lang.Reflect.AccessibleObject.

Changes:

  • Replaced To be added placeholders with real <summary>, <returns>, and <param> docs for annotation-querying members on Parameter.
  • Replaced To be added / incorrect placeholder summaries with real <summary>, <returns>, and <param> docs for annotation-querying members on AccessibleObject.
  • Added/expanded remarks where helpful (including the annotation presence equivalence note), while keeping the Android reference links and required attribution paragraphs.

Reviewed changes

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

FileDescription
docs/xml/Java.Lang.Reflect/Parameter.xmlDocuments Parameter’s annotation querying APIs by replacing placeholder param/summary/returns and improving remarks.
docs/xml/Java.Lang.Reflect/AccessibleObject.xmlDocuments AccessibleObject’s annotation querying APIs by replacing placeholder param/summary/returns and clarifying IsAnnotationPresent.

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

@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto 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 new Parameter#isAnnotationPresent reference points to a nonexistent anchor because the inherited detail lives on AnnotatedElement. Please link to java/lang/reflect/AnnotatedElement#isAnnotationPresent(...) and update the displayed type name: Parameter.xml.

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

Copy link
Copy Markdown
MemberAuthor

@dalexsoto Addressed in f4ced12: the Parameter.IsAnnotationPresent reference now links to and displays java.lang.reflect.AnnotatedElement.isAnnotationPresent(...), where Android publishes the inherited method detail.

@dalexsotodalexsoto 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 inherited annotation link is fixed, but all newly added <em> elements render as literal XML because ECMA2Yaml supports <i> but has no <em> transform. Please replace the 22 added <em> elements with <i> or plain text and verify the generated pages.

jonathanpeppersand others added 2 commits August 17, 2026 15:07
…flection' into jonathanpeppers-fix-pr-577-markup
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

jonathanpeppers commented Aug 17, 2026

Copy link
Copy Markdown
MemberAuthor

Fixed in 3f9d742: replaced all 22 newly added <em> elements with ECMA2Yaml-supported <i> elements. Both XML files parse successfully, retain CRLF-only line endings, contain no remaining <em> elements, and pass git diff --check. OpenPublishing.Build also passed, confirming generated-page compatibility.

@dalexsotodalexsoto 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 inherited annotation links and supported italic markup now generate correctly, and the reflection contracts match Android.

@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto 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 main merge preserves all previously reviewed reflection contracts, links, supported markup, and generated output.

@jonathanpeppers
jonathanpeppers merged commit 988691a into mainAug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-document-java-reflection branch August 18, 2026 19:32
Sign up for freeto 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

@jonathanpeppers@dalexsoto