You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Denis McLaughlin <de...@nortelnetworks.com> on 2004/05/14 01:45:58 UTC

javadoc on generated source directories

Hi,

  We're generating some source into target/generate, and we'd like to run
javadoc on it.  Currently (RC1) javadoc is only run on the source in
pom.build.sourceDirectory.  Reading through the mailing list, I see that
after this thread:

http://nagoya.apache.org/eyebrowse/ReadMsg?listName=users@maven.apache.org&m
sgId=807588

  the javadoc plugin was changed to use the maven.compile.src.set variable
instead, and users could append additional directories to it to generate
javadoc for those directories.  However, this was changed between versions
1.15 and 1.16 of the javadoc plugin.jelly:

http://cvs.apache.org/viewcvs.cgi/maven-plugins/javadoc/plugin.jelly?r1=text
&tr1=1.15&r2=text&tr2=1.16&diff_format=u

  I think the right thing would be to have the javadoc plugin iterate across
the directories in maven.compile.src.set, generating a fileset tag for each
directory with appropriate exclusions.  Does this sound right?
Unfortunately, my attempts to do this the <j:forEach> tag brought nothing
but heartbreak and psoriasis.

  So, my questions:
 - should the javadoc plugin be using maven.compile.src.set rather than
pom.build.sourceDirectory?
 - if not, how should non-src/java directories have their javadoc created?
 - if so, can someone point me at some (any!) documentation for the forEach
tag?

  Many thanks... :)

Denis

Re: javadoc on generated source directories

Posted by di...@multitask.com.au.
"Denis McLaughlin" <de...@nortelnetworks.com> wrote on 14/05/2004 
09:45:58 AM:

> 
> Hi,
> 
>   We're generating some source into target/generate, and we'd like to 
run
> javadoc on it.  Currently (RC1) javadoc is only run on the source in
> pom.build.sourceDirectory.  Reading through the mailing list, I see that
> after this thread:
> 
> 
http://nagoya.apache.org/eyebrowse/ReadMsg?listName=users@maven.apache.org&m
> sgId=807588
> 
>   the javadoc plugin was changed to use the maven.compile.src.set 
variable
> instead, and users could append additional directories to it to generate
> javadoc for those directories.  However, this was changed between 
versions
> 1.15 and 1.16 of the javadoc plugin.jelly:
> 
> 
http://cvs.apache.org/viewcvs.cgi/maven-plugins/javadoc/plugin.jelly?r1=text
> &tr1=1.15&r2=text&tr2=1.16&diff_format=u

Yep, it looks like my addition of sourceModifications removed the src.set 
usage.

>   I think the right thing would be to have the javadoc plugin iterate 
across
> the directories in maven.compile.src.set, generating a fileset tag for 
each
> directory with appropriate exclusions.  Does this sound right?

Yes.

> Unfortunately, my attempts to do this the <j:forEach> tag brought 
nothing
> but heartbreak and psoriasis.
> 
>   So, my questions:
>  - should the javadoc plugin be using maven.compile.src.set rather than
> pom.build.sourceDirectory?
Yes.

>  - if not, how should non-src/java directories have their javadoc 
created?
>  - if so, can someone point me at some (any!) documentation for the 
forEach
> tag?

http://jakarta.apache.org/commons/jelly/tags.html

I'm happy to help with this if you get stuck or just want another pair of 
eyes on it, as once it's done for javadoc, we can apply it across the 
other plugins too.
--
dIon Gillard, Multitask Consulting


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org