<Swing Dev> Code review request for trivial doc fix: "@throws" meant instead of "@throw"

Joseph D. Darcy Joe.Darcy at Sun.COM
Thu Aug 27 04:16:21 UTC 2009


Hello.

While doing some other doc work, I noticed two javadoc build warnings 
from mistyped tags in two swing classes; in both cases "@throw" was 
written instead of "@throws".  The classes already document the 
exceptional behavior in the methods' main specification.  I'd like to 
commit the trivial fix below into JDK 7 through the TL repo and I'll 
file a bug, etc. after the fix is approved.

Thanks,

-Joe

--- old/src/share/classes/javax/swing/text/ParagraphView.java    
2009-08-26 20:59:31.000000000 -0700
+++ new/src/share/classes/javax/swing/text/ParagraphView.java    
2009-08-26 20:59:30.000000000 -0700
@@ -716,7 +716,7 @@
      * @param axis  the minor axis
      * @param r     the input {@code SizeRequirements} object
      * @return      the new or adjusted {@code SizeRequirements} object
-     * @throw IllegalArgumentException  if the {@code axis} parameter 
is invalid
+     * @throws IllegalArgumentException  if the {@code axis} parameter 
is invalid
      */
     @Override
     protected SizeRequirements calculateMinorAxisRequirements(int axis,
--- old/src/share/classes/javax/swing/text/html/ParagraphView.java    
2009-08-26 20:59:31.000000000 -0700
+++ new/src/share/classes/javax/swing/text/html/ParagraphView.java    
2009-08-26 20:59:31.000000000 -0700
@@ -150,7 +150,7 @@
      * @param axis  the minor axis
      * @param r     the input {@code SizeRequirements} object
      * @return      the new or adjusted {@code SizeRequirements} object
-     * @throw IllegalArgumentException  if the {@code axis} parameter 
is invalid
+     * @throws IllegalArgumentException  if the {@code axis} parameter 
is invalid
      */
     protected SizeRequirements calculateMinorAxisRequirements(
                                                 int axis, 
SizeRequirements r) {




More information about the swing-dev mailing list