[cp-patches] FYI: API doc fixes in javax.swing.tree.*

[David Gilbert]

I committed this patch:

2005-07-22  David Gilbert  <address@hidden>

        * javax/swing/tree/AbstractLayoutCache.java: API doc fixes,
        * javax/swing/tree/DefaultTreeCellRenderer.java: likewise,
        * javax/swing/tree/DefaultTreeModel.java: likewise,
        * javax/swing/tree/FixedHeightLayoutCache: likewise.

Regards,

Dave Gilbert

Index: javax/swing/tree/AbstractLayoutCache.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/tree/AbstractLayoutCache.java,v
retrieving revision 1.6
diff -u -r1.6 AbstractLayoutCache.java
--- javax/swing/tree/AbstractLayoutCache.java   2 Jul 2005 20:32:52 -0000       
1.6
+++ javax/swing/tree/AbstractLayoutCache.java   22 Jul 2005 08:08:17 -0000
@@ -134,11 +134,11 @@
        /**
         * getNodeDimensions
         * 
-        * @param value0 TODO
-        * @param value1 TODO
-        * @param value2 TODO
-        * @param value3 TODO
-        * @param value4 TODO
+        * @param value TODO
+        * @param row TODO
+        * @param depth TODO
+        * @param expanded TODO
+        * @param bounds TODO
         * 
         * @return Rectangle
         */
