Skip to content

Document Java reflection annotation APIs - #577

Open
jonathanpeppers wants to merge 1 commit into
mainfrom
jonathanpeppers-document-java-reflection
Open

Document Java reflection annotation APIs#577
jonathanpeppers wants to merge 1 commit 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>

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 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.

File Description
docs/xml/Java.Lang.Reflect/Parameter.xml Documents Parameter’s annotation querying APIs by replacing placeholder param/summary/returns and improving remarks.
docs/xml/Java.Lang.Reflect/AccessibleObject.xml Documents 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
Member Author

@dalexsoto review

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.

2 participants