Alternative output directory for javadocs
Hey list! I'm trying to change the output directory for the generated javadocs from /apidocs to something like /api. According to the plugin documentation[1] this is easily achieved by specifying an alternative destDir. However when I'm using the alternative directory (name doesn't matter) the test documentation will not be created giving the following info: [INFO] Skipped Test JavaDocs report, file api/index.html already exists for the English version. The page mentioned at [1] talks about testDestDir as the way to specify the test javadoc location but the configuration option is missing from the javadoc:javadoc and javadoc:test-javadoc goals and thus does not work. Apart from that it labels the generated javadoc report for the main sources as Test JavaDocs but links to the main javadoc at (in my case) /api. So how do you specify alternative output directories for javadocs? Any help on that is appreciated :-) Greets, Sebastian P.S.: I'm using version 2.6.1 of the javadoc plugin and maven version 2.2.1. [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/output-configuration.html - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: Alternative output directory for javadocs
On Fri, 20 Nov 2009 11:48:09 +0100 Sebastian Hoß m...@shoss.de wrote: Hey list! .. So how do you specify alternative output directories for javadocs? Any help on that is appreciated :-) Ah well, I've done it: Using reportSets you can specify the destDir for the javadoc:javadoc goal and the javadoc:test-javadoc goal independently [1]. So I ended up with something like this: plugin groupIdorg.apache.maven.plugins/groupId artifactIdmaven-javadoc-plugin/artifactId version2.6.1/version reportSets reportSet idmain-html/id configuration destDirapi/destDir /configuration reports reportjavadoc/report /reports /reportSet reportSet idtest-html/id configuration destDirtestapi/destDir /configuration reports reporttest-javadoc/report /reports /reportSet /reportSets /plugin That gives me the desired result but I still think that the plugin documentation mentioned in my last mail is wrong.. [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/test-javadocs.html - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: Alternative output directory for javadocs
The example from the website worked fine for me, it placed the javadocs into an alternative directory, though maybe I didn't understand what exactly you're trying to archive. Regards, Csaba Sebastian Hoß wrote: On Fri, 20 Nov 2009 11:48:09 +0100 Sebastian Hoß m...@shoss.de wrote: Hey list! .. So how do you specify alternative output directories for javadocs? Any help on that is appreciated :-) Ah well, I've done it: Using reportSets you can specify the destDir for the javadoc:javadoc goal and the javadoc:test-javadoc goal independently [1]. So I ended up with something like this: plugin groupIdorg.apache.maven.plugins/groupId artifactIdmaven-javadoc-plugin/artifactId version2.6.1/version reportSets reportSet idmain-html/id configuration destDirapi/destDir /configuration reports reportjavadoc/report /reports /reportSet reportSet idtest-html/id configuration destDirtestapi/destDir /configuration reports reporttest-javadoc/report /reports /reportSet /reportSets /plugin That gives me the desired result but I still think that the plugin documentation mentioned in my last mail is wrong.. [1]: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/test-javadocs.html - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: Alternative output directory for javadocs
On Fri, 20 Nov 2009 12:03:26 +0100 Gajo Csaba csaba.g...@cosylab.com wrote: The example from the website worked fine for me, it placed the javadocs into an alternative directory, though maybe I didn't understand what exactly you're trying to archive. Well I simply wanted to change the default javadoc location. Using the example from the website gave me two problems: 1) No test javadocs were generated (no javadocs for the code under /test) 2) The main javadocs were placed in the correct directory but the link pointing to them had the wrong label. It said Test JavaDocs but should have JavaDocs. In my last mail I explained the workaround I found for these problems. Is that any clearer? :-) - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
