[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[cp-patches] FYI: api doc fixes in javax/swing/tree
|
From: |
David Gilbert |
|
Subject: |
[cp-patches] FYI: api doc fixes in javax/swing/tree |
|
Date: |
Wed, 13 Jul 2005 09:39:29 +0000 |
|
User-agent: |
Mozilla Thunderbird 1.0.2 (X11/20050426) |
I committed this patch to fix some API doc issues:
2005-07-13 David Gilbert <address@hidden>
* javax/swing/tree/DefaultMutableTreeNode.java: minor API doc fixes,
* javax/swing/tree/DefaultTreeSelectionModel.java
(addSelectionPath): modified parameter name to match doc comment,
(addSelectionPaths): likewise,
(removeSelectionPath): likewise,
(removeSelectionPaths): likewise,
(isPathSelected): likewise,
plus other minor API doc fixes all over.
* javax/swing/tree/MutableTreeNode.java: minor API doc fixes.
Regards,
Dave Gilbert
Index: javax/swing/tree/DefaultMutableTreeNode.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/swing/tree/DefaultMutableTreeNode.java,v
retrieving revision 1.10
diff -u -r1.10 DefaultMutableTreeNode.java
--- javax/swing/tree/DefaultMutableTreeNode.java 2 Jul 2005 20:32:52
-0000 1.10
+++ javax/swing/tree/DefaultMutableTreeNode.java 13 Jul 2005 08:34:53
-0000
@@ -232,7 +232,7 @@
* Inserts given child node at the given index.
*
* @param node the child node
- * @param value the index.
+ * @param index the index.
*/
public void insert(MutableTreeNode node, int index)
{
@@ -389,7 +389,7 @@
/**
* isNodeDescendant
*
- * @param node0 TODO
+ * @param node TODO
*
* @return boolean
*/
Index: javax/swing/tree/DefaultTreeSelectionModel.java
===================================================================
RCS file:
/cvsroot/classpath/classpath/javax/swing/tree/DefaultTreeSelectionModel.java,v
retrieving revision 1.18
diff -u -r1.18 DefaultTreeSelectionModel.java
--- javax/swing/tree/DefaultTreeSelectionModel.java 12 Jul 2005 19:26:41
-0000 1.18
+++ javax/swing/tree/DefaultTreeSelectionModel.java 13 Jul 2005 08:34:54
-0000
@@ -1,5 +1,5 @@
/* DefaultTreeSelectionModel.java
- Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -173,9 +173,9 @@
*
* @param rowMapper the RowMapper to set
*
- * @see address@hidden RowMapper
+ * @see RowMapper
*/
- public void setRowMapper(RowMapper value0)
+ public void setRowMapper(RowMapper rowMapper)
{
// TODO
}
@@ -186,7 +186,7 @@
*
* @return the current RowMapper
*
- * @see address@hidden RowMapper
+ * @see RowMapper
*/
public RowMapper getRowMapper()
{
@@ -195,15 +195,15 @@
/**
* Sets the current selection mode. Possible values are
- * address@hidden #SINGLE_TREE_SELECTION}, address@hidden
CONTIGUOUS_TREE_SELECTION} and
+ * address@hidden #SINGLE_TREE_SELECTION}, address@hidden
#CONTIGUOUS_TREE_SELECTION} and
* address@hidden #DISCONTIGUOUS_TREE_SELECTION}.
*
* @param mode the selection mode to be set
*
- * @see address@hidden #getSelectionMode}
- * @see address@hidden #SINGLE_TREE_SELECTION}
- * @see address@hidden #CONTIGUOUS_TREE_SELECTION}
- * @see address@hidden #DISCONTIGUOUS_TREE_SELECTION}
+ * @see #getSelectionMode
+ * @see #SINGLE_TREE_SELECTION
+ * @see #CONTIGUOUS_TREE_SELECTION
+ * @see #DISCONTIGUOUS_TREE_SELECTION
*/
public void setSelectionMode(int mode)
{
@@ -215,10 +215,10 @@
*
* @return the current selection mode
*
- * @see address@hidden #setSelectionMode}
- * @see address@hidden #SINGLE_TREE_SELECTION}
- * @see address@hidden #CONTIGUOUS_TREE_SELECTION}
- * @see address@hidden #DISCONTIGUOUS_TREE_SELECTION}
+ * @see #setSelectionMode
+ * @see #SINGLE_TREE_SELECTION
+ * @see #CONTIGUOUS_TREE_SELECTION
+ * @see #DISCONTIGUOUS_TREE_SELECTION
*/
public int getSelectionMode()
{
@@ -248,7 +248,7 @@
*
* @param paths the paths to set as selection
*/
- public void setSelectionPaths(TreePath[] value0)
+ public void setSelectionPaths(TreePath[] paths)
{
// TODO
}
@@ -262,23 +262,23 @@
*
* @param path the path to add to the selection
*/
- public void addSelectionPath(TreePath value0)
+ public void addSelectionPath(TreePath path)
{
- if (!isPathSelected(value0))
+ if (!isPathSelected(path))
{
if (isSelectionEmpty())
- setSelectionPath(value0);
+ setSelectionPath(path);
else
{
TreePath[] temp = new TreePath[selection.length
+ 1];
System.arraycopy(selection, 0, temp, 0,
selection.length);
- temp[temp.length - 1] = value0;
+ temp[temp.length - 1] = path;
selection = new TreePath[temp.length];
System.arraycopy(temp, 0, selection, 0,
temp.length);
}
- leadPath = value0;
- fireValueChanged(new TreeSelectionEvent(this, value0,
true,
- leadPath, value0));
+ leadPath = path;
+ fireValueChanged(new TreeSelectionEvent(this, path,
true,
+ leadPath, path));
}
}
@@ -291,14 +291,14 @@
*
* @param paths the paths to add to the selection
*/
- public void addSelectionPaths(TreePath[] value0)
+ public void addSelectionPaths(TreePath[] paths)
{
- if (value0 != null)
+ if (paths != null)
{
TreePath v0 = null;
- for (int i = 0; i < value0.length; i++)
+ for (int i = 0; i < paths.length; i++)
{
- v0 = value0[i];
+ v0 = paths[i];
if (!isPathSelected(v0))
{
if (isSelectionEmpty())
@@ -312,9 +312,9 @@
selection = new
TreePath[temp.length];
System.arraycopy(temp, 0,
selection, 0, temp.length);
}
- leadPath = value0[value0.length - 1];
+ leadPath = paths[paths.length - 1];
fireValueChanged(new
TreeSelectionEvent(this, v0, true,
- leadPath, value0[0]));
+ leadPath, paths[0]));
}
}
}
@@ -328,14 +328,14 @@
*
* @param path the path to remove
*/
- public void removeSelectionPath(TreePath value0)
+ public void removeSelectionPath(TreePath path)
{
int index = -1;
- if (isPathSelected(value0))
+ if (isPathSelected(path))
{
for (int i = 0; i < selection.length; i++)
{
- if (selection[i].equals(value0))
+ if (selection[i].equals(path))
{
index = i;
break;
@@ -348,8 +348,8 @@
selection = new TreePath[temp.length];
System.arraycopy(temp, 0, selection, 0, temp.length);
- fireValueChanged(new TreeSelectionEvent(this, value0,
false,
- leadPath, value0));
+ fireValueChanged(new TreeSelectionEvent(this, path,
false,
+ leadPath, path));
}
}
@@ -359,17 +359,17 @@
* If this changes the selection the registered TreeSelectionListeners
are
* notified.
*
- * @param paths the path to remove
+ * @param paths the paths to remove
*/
- public void removeSelectionPaths(TreePath[] value0)
+ public void removeSelectionPaths(TreePath[] paths)
{
- if (value0 != null)
+ if (paths != null)
{
int index = -1;
TreePath v0 = null;
- for (int i = 0; i < value0.length; i++)
+ for (int i = 0; i < paths.length; i++)
{
- v0 = value0[i];
+ v0 = paths[i];
if (isPathSelected(v0))
{
for (int x = 0; x < selection.length;
x++)
@@ -388,7 +388,7 @@
System.arraycopy(temp, 0, selection, 0,
temp.length);
fireValueChanged(new
TreeSelectionEvent(this, v0, false,
- leadPath, value0[0]));
+ leadPath, paths[0]));
}
}
}
@@ -439,14 +439,14 @@
* @return <code>true</code> if the path is in the selection,
* <code>false</code> otherwise
*/
- public boolean isPathSelected(TreePath value0)
+ public boolean isPathSelected(TreePath path)
{
if (selection == null)
return false;
for (int i = 0; i < selection.length; i++)
{
- if (selection[i].equals(value0))
+ if (selection[i].equals(path))
return true;
}
return false;
@@ -593,7 +593,7 @@
* @return <code>true</code> if the row is in this selection,
* <code>false</code> otherwise
*/
- public boolean isRowSelected(int value0)
+ public boolean isRowSelected(int row)
{
return false; // TODO
}
@@ -666,11 +666,11 @@
* Makes sure the currently selected paths are valid according to the
* current selectionMode.
*
- * If the selectionMode is set to address@hidden
CONTIGUOUS_TREE_SELECTION} and the
+ * If the selectionMode is set to address@hidden
#CONTIGUOUS_TREE_SELECTION} and the
* selection isn't contiguous then the selection is reset to the first
set
* of contguous paths.
*
- * If the selectionMode is set to address@hidden SINGLE_TREE_SELECTION}
and the
+ * If the selectionMode is set to address@hidden
#SINGLE_TREE_SELECTION} and the
* selection has more than one path, the selection is reset to the
contain
* only the first path.
*/
@@ -687,7 +687,7 @@
* @return <code>true</code> if the paths are contiguous or we have no
* RowMapper assigned
*/
- protected boolean arePathsContiguous(TreePath[] value0)
+ protected boolean arePathsContiguous(TreePath[] paths)
{
return false; // TODO
}
@@ -698,7 +698,7 @@
* <li><code>paths</code> is <code>null</code> or empty</li>
* <li>we have no RowMapper assigned</li>
* <li>nothing is currently selected</li>
- * <li>selectionMode is address@hidden DISCONTIGUOUS_TREE_SELECTION</li>
+ * <li>selectionMode is address@hidden
#DISCONTIGUOUS_TREE_SELECTION}</li>
* <li>adding the paths to the selection still results in a contiguous
set
* of paths</li>
*
@@ -707,7 +707,7 @@
* @return <code>true</code> if the paths can be added with respect to
the
* selectionMode
*/
- protected boolean canPathsBeAdded(TreePath[] value0)
+ protected boolean canPathsBeAdded(TreePath[] paths)
{
return false; // TODO
}
@@ -720,7 +720,7 @@
* @return <code>true</code> if the paths can be removed with respect to
* the selectionMode
*/
- protected boolean canPathsBeRemoved(TreePath[] value0)
+ protected boolean canPathsBeRemoved(TreePath[] paths)
{
return false; // TODO
}
Index: javax/swing/tree/MutableTreeNode.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/tree/MutableTreeNode.java,v
retrieving revision 1.4
diff -u -r1.4 MutableTreeNode.java
--- javax/swing/tree/MutableTreeNode.java 2 Jul 2005 20:32:52 -0000
1.4
+++ javax/swing/tree/MutableTreeNode.java 13 Jul 2005 08:34:54 -0000
@@ -1,5 +1,5 @@
/* MutableTreeNode.java --
- Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -61,7 +61,7 @@
*
* @param index the index
*
- * @see #add(MutableTreeNode,int)
+ * @see #insert(MutableTreeNode,int)
* @see #remove(MutableTreeNode)
* @see #removeFromParent()
*/
@@ -72,7 +72,7 @@
*
* @param node the node to remove
*
- * @see #add(MutableTreeNode,int)
+ * @see #insert(MutableTreeNode,int)
* @see #remove(int)
* @see #removeFromParent()
*/
@@ -98,7 +98,7 @@
*
* @param parent the parent
*
- * @see insert(MutableTreeNode,int)
+ * @see #insert(MutableTreeNode,int)
*/
void setParent(MutableTreeNode parent);
}
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [cp-patches] FYI: api doc fixes in javax/swing/tree,
David Gilbert <=