Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 279010

Summary: Patch dojavadoc so that it can install multiple Javadoc trees
Product: Gentoo Linux Reporter: Jean-Noël Rivasseau (RETIRED) <elvanor>
Component: EclassesAssignee: Java team <java>
Status: CONFIRMED ---    
Severity: normal CC: alonbl, fordfrog, gentoo
Priority: High    
Version: unspecified   
Hardware: All   
OS: Linux   
Whiteboard:
Package list:
Runtime testing required: ---

Description Jean-Noël Rivasseau (RETIRED) gentoo-dev 2009-07-25 05:17:18 UTC
In the groovy package for instance there are 3 javadoc trees (one for the GDK, one regular for the Groovy API, and the last one is not really clear to me). Currently however only one tree can be installed.

The main question is: where should the different trees be installed? Normally javadocs always go to /usr/share/doc/${PF}/html. If several ones are to be installed, what directories should we use? Will it have an impact on tools that may be using the standard location (eg, IDEs for instances, although I don't know if currently any tools take advantage of Gentoo installed javadocs).
Comment 1 Alon Bar-Lev (RETIRED) gentoo-dev 2014-05-04 19:52:25 UTC
Need this too.
Comment 2 Volkmar W. Pogatzki 2024-02-04 08:32:03 UTC
Multi-jar packages can have multiple module-info.java files, one per each jar file, leading to "duplicate class" conflicts.
Comment 3 Miroslav Šulc gentoo-dev 2024-02-04 10:06:39 UTC
it might be probably better to create a separate package for the extra javadoc.

with multijar packages, the way to go is probably to use --module-source-path argument. it is described in this link: https://www.logicbig.com/tutorials/core-java-tutorial/modules/modes.html though it mentions javac, the same option also exist for javadoc command. what i didn't test is whether it generates just one tree combined from multiple modules.