On Mon, 13 Apr 2026 15:19:30 GMT, James Nord <[email protected]> wrote:

>> The [existing 
>> documentation](https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/net/URL.html#constructor-deprecation)
>>  when rendered was hard to read as the entire string was in a `pre` and 
>> rendered in the same font.  Coupled with the fact the the first URL would 
>> contain a space this made it hard to scan as you had no visual clues and had 
>> to backtrack to re-read what the sentence was trying to say.
>> 
>> Switch to using inline definition using {@code} and swapped the order so 
>> that the string without spaces came first negating any need for back 
>> tracking when scanning
>
> James Nord has updated the pull request with a new target base due to a merge 
> or a rebase. The incremental webrev excludes the unrelated changes brought in 
> by the merge/rebase. The pull request contains three additional commits since 
> the last revision:
> 
>  - 8381184: incorporate feedback
>  - Merge remote-tracking branch 'origin/master' into patch-2
>  - make the reading of URL encoding issues easier to read
>    
>    The existing documentation when rendered was hard to read for a as the 
> entire string was in a pre and rendered in the same font.  Coupled with the 
> fact the the first URL would contain a space this made it hard to scan as you 
> had no visual clues and had to backtrack to re-read what the sentence was 
> trying to say.
>    
>    Switch to using inline definition using {@code} and swapped the order so 
> that the string without spaces came first negating any need for back tracking 
> when scanning

src/java.base/share/classes/java/net/URL.java line 573:

> 571:      * RFC&nbsp;2396 &quot;Uniform Resource Identifiers : Generic 
> Syntax&quot; :
> 572:      * {@snippet lang="text" :
> 573:      *          <scheme>://<authority><path>?<query>#<fragment>

I have not been able to build the javadoc to validate that this is actually 
going to be correct and not interpreted as an (invalid or otherwise) markup 
comment.  

Any advice on how to build the javadoc without a full C++ development 
environment will be gratefully received.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/30074#discussion_r3073972620

Reply via email to