Document Java.Net proxy types - #565
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and
a lite review from Copilot
August 15, 2026 15:00
jonathanpeppers
enabled auto-merge (squash)
August 15, 2026 15:00
There was a problem hiding this comment.
Pull request overview
This PR updates the XML documentation for Java.Net.Proxy.Type to replace placeholder text with Java SE 21–sourced descriptions and add member-level reference anchors for the enum constants and generated lookup methods.
Changes:
- Replaces placeholder
<summary>/<value>text forDirect,Http, andSockswith descriptive documentation. - Adds Java SE 21 reference links in
<remarks>for enum constants and forValueOf(string)/Values(). - Adds exception documentation for
ValueOf(string)and fills in missing<since>metadata.
Suppressed comments (4)
docs/xml/Java.Net/Proxy+Type.xml:101
- The member-level block for HTTP removes the usual AOSP/CC BY 2.5 attribution paragraph that appears throughout this file and other Java.* XML docs. Please keep that attribution alongside the new Oracle reference link for consistency/compliance.
<remarks>
<para>
<format type="text/html">
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Proxy.Type.html#HTTP" title="Reference documentation">Java documentation for <code>java.net.Proxy.Type.HTTP</code>.</a>
</format>
docs/xml/Java.Net/Proxy+Type.xml:168
- The SOCKS member’s now links to Oracle docs but no longer includes the standard AOSP/CC BY 2.5 attribution paragraph that remains on other members. Add the attribution paragraph back to keep the file consistent and avoid dropping licensing attribution text.
<remarks>
<para>
<format type="text/html">
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Proxy.Type.html#SOCKS" title="Reference documentation">Java documentation for <code>java.net.Proxy.Type.SOCKS</code>.</a>
</format>
docs/xml/Java.Net/Proxy+Type.xml:312
- The Values() method’s section drops the standard AOSP/CC BY 2.5 attribution paragraph that is still present throughout this file. Add the attribution paragraph back in addition to the Oracle reference link to keep documentation/licensing consistent.
<remarks>
<para>
<format type="text/html">
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Proxy.Type.html#values()" title="Reference documentation">Java documentation for <code>java.net.Proxy.Type.values()</code>.</a>
</format>
docs/xml/Java.Net/Proxy+Type.xml:270
- The ValueOf() method’s section no longer includes the standard AOSP/CC BY 2.5 attribution paragraph used elsewhere in this file and in similar Java.* docs (including ones that also link to Oracle docs). Please add the attribution paragraph back alongside the Oracle reference link.
<remarks>
<para>The string must match exactly an identifier used to declare an enum constant in this class. Extraneous whitespace characters are not permitted.</para>
<para>
<format type="text/html">
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Proxy.Type.html#valueOf(java.lang.String)" title="Reference documentation">Java documentation for <code>java.net.Proxy.Type.valueOf(java.lang.String)</code>.</a>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
requested review from
dalexsoto
and removed request for
dalexsoto
August 15, 2026 15:11
Member
Author
|
@dalexsoto review |
1 similar comment
Member
Author
|
@dalexsoto review |
dalexsoto
approved these changes
Aug 16, 2026
dalexsoto
left a comment
Member
There was a problem hiding this comment.
The Proxy.Type contracts, links, and required attribution are complete and consistent with the managed and platform APIs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sources
Validation
Refs #232