Generate Javadoc HTML using maven?

Question

Right now I am using the maven-javadoc-plugin to attach the Javadoc to .jar artifacts when I am doing a release.

However, how can I generate the Javadoc in an html format so we can scp it to a remote server for reference?

Thanks!

score 90 · Accepted Answer · edited Jun 02 '20 at 17:21

90

Using the same plugin, you can generate javadoc in a folder using

mvn javadoc:javadoc

It puts the help content under target/site/apidocs

You can change the output folder by using the plugin configuration parameter reportOutputDirectory

Please refer to:

edited Jun 02 '20 at 17:21

Manuel Jordan

answered Apr 02 '12 at 05:26

krishnakumarp

1

What if I want to generate the javadocs when i execute `clean install` command. I am currently trying that, but the java docs are not getting generated on Clean install. I am using `javadoc:javadoc package` – AnirbanDebnath Apr 19 '16 at 10:35

score 15 · Answer 2 · edited Apr 15 '14 at 10:30

15

if you are interested in just doing it raw, you could use the following command.

javadoc -d C:/javadoc/test com.mypackage

edited Apr 15 '14 at 10:30

SysDragon

answered Apr 15 '14 at 10:10

Vinod Bhan

1

you are right, somethings are so easy and maven make us believe that everything is so complex tha twe need maven in situations that are quite trivial! – MadMad666 Jun 26 '15 at 20:51
5

y'all need to use ant for a a half-complex build process, then tell me maven's vile. maven is a life-saver and i, for one, welcome my xml-based overlords – liltitus27 Jul 28 '16 at 13:58

2 Answers2