Skip to content

Document NIO channel socket addresses - #419

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-java-nio-channels-apis
Open

Document NIO channel socket addresses#419
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-java-nio-channels-apis

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document the local and remote socket-address properties on DatagramChannel and SocketChannel, plus the local socket-address property on ServerSocketChannel.
  • Retain the unresolved binding-only placeholders for follow-up work; the scoped namespace still contains 406 To be added placeholders.

Sources

Validation

  • Parsed all three modified XML files with PowerShell's [xml] cast.
  • Ran git diff --check.
  • Confirmed docs/xml/index.xml is unchanged.

Refs #214

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

Updates the generated XML API documentation for Java.Nio.Channels to describe the local/remote socket-address properties on key NIO channel types, aligning the Xamarin/MonoAndroid docs with the Android reference behavior.

Changes:

  • Documented LocalAddress on SocketChannel, ServerSocketChannel, and DatagramChannel.
  • Documented RemoteAddress on SocketChannel and DatagramChannel.
  • Added direct links to the corresponding Android reference documentation pages in each updated member’s remarks.

Reviewed changes

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

File Description
docs/xml/Java.Nio.Channels/SocketChannel.xml Replaced placeholders for LocalAddress/RemoteAddress with real summaries/values and added Android reference links.
docs/xml/Java.Nio.Channels/ServerSocketChannel.xml Replaced placeholder for LocalAddress with bound-address documentation and added Android reference link.
docs/xml/Java.Nio.Channels/DatagramChannel.xml Replaced placeholders for LocalAddress/RemoteAddress with real summaries/values and added Android reference links.

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

Comment thread docs/xml/Java.Nio.Channels/SocketChannel.xml Outdated
Comment thread docs/xml/Java.Nio.Channels/DatagramChannel.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@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