Javadoc fails on aggregator modules
Jonathan Gibbons
jonathan.gibbons at oracle.com
Tue Jan 2 19:54:33 UTC 2024
On 1/2/24 10:20 AM, Jonathan Gibbons wrote:
>
>
> On 1/2/24 10:17 AM, Jonathan Gibbons wrote:
>>
>>
>> On 12/27/23 12:10 PM, Ethan McCue wrote:
>>> For projects which contain only a module-info that transitively
>>> requires other modules - i.e. like java.se <http://java.se> - the
>>> javadoc tool will fail.
>>>
>>> This presents a problem for publishing those sorts of artifacts to
>>> Maven Central, which requires some javadoc jar in order to publish.
>>> The only workaround i've found is to go into the build tool, skip
>>> normal javadoc generation, and do it through a hacked script.
>>>
>>> Is there a workaround I am missing, is this an intentional
>>> deficiency, or is this something that should be fixed?
>>
>> Hi Ethan,
>>
>> Thanks for the report. This is for sure not an intentional deficiency!
>>
>> This needs to be investigated and fixed as appropriate.
>>
>> -- Jon
>>
>
> https://bugs.openjdk.org/browse/JDK-8322865
>
>
Ethan,
There is a partial/imperfect workaround.
When you list the source files explicitly, you get an (inappropriate)
error about no classes found to document. You can workaround that issue
by using a combination of setting the source path (with either
`--source-path` or `--module-source-path`) and specifying the module
(with --module). With that combination, you can get past the "no
classes found" message, and javadoc will generate a full set of files,
including the files for the module in question .... but ... it appears
there's a bug in the top-level `index.html` page that is generated, and
which should redirect to the module page. Instead, it redirects to
itself. That is in itself a bug.
-- Jon
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/javadoc-dev/attachments/20240102/64d027a7/attachment.htm>
More information about the javadoc-dev
mailing list