Skip to content

Generate Javadoc cross-reference pages; use javadoc's "-use" option #1035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dsbos opened this issue Nov 29, 2014 · 4 comments
Closed

Generate Javadoc cross-reference pages; use javadoc's "-use" option #1035

dsbos opened this issue Nov 29, 2014 · 4 comments

Comments

@dsbos
Copy link

dsbos commented Nov 29, 2014

Please use the javadoc "-use" option to include class-use pages when generating the JUnit Javadoc documentation.

Having that index of back-links to uses of classes and interfaces can be extremely helpful.

(See
http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#use
and, for an example, see
the "USE" link at the top of
https://docs.oracle.com/javase/8/docs/api/java/security/MessageDigest.html
and its target page
https://docs.oracle.com/javase/8/docs/api/java/security/class-use/MessageDigest.html
.)

@marcphilipp
Copy link
Member

Sounds useful. Can you provide a pull request that adds it to the Maven build?

@Tibor17
Copy link
Contributor

Tibor17 commented Dec 6, 2014

The maven plugin has this option, but we did not set it to true in order to cover same result with the Ant script.

@npathai
Copy link
Contributor

npathai commented Dec 19, 2014

@marcphilipp I hope we had to achieve this using maven plugin. I have updated pom.xml with #1051

marcphilipp added a commit that referenced this issue Dec 21, 2014
PR to utilize 'use' option for cross-referencing javadoc pages #1035
@marcphilipp
Copy link
Member

Fixed by #1051.

@marcphilipp marcphilipp added this to the 4.13 milestone Dec 21, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants