[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[cp-patches] FYI: API doc fixes in javax.swing.*
From: |
David Gilbert |
Subject: |
[cp-patches] FYI: API doc fixes in javax.swing.* |
Date: |
Sat, 23 Jul 2005 20:48:58 +0000 |
User-agent: |
Mozilla Thunderbird 1.0.2 (X11/20050426) |
I committed this patch:
2005-07-23 David Gilbert <address@hidden>
* javax/swing/ImageIcon.java: API doc fixes,
* javax/swing/JLayeredPane.java: likewise,
* javax/swing/JSplitPane.java: likewise,
* javax/swing/JTree.java: likewise,
* javax/swing/JViewport.java: likewise,
* javax/swing/RepaintManager.java: likewise,
* javax/swing/SizeRequirements.java: likewise,
* javax/swing/SortingFocusTraversalPolicy.java.
Regards,
Dave Gilbert
Index: javax/swing/ImageIcon.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/ImageIcon.java,v
retrieving revision 1.16
diff -u -r1.16 ImageIcon.java
--- javax/swing/ImageIcon.java 2 Jul 2005 20:32:47 -0000 1.16
+++ javax/swing/ImageIcon.java 23 Jul 2005 19:42:05 -0000
@@ -338,9 +338,9 @@
*
* @return the load status of the icon image
*
- * @see address@hidden MediaTracker.COMPLETE}
- * @see address@hidden MediaTracker.ABORTED}
- * @see address@hidden MediaTracker.ERRORED}
+ * @see MediaTracker#COMPLETE
+ * @see MediaTracker#ABORTED
+ * @see MediaTracker#ERRORED
*/
public int getImageLoadStatus()
{
Index: javax/swing/JLayeredPane.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JLayeredPane.java,v
retrieving revision 1.24
diff -u -r1.24 JLayeredPane.java
--- javax/swing/JLayeredPane.java 20 Jul 2005 09:46:33 -0000 1.24
+++ javax/swing/JLayeredPane.java 23 Jul 2005 19:42:06 -0000
@@ -39,6 +39,7 @@
package javax.swing;
import java.awt.Component;
+import java.awt.Container;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.Map;
@@ -57,13 +58,13 @@
* <dd>The layer where most of the normal components are placed. This
* is the bottommost layer.</dd>
*
- * <dt>address@hidden #PALETTE_LAYER</dt>
+ * <dt>address@hidden #PALETTE_LAYER}</dt>
* <dd>Palette windows are placed in this layer.</dd>
*
* <dt>address@hidden #MODAL_LAYER}</dt>
* <dd>The layer where internal modal dialog windows are placed.</dd>
*
- * <dt>address@hidden #POPUP_LAYER</dt>
+ * <dt>address@hidden #POPUP_LAYER}</dt>
* <dd>The layer for popup menus</dd>
*
* <dt>address@hidden #DRAG_LAYER}</dt>
@@ -81,7 +82,8 @@
* </p>
*
* <p>To change the layer of a component that is already a child of
- * a <code>JLayeredPane</code>, use the address@hidden #setLayer} method.</p>
+ * a <code>JLayeredPane</code>, use the address@hidden #setLayer(Component,
int)}
+ * method.</p>
*
* <p>The purpose of this class is to translate this view of "layers" into a
* contiguous array of components: the one held in our ancestor,
@@ -304,7 +306,7 @@
* @param c the component to move to the front of its layer.
* @throws IllegalArgumentException if the component is not a child of
* this container.
- * @see #moveToBack()
+ * @see #moveToBack
*/
public void moveToFront(Component c)
{
@@ -323,7 +325,7 @@
* @param c the component to move to the back of its layer.
* @throws IllegalArgumentException if the component is not a child of
* this container.
- * @see #moveToFront()
+ * @see #moveToFront
*/
public void moveToBack(Component c)
{
@@ -338,7 +340,7 @@
* @param c the component to get the position of.
* @throws IllegalArgumentException if the component is not a child of
* this container.
- * @see #setPosition()
+ * @see #setPosition
*/
public int getPosition(Component c)
{
@@ -365,7 +367,7 @@
* @param position the position to assign the component to.
* @throws IllegalArgumentException if the component is not a child of
* this container.
- * @see #getPosition()
+ * @see #getPosition
*/
public void setPosition(Component c, int position)
{
Index: javax/swing/JSplitPane.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JSplitPane.java,v
retrieving revision 1.6
diff -u -r1.6 JSplitPane.java
--- javax/swing/JSplitPane.java 2 Jul 2005 20:32:49 -0000 1.6
+++ javax/swing/JSplitPane.java 23 Jul 2005 19:42:06 -0000
@@ -66,8 +66,6 @@
/**
* Creates a new AccessibleJSplitPane object.
- *
- * @param value0 DOCUMENT ME!
*/
protected AccessibleJSplitPane()
{
Index: javax/swing/JTree.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JTree.java,v
retrieving revision 1.30
diff -u -r1.30 JTree.java
--- javax/swing/JTree.java 12 Jul 2005 19:26:41 -0000 1.30
+++ javax/swing/JTree.java 23 Jul 2005 19:42:08 -0000
@@ -1729,8 +1729,8 @@
*
* @param prefix the prefix to search for in the cell values
* @param startingRow the index of the row where to start searching from
- * @param bias the search direction, either address@hidden
Position.Bias.Forward} or
- * address@hidden Position.Bias.Backward}
+ * @param bias the search direction, either address@hidden
Position.Bias#Forward} or
+ * address@hidden Position.Bias#Backward}
*
* @return the path to the found element or -1 if no such element has
been
* found
@@ -1802,7 +1802,7 @@
* it will be removed too.
*
* @param path the path from which selected descendants are to be
removed
- * @param includePath if <code>true</code> then <code>path</code> itself
+ * @param includeSelected if <code>true</code> then <code>path</code>
itself
* will also be remove if it's selected
*
* @return <code>true</code> if something has been removed,
Index: javax/swing/JViewport.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JViewport.java,v
retrieving revision 1.21
diff -u -r1.21 JViewport.java
--- javax/swing/JViewport.java 2 Jul 2005 20:32:49 -0000 1.21
+++ javax/swing/JViewport.java 23 Jul 2005 19:42:09 -0000
@@ -89,7 +89,7 @@
*
* <p>But in terms of drawing its child, the viewport thinks of itself as
* covering a particular position <em>of the view's coordinate space</em>.
- * For example, the address@hidden javax.JViewPort.getViewPosition} method
returns
+ * For example, the address@hidden #getViewPosition} method returns
* the position <code>(VX,VY)</code> shown above, which is an position in
* "view space", even though this is <em>implemented</em> by positioning
* the underlying child at position <code>(-VX,-VY)</code></p>
Index: javax/swing/RepaintManager.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/RepaintManager.java,v
retrieving revision 1.12
diff -u -r1.12 RepaintManager.java
--- javax/swing/RepaintManager.java 2 Jul 2005 20:32:49 -0000 1.12
+++ javax/swing/RepaintManager.java 23 Jul 2005 19:42:10 -0000
@@ -42,6 +42,7 @@
import java.awt.Dimension;
import java.awt.Image;
import java.awt.Rectangle;
+import java.awt.image.VolatileImage;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Hashtable;
@@ -72,7 +73,7 @@
* typically only one of these objects active at any time. When the
* address@hidden RepaintManager} is told to queue a repaint, it checks to
see if
* a address@hidden RepaintWorker} is "live" in the system event queue, and
if
- * not it inserts one using address@hidden SwingUtilities.invokeLater}.</p>
+ * not it inserts one using address@hidden SwingUtilities#invokeLater}.</p>
*
* <p>When the address@hidden RepaintWorker} comes to the head of the system
* event queue, its address@hidden RepaintWorker#run} method is executed by
the
@@ -235,7 +236,7 @@
*
* @param manager The new value of the shared instance
*
- * @see #currentManager
+ * @see #currentManager(JComponent)
*/
public static void setCurrentManager(RepaintManager manager)
{
@@ -501,7 +502,7 @@
*
* @since 1.4
*
- * @see address@hidden VolatileImage}
+ * @see VolatileImage
*/
public Image getVolatileOffscreenBuffer(Component comp, int proposedWidth,
int proposedHeight)
@@ -542,7 +543,7 @@
*
* @param buffer The new value of the property
*
- * @see #getDoubleBufferingEnabled
+ * @see #isDoubleBufferingEnabled
*/
public void setDoubleBufferingEnabled(boolean buffer)
{
Index: javax/swing/SizeRequirements.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/SizeRequirements.java,v
retrieving revision 1.9
diff -u -r1.9 SizeRequirements.java
--- javax/swing/SizeRequirements.java 2 Jul 2005 20:32:49 -0000 1.9
+++ javax/swing/SizeRequirements.java 23 Jul 2005 19:42:10 -0000
@@ -295,7 +295,6 @@
* @param allocated the amount of allocated space
* @param total the total size requirements of the components
* @param children the size requirement of each component
- * @param offsets will hold the offset values for each component
* @param spans will hold the span values for each component
* @param forward whether the components should be placed in the forward
* direction (left-right or top-bottom) or reverse direction
Index: javax/swing/SortingFocusTraversalPolicy.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/swing/SortingFocusTraversalPolicy.java,v
retrieving revision 1.4
diff -u -r1.4 SortingFocusTraversalPolicy.java
--- javax/swing/SortingFocusTraversalPolicy.java 2 Jul 2005 20:32:49
-0000 1.4
+++ javax/swing/SortingFocusTraversalPolicy.java 23 Jul 2005 19:42:11
-0000
@@ -89,7 +89,7 @@
* Creates a new <code>SortingFocusTraversalPolicy</code> with the given
* comparator set.
*
- * @param the comparator to set
+ * @param comparator the comparator to set
*/
public SortingFocusTraversalPolicy(Comparator comparator)
{
@@ -306,12 +306,12 @@
}
/**
- * Return the current value of the address@hidden implicitDownCycleTraversal}
+ * Return the current value of the address@hidden
#implicitDownCycleTraversal}
* property.
*
* @return the current value of the property
*
- * @see setImplicitDownCycleTraversal
+ * @see #setImplicitDownCycleTraversal
*/
public boolean getImplicitDownCycleTraversal()
{
@@ -319,12 +319,12 @@
}
/**
- * Set the current value of the address@hidden implicitDownCycleTraversal}
+ * Set the current value of the address@hidden #implicitDownCycleTraversal}
* property.
*
* @param down the new value of the property
*
- * @see getImplicitDownCycleTraversal
+ * @see #getImplicitDownCycleTraversal
*/
public void setImplicitDownCycleTraversal(boolean down)
{
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [cp-patches] FYI: API doc fixes in javax.swing.*,
David Gilbert <=