Adrian Custer a écrit :
> @source,@tutorial
>         Martin, we have made custom taglets for @source, @code,
>         @tutorial but only the @code seems to work. I made one of the
>         @source or @code copying the other, I believe it was the @code.
>         The difference appears to me to be that @code is an inline tag,
>         e.g. [EMAIL PROTECTED] whereas the other two are not. Does anyone have
>         ideas about how to get these working again?

As said in the previous mail, I believe (but I'm not sure) that the taglet API 
changed in an incompatible way betwen Java 1.4 and 1.5. Consequently it is 
possible that our custom taglets don't work at all with Java 1.4

One more possible explanation is that due to an other Maven javadoc plugin bug 
(http://jira.codehaus.org/browse/MPJAVADOC-77), only the last taglet declared 
in 
the <taglet> section is taken in account. All taglets declared before the last 
one are ignored. This bug is supposed to be fixed in the javadoc plugin 2.1, 
but 
the later is not yet released.


> 
>         For java 1.4, the @code and @source tags don't exist so it would
>         be great to take care of them ourselves through this taglet
>         mechanism. When we move to java 1.5, we can drop all but our
>         @tutorial taglet.

The @source tag doesn't exist in JSE 5 neither as far as I known (if there is a 
name clash with a Java 5 taglet name, we will need to change our @source tag 
name). This is probably the most useful custom taglet. Actually I wrote it du 
to 
a repeated demand on the user mailing list.


>         Since there are only 11 @tutorial tags, I'd like to drop these
>         from the javadocs unless we can fix the issue.


We can drop them, especially since I'm not sure that the tutorial URL are still 
valid (I believe that the wiki has been reorganized?). The easiest way is 
probably to add <tag>tutorial</tag> in the <tags> section, with 
<placement>Xt</placement>.

So in summary, issues with javadoc using Java 4 are:

    * [EMAIL PROTECTED]
    * [EMAIL PROTECTED] #ref}
    * all custom taglets

I realize that it is more convenient to create javadoc with the same JDK than 
the one used for building the JAR. However I was assuming that the JARs and the 
javadoc would be built in two separated steps (not the usual way Maven work, I 
admit) and that we may wish to use soon the Java 6 javadoc tools, given the 
improvement expected in this tool according JSR-260:

http://www.jcp.org/en/jsr/detail?id=260

I saw a prototype a while ago (I have been unable to find again the URL) where 
user can switch between "simplified" and "full" javadoc view of a class, where 
the "simplified" mode displays only the fields and methods marked as the most 
importants.

        Martin


        Martin

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys -- and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Geotools-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel

Reply via email to