Hi Arnaud, Thanks for doing this. I had a look at the patch (version 1.40 from CVS), and I have a couple questions.
To my reading, your patch uses a maven.compile.src.set property to track which directories should be traversed when generating javadocs. However, I believe maven.compile.src.set is used in other plugins as a path refid, and the property and path refid name spaces seem to be distinct: I can change the value of the maven.compile.src.set path without changing the value of the maven.compile.src.set property. I think it would be a good idea to have the maven.compile.src.set self-adjusting: any time a goal is run that generates code someplace other than src/java, then that goal should add that directory to maven.compile.src.set. That way any subsequent goal that needs to operate on all code (generated or otherwise) can just iterate across the directories in maven.compile.src.set. I believe this technique is already being used in the antlr and castor plugins: both of these plugins add directories to the maven.compile.src.set path refid. In my original patch, I had created a maven.javadoc.src.set property based on the maven.compile.src.set path refid, and used that to generate the javadoc filesets: this way it would pick up any additional directories that other goals had added. I believe your patch does things a bit differently. In your patch, the user is expected to set a maven.compile.src.set property with all the directories that the javadoc plugin should traverse to generate the docs. (Sorry if my shallow maven knowledge has led me to misunderstand this.) I don't think using a maven.compile.src.set property value (as it is in your patch) provides the same benefits as the maven.compile.src.set path refid. Users are bound to miss something if we make them add all the appropriate paths to the project.properties file: it may not be obvious to the user which directory is holding the generated code, and the directory may change from release to release of the plugin. It would be possible to work around this problem by expecting plugins to append paths to the maven.compile.src.set property, but this would just duplicate existing functionality (as mentioned, antlr and castor are already appending paths to the path refid), and holding multiple paths is really what path refids were intended for, I think, since they take care of figuring out the path separator and so on. Is there some value to using the maven.compile.src.set property rather than the path refid? Denis On Mon, 2004-05-24 at 01:18, Arnaud Heritier wrote: > It's done. I wrote a test case for maven.compile.src.set. > It works only if maven.compile.src.set is manually setted in the > project.properties. > In CVS I commented tests for this. > > Arnaud. > > > -----Message d'origine----- > > De : Dion Gillard [mailto:[EMAIL PROTECTED] > > Envoy� : dimanche 23 mai 2004 23:23 > > � : Maven Users List > > Objet : Re: javadoc on generated source directories > > > > How about coding a failing (at the moment) plugin test case that can > > be run on demand? > > > > On Sat, 22 May 2004 19:59:07 +0200, Arnaud Heritier > > <[EMAIL PROTECTED]> wrote: > > > > > > Hello Denis, > > > > > > I studied your patch and I modified the Javadoc plugin to allow the use > > of > > > maven.compile.src.set if you want to test. > > > > > > Arnaud > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