@@ -154,7 +154,7 @@
        /**
         * Sets the model that provides the tree data.
         * 
-        * @param the model
+        * @param model the model
         */
        public void setModel(TreeModel model)
        {
@@ -318,7 +318,7 @@
         * 
         * @return int
         */
-       public abstract int getVisibleChildCount(TreePath value0);
+       public abstract int getVisibleChildCount(TreePath path);
 
        /**
         * setExpandedState
Index: javax/swing/tree/DefaultTreeCellRenderer.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/tree/DefaultTreeCellRenderer.java,v
retrieving revision 1.14
diff -u -r1.14 DefaultTreeCellRenderer.java
--- javax/swing/tree/DefaultTreeCellRenderer.java       18 Jul 2005 22:57:30 
-0000      1.14
+++ javax/swing/tree/DefaultTreeCellRenderer.java       22 Jul 2005 08:08:18 
-0000
@@ -182,7 +182,7 @@
        /**
         * setOpenIcon
         * 
-        * @param value0 TODO
+        * @param i the icon.
         */
        public void setOpenIcon(Icon i)
        {
@@ -202,7 +202,7 @@
        /**
         * setClosedIcon
         * 
-        * @param value0 TODO
+        * @param i the icon.
         */
        public void setClosedIcon(Icon i)
        {
@@ -222,7 +222,7 @@
        /**
         * setLeafIcon
         * 
-        * @param value0 TODO
+        * @param i the icon.
         */
        public void setLeafIcon(Icon i)
        {
@@ -242,7 +242,7 @@
        /**
         * setTextSelectionColor
         * 
-        * @param value0 TODO
+        * @param c the color.
         */
        public void setTextSelectionColor(Color c)
        {
@@ -262,7 +262,7 @@
        /**
         * setTextNonSelectionColor
         * 
-        * @param value0 TODO
+        * @param c the color.
         */
        public void setTextNonSelectionColor(Color c)
        {
@@ -282,7 +282,7 @@
        /**
         * setBackgroundSelectionColor
         * 
-        * @param value0 TODO
+        * @param c the color.
         */
        public void setBackgroundSelectionColor(Color c)
        {
@@ -302,7 +302,7 @@
        /**
         * setBackgroundNonSelectionColor
         * 
-        * @param value0 TODO
+        * @param c the color.
         */
        public void setBackgroundNonSelectionColor(Color c)
        {
@@ -322,7 +322,7 @@
        /**
         * setBorderSelectionColor
         * 
-        * @param value0 TODO
+        * @param c the color.
         */
        public void setBorderSelectionColor(Color c)
        {
@@ -342,7 +342,7 @@
        /**
         * setFont
         * 
-        * @param value0 TODO
+        * @param f the font.
         */
        public void setFont(Font f)
        {
@@ -354,7 +354,7 @@
        /**
         * setBackground
         * 
-        * @param value0 TODO
+        * @param c the color.
         */
        public void setBackground(Color c)
        {
@@ -366,13 +366,13 @@
        /**
         * getTreeCellRendererComponent
         * 
-        * @param value0 TODO
-        * @param value1 TODO
-        * @param value2 TODO
-        * @param value3 TODO
-        * @param value4 TODO
-        * @param value5 TODO
-        * @param value6 TODO
+        * @param tree TODO
+        * @param val TODO
+        * @param selected TODO
+        * @param expanded TODO
+        * @param leaf TODO
+        * @param row TODO
+        * @param hasFocus TODO
         * @returns Component
         */
        public Component getTreeCellRendererComponent(JTree tree, Object val,
@@ -422,7 +422,7 @@
        /**
         * paint
         * 
-        * @param value0 TODO
+        * @param g the graphics device.
         */
        public void paint(Graphics g)
        {
@@ -580,11 +580,11 @@
        /**
         * firePropertyChange
         * 
-        * @param value0 TODO
-        * @param value1 TODO
-        * @param value2 TODO
+        * @param name the property name.
+        * @param v1 the old value.
+        * @param v2 the new value.
         */
-       public void firePropertyChange(String value0, boolean v1, boolean v2)
+       public void firePropertyChange(String name, boolean v1, boolean v2)
        {
                //  Overridden for performance reasons.
        } // firePropertyChange()
Index: javax/swing/tree/DefaultTreeModel.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/tree/DefaultTreeModel.java,v
retrieving revision 1.9
diff -u -r1.9 DefaultTreeModel.java
--- javax/swing/tree/DefaultTreeModel.java      2 Jul 2005 20:32:52 -0000       
1.9
+++ javax/swing/tree/DefaultTreeModel.java      22 Jul 2005 08:08:18 -0000
@@ -75,7 +75,7 @@
 
        /**
         * Constructor DefaultTreeModel
-        * @param value0 TODO
+        * @param root the tree root.
         */
        public DefaultTreeModel(TreeNode root)
        {
@@ -86,8 +86,8 @@
 
        /**
         * Constructor DefaultTreeModel
-        * @param value0 TODO
-        * @param value1 TODO
+        * @param root the tree root.
+        * @param asksAllowsChildren TODO
         */
        public DefaultTreeModel(TreeNode root, boolean asksAllowsChildren)
        {
@@ -97,10 +97,10 @@
 
        /**
         * writeObject
-        * @param value0 TODO
+        * @param obj the object.
         * @exception IOException TODO
         */
-       private void writeObject(ObjectOutputStream value0) throws IOException
+       private void writeObject(ObjectOutputStream obj) throws IOException
        {
                // TODO
        }
@@ -128,7 +128,7 @@
 
        /**
         * setAsksAllowsChildren
-        * @param value0 TODO
+        * @param value TODO
         */
        public void setAsksAllowsChildren(boolean value)
        {
@@ -137,7 +137,7 @@
 
        /**
         * setRoot
-        * @param value0 TODO
+        * @param root the root node.
         */
        public void setRoot(TreeNode root)
        {
@@ -163,8 +163,8 @@
 
        /**
         * getIndexOfChild
-        * @param value0 TODO
-        * @param value1 TODO
+        * @param parent TODO
+        * @param child TODO
         * @return int
         */
        public int getIndexOfChild(Object parent, Object child)
@@ -174,8 +174,8 @@
 
        /**
         * getChild
-        * @param value0 TODO
-        * @param value1 TODO
+        * @param node TODO
+        * @param idx TODO
         * @return Object
         */
        public Object getChild(Object node, int idx)
@@ -188,7 +188,7 @@
 
        /**
         * getChildCount
-        * @param value0 TODO
+        * @param node TODO
         * @return int
         */
        public int getChildCount(Object node)
@@ -201,7 +201,7 @@
 
        /**
         * isLeaf
-        * @param value0 TODO
+        * @param node TODO
         * @return boolean
         */
        public boolean isLeaf(Object node)
Index: javax/swing/tree/FixedHeightLayoutCache.java
===================================================================
RCS file: 
/cvsroot/classpath/classpath/javax/swing/tree/FixedHeightLayoutCache.java,v
retrieving revision 1.5
diff -u -r1.5 FixedHeightLayoutCache.java
--- javax/swing/tree/FixedHeightLayoutCache.java        2 Jul 2005 20:32:52 
-0000       1.5
+++ javax/swing/tree/FixedHeightLayoutCache.java        22 Jul 2005 08:08:18 
-0000
@@ -125,7 +125,7 @@
        /**
         * getPathForRow
         * 
-        * @param value0 TODO
+        * @param row TODO
         * @returns TreePath
         */
        public TreePath getPathForRow(int row)