• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

Maven - javadoc

 
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hello all,

Bit of a newb here. Am using the javadoc plugin within Maven, and I can generate the javadocs from within each separate package. However, there are quite a few of these.

Question: is there an easy way to generate the javadocs for all packages from the base directory (or trunk)? I'm guessing I may have to specify which packages to include, perhaps in an XML file somewhere. Can anyone kindly shed some light on this? Thankya
 
Alejandro Soini
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
...just to clarify a little further, the project is a maven multiproject, with other sub-projects. still trying to find a way to generate javadocs for all packages in one attempt.
 
Alejandro Soini
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
i found the solution, but it seems to have created a new problem. in running:

maven multiproject:goal -Dgoal=javadoc

from the base directory, it creates all the javadocs for the sub-projects. however, the APIs are still separated from other packages. is there a way to get one level up to list all the packages from all subprojects?
 
Ranch Hand
Posts: 1209
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I think you have to write a custom goal to achieve this.
Use ant's javadoc when writing your custom goal and supply source files from all the sub projects. You will be required to iterate through the 'compile source set' of every sub project and feed it to ant's javadoc task. You will probably need a classpath reference too at the minimal. Then you might have to iterate through dependencies of each of the sub project as well. Refer to ant's javadoc task and try supplying the *required* attributes first and see how it goes. I know its easier said than done. But you will get to know a little bit about maven internals .
[ November 28, 2005: Message edited by: Karthik Guru ]
 
Alejandro Soini
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thank you Karthik. I will give it a try.
 
We find this kind of rampant individuality very disturbing. But not this tiny ad:
a bit of art, as a gift, the permaculture playing cards
https://gardener-gift.com
reply
    Bookmark Topic Watch Topic
  • New Topic