Adrian Custer a écrit : > I am using the javadoc @author tags to store provenance information. > This is all right because, as stated in the @author section of > http://java.sun.com/j2se/javadoc/writingdoccomments/ which states: > > "The @author tag is not critical, because it is not included > when generating the API specification, and so it is seen only > by those viewing the source code. (Version history can also be > used for determining contributors for internal purposes.)"
The javadoc @author tag is not used by default, but it is used if we turn it on by passing the "-author" option to the javadoc tool. This is what we do for Geotools javadoc, see for example: http://javadoc.geotools.fr/snapshot/org/geotools/referencing/CRS.html If we make the @javadoc tag too verbose, the HTML output may become difficult to read. However if we want something formal, we could defines an explit @Author annotation with explicit fields for the physical author, original copyright holder and the grant mode. It should be relatively easy to do and we could probably use some script for adding automatically this annotation in from of every existing class using the informations currently provided in @author tags. Martin ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Geotools-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-devel
