Skip to content

Document Java.Net proxy types - #565

Merged
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-java-net-xml-docs
Aug 16, 2026
Merged

Document Java.Net proxy types#565
jonathanpeppers merged 2 commits into
mainfrom
jonathanpeppers-java-net-xml-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Documents the Java-facing Proxy.Type enum constants and generated lookup methods.
  • Replaces scoped placeholder documentation with Java SE 21 source-backed text and member-level anchors.

Sources

Validation

  • git diff --check`n- XML parsing
  • CRLF-only line endings
  • Scoped placeholder count: 0

Refs #232

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 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 for Direct, Http, and Socks with descriptive documentation.
  • Adds Java SE 21 reference links in <remarks> for enum constants and for ValueOf(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.

Comment thread docs/xml/Java.Net/Proxy+Type.xml
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 15:11
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

1 similar comment
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto 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 Proxy.Type contracts, links, and required attribution are complete and consistent with the managed and platform APIs.

@jonathanpeppers
jonathanpeppers merged commit a89ce18 into main Aug 16, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-java-net-xml-docs branch August 16, 2026 01:22
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.

3 participants