Martin Desruisseaux wrote:
We currently have the following javadoc tag in every .java files (in
theory):
@version $Id$
Was not aware of that, I version that to mark the version of geotools
when class API was last modified
@since GeoTools 2.1
@version GeoTools 2.2
where $Id$ is a Subversion keyword. I would like to add the following
javadoc tag in every .java file too:
@source $URL$
where $URL$ is an other Subversion keyword.
Um should that not be set up as a @link or @seealso? When citing a url
javadoc already has a facility ....
All source file in the whole Geotools project would be affected, but
this addition need to be done only once. After that, $URL$ is managed
by Subversion in the same way than $Id$
There is a program in util that will visit ever source file, right now
it is set up to "fix" the headers, you could modify it to perform the
modification you suggest.
Why I would like that: it would allow us to create a small javadoc
taglet that automatically put, in every javadoc HTML pages, the module
name and the jar file where the documented class can been found.
Can I add "@source $URL$" in every file? (I would use some automatic
script that add just this line and change nothing else).
I don't have a problem with the idea, although you may succeed in
processing @see http://svn.geotools.org/... in the same manner -
and every class would get a link to the source code that makes it tick :-)
Thanks for looking into and caring about this stuff Martin, it is
seriously a great help.
Jody
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
_______________________________________________
Geotools-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel
