[crac] RFR: 8346386: [CRaC] Move CRaC’s Java code out of restricted packages [v2]
Timofei Pushkin
duke at openjdk.org
Wed Dec 18 10:04:57 UTC 2024
On Tue, 17 Dec 2024 16:25:29 GMT, Radim Vansa <rvansa at openjdk.org> wrote:
>> No, just swapping `jdk.internal.crac.mirror` with `jdk.crac` here does not work: javadoc complains that it cannot find the reference. I am not sure how to create inter-module links, there is `{@link java.logging/java.util.logging.Logger java.util.logging.Logger}` syntax in this file which successfully links to another module but using `jdk.crac/jdk.crac` does not work.
>>
>> The current `jdk.internal.crac.mirror` also creates no link, probably because no docs are generated for this package. There is no error, just no hyperlink in the resulting HTML.
>
>> The current jdk.internal.crac.mirror also creates no link, probably because no docs are generated for this package.
>
> It's expected that there's no docs for `jdk.internal.crac.mirror`; it should not be exposed, neither from code nor from docs. If you can't get links to `jdk.crac` work correctly you could fallback to just `{@code ...}`. The correctness of the information for users has priority over the form.
Added a fix, turned out no docs were being built at all for the new module. After fixing that just changing the package to `jdk.crac` starting working but I used the more verbose `jdk.crac/jdk.crac.Something` syntax anyway to be inline with the rest of inter-module links in the file.
-------------
PR Review Comment: https://git.openjdk.org/crac/pull/164#discussion_r1889960480
More information about the crac-dev
mailing list