Approved. Thanks for getting rid of this warning that has nagged engineers for years now!
Martin On Tue, Aug 25, 2009 at 18:47, Joe Darcy<[email protected]> wrote: > Hello. > > While making some other doc changes, I noticed that a javadoc build warning > generated for java.util.Properties: > >> ../../src/share/classes/java/util/Properties.java:116: warning - Tag @see: >> missing final '>': "<a >> href="../../../technotes/tools/windows/native2ascii.html">native2ascii tool >> for Windows</a> >> >> <p>This class is thread-safe: multiple threads can share a single >> <tt>Properties</tt> object without the need for external synchronization." > > could be removed if the @see tags were moved to the convention position > after the text of the main comment: > > --- old/src/share/classes/java/util/Properties.java 2009-08-25 > 18:44:26.000000000 -0700 > +++ new/src/share/classes/java/util/Properties.java 2009-08-25 > 18:44:26.000000000 -0700 > @@ -101,12 +101,12 @@ > * <!ATTLIST entry key CDATA #REQUIRED> > * </pre> > * > - * @see <a > href="../../../technotes/tools/solaris/native2ascii.html">native2ascii tool > for Solaris</a> > - * @see <a > href="../../../technotes/tools/windows/native2ascii.html">native2ascii tool > for Windows</a> > - * > * <p>This class is thread-safe: multiple threads can share a single > * <tt>Properties</tt> object without the need for external synchronization. > * > + * @see <a > href="../../../technotes/tools/solaris/native2ascii.html">native2ascii tool > for Solaris</a> > + * @see <a > href="../../../technotes/tools/windows/native2ascii.html">native2ascii tool > for Windows</a> > + * > * @author Arthur van Hoff > * @author Michael McCloskey > * @author Xueming Shen > > > The build warning is arguably spurious since the @see tag is properly > formed, but since following conventions is recommended I think the change is > fine. > > -Joe >
