Andrea Aime a écrit :
> Well, I have generated aggregated javadocs and noticed no problem, but 
> did not any about problems with custom taglets.
> Martin, can you point me to the custom taglet that was failing?


There is an example of the output I was trying to get:

http://javadoc.geotools.fr/snapshot/org/geotools/referencing/operation/DefaultMathTransformFactory.html

Scroll down just after the "Since" and "Authors" tags, before "Field Summary". 
We can see two new 
tags: "Tutorial" and "Module". "Tutorial" is a very simple taglet expecting (in 
the Java code 
source) the URL to the tutorial, and displaying in the Javadoc a clear title 
instead of the URL. It 
is basically just a convenient @see tag linking to the Geotools tutorial.

The "Module" tag is more interresting, and was a user request on the mailing 
list (the problem being 
that some users have a hard time to find in which JAR file a specific class is 
defined). The trick 
is to have the following in the class javadoc of all source files:

     @source $URL$

where $URL$ is automatically filled by SVN (so the information stay accurate 
even if we move the 
file around in SVN). The taglet performs some regular expression analysis on 
the URL in order to 
determine in which module this class live. The module name is then displayed, 
together with a link 
to Maven report for that module, etc.

Now there is the problem: this custom taglet is defined in gt/maven/javadoc. 
This module has the 
following dependencies:

     maven-script-ant
     maven-plugin-tools-ant

Version 2.0.4 for both of them. Those dependencies depend in turn on some older 
version of 
maven-plugin-resources.

The latest maven-plugin-javadoc depends on latest maven-plugin-resources. But 
latest 
maven-plugin-resources conflict with the maven-plugin-resources version 
expected by 
maven-plugin-tools-ant, thus resulting in a build failure in gt/maven/javadoc 
module.

The workaround was to stick to an older version of maven-plugin-javadoc. But 
doing so, we lost many 
of the enhancements provided in latest maven-plugin-javadoc. This is why large 
part of javadoc 
configuration are currently commented out in gt/pom.xml file. I would really 
like to uncomment them, 
since they includes usefull configuration like package grouping.

There is the possible action I can see right now:

* Check if an update of maven-plugin-tools-ant (more revent then 2.0.4)
   is available on ibiblio.

* Or, get ride completly of maven-plugin-tools-ant in maven/javadoc (after all
   we should not need it anymore if the standard "maven javadoc" work well 
enough).
   This means removing the xml Ant files from maven/javadoc, but keep the Taglet
   Java code.

* Need to find how to configure the javadoc plugin in the pom.xml file for
   using those taglets.

So in summary, the problem was a version conflict between the 
maven-plugin-resources expected by 
maven-plugin-javadoc and maven-plugin-tools-ant. But once solved, some 
adjustment may still be 
needed in the javadoc plugin configuration in the pom.xml file.

        Martin.


-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Geotools-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel

Reply via email to