<i18n dev> RFR: 8336039: Doccheck: HTML warnings, broken links and missing files in java.base documentation [v2]

Nizar Benalla nbenalla at openjdk.org
Fri Jul 19 13:08:06 UTC 2024


On Fri, 19 Jul 2024 12:44:47 GMT, Daniel Jeliński <djelinski at openjdk.org> wrote:

>> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   remove docroot based on review
>
> src/java.base/share/classes/java/util/concurrent/StructuredTaskScope.java line 1013:
> 
>> 1011:          * <p> Construction captures the current thread's {@linkplain ScopedValue scoped
>> 1012:          * value} bindings for inheritance by threads started in the task scope. The
>> 1013:          * <a href="{@docRoot}/java.base/java/util/concurrent/StructuredTaskScope.html#TreeStructure">Tree Structure</a> section in the class description
> 
> (untested, but should work)
> Suggestion:
> 
>          * {@linkplain StructuredTaskScope##TreeStructure Tree Structure} section in the class description

Fixed in [31649c7](https://github.com/openjdk/jdk/pull/20251/commits/31649c743e709cd67bd132774636e3484939890c), thanks.

> src/java.base/share/classes/javax/security/auth/Subject.java line 111:
> 
>> 109:  * input type and exceptions thrown are slightly different.
>> 110:  *
>> 111:  * <p><b><a id="sm-allowed">These methods behave differently depending on
> 
> Suggestion:
> 
>  * <p id="sm-allowed"><b>These methods behave differently depending on
> 
> We seem to mix `<p id` and `<p><a id` in our code, so both forms should work fine, and the `<p id` form seems to be a better fit here.

Fixed it, thanks. (I tried to not touch code beyond what was necessary for this PR)

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20251#discussion_r1684348983
PR Review Comment: https://git.openjdk.org/jdk/pull/20251#discussion_r1684349446


More information about the i18n-dev mailing list