Jody Garnett ha scritto:
>> The build/maven/javadoc plugin requires
>> some thought, it has that single taglet
>> that can be used to report in which module
>> the class appears in and a tool that can
>> be used to automate the insertion of the
>> taglet in the source code. Do we
>> want to keep it? Dunno. If we keep it
>> it would be a good idea to start using
>> it for good in all the codebase.
> 
> I had not heard of it before; the ability to list what is in which
> module is a common request on the user list; if we can generate a
> report for this information it would be good.
>

Agreed, thought requiring extra work and discipline
is not the way to go imho.
In general I would prefer any solution that has to
be worked on once and be done with it compared to
one that requires us to add a tag to every existing
_and every new_ source file in the source code base.

The taglet we have was discussed over 3 years ago
(with you, btw)
http://n2.nabble.com/2.2.RC0-planning%3A-would-like-a-%40source-javadoc-tag-in-every-.java-file-tc1944940.html#a1944944
so we already know what happens if you just ask
the devs to add it... over time, it simply does
not happen and it's forgotten about.

I have been thinking about a possible solution,
not much came out so far. In the past I wrote custom
doclets, but Doclet is in the com.sun package and
thus there is no guarantee we'll find it with another
JDK implementation.

Alternatively we could keep the @source taglet and
ask the releaser to run the tool to add the missing
tags on new files, might work but having performed
the releases I know the process it's already long
and frustrating without adding yet another step to it.

Maybe a simple search engine working on top of the
source files would do?

Otherwise, if anybody steps up, we could appoint
someone to perform this chore over the code base
every now and then, just like we have people
taking special care of IBM JDK.

Cheers
Andrea

------------------------------------------------------------------------------
Crystal Reports - New Free Runtime and 30 Day Trial
Check out the new simplified licensing option that enables 
unlimited royalty-free distribution of the report engine 
for externally facing server and web deployment. 
http://p.sf.net/sfu/businessobjects
_______________________________________________
Geotools-devel mailing list
Geotools-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geotools-devel

Reply via email to