From a85d2771f85796f5f31158834d38222e0cadeb5c Mon Sep 17 00:00:00 2001
From: ray <ray@6335cc39-0255-0410-8fd6-9bcaacd3b74c>
Date: Mon, 14 Jun 2004 17:20:04 +0000
Subject: [PATCH] comment fixups.

git-svn-id: https://samskivert.googlecode.com/svn/trunk@1449 6335cc39-0255-0410-8fd6-9bcaacd3b74c
---
 .../samskivert/swing/ObjectEditorTable.java   | 22 +++++++++++--------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/projects/samskivert/src/java/com/samskivert/swing/ObjectEditorTable.java b/projects/samskivert/src/java/com/samskivert/swing/ObjectEditorTable.java
index ff94124d..0911d0de 100644
--- a/projects/samskivert/src/java/com/samskivert/swing/ObjectEditorTable.java
+++ b/projects/samskivert/src/java/com/samskivert/swing/ObjectEditorTable.java
@@ -1,5 +1,5 @@
 //
-// $Id: ObjectEditorTable.java,v 1.1 2004/06/14 01:08:22 ray Exp $
+// $Id: ObjectEditorTable.java,v 1.2 2004/06/14 17:20:04 ray Exp $
 
 package com.samskivert.swing;
 
@@ -24,13 +24,13 @@ import com.samskivert.util.ListUtil;
 import com.samskivert.Log;
 
 /**
- * Allows simple displaying and editable of Objects in a table format.
+ * Allows simple displaying and editing of Objects in a table format.
  */
 public class ObjectEditorTable extends JTable
 {
     /**
      * The default FieldInterpreter, which can be used to customize the
-     * name, values, and editing of a field in a DSet.Entry.
+     * name, values, and editing of a field in an Object.
      *
      * There are a number of ways that the field editing can be customized.
      * A custom renderer (and editor) may be installed on the table, possibly
@@ -170,8 +170,13 @@ public class ObjectEditorTable extends JTable
     }
 
     /**
-     * Add an action listener to this table. Will be notified when objects
-     * are edited.
+     * Add an action listener to this table.
+     *
+     * When any field is changed in the table, an action will be fired with
+     * a {@link CommandEvent}, with source being the table, the command
+     * being the name of the field that was updated, and the argument being
+     * the object that was updated. Note that no event is fired if a field
+     * was edited but the value did not change.
      */
     public void addActionListener (ActionListener listener)
     {
@@ -187,8 +192,7 @@ public class ObjectEditorTable extends JTable
     }
 
     /**
-     * A table model that uses the FieldInterpreter to muck with the data
-     * objects.
+     * A table model that uses the FieldInterpreter to muck with the objects.
      */
     protected AbstractTableModel _model = new AbstractTableModel() {
         /**
@@ -263,11 +267,11 @@ public class ObjectEditorTable extends JTable
         }
     };
 
-    /** The list of fields in the prototypical Entry object. */
+    /** The list of fields in the prototypical object. */
     protected Field[] _fields;
 
     /** An interpreter that is used to massage values in and out of the
-     * entries. */
+     * objects. */
     protected FieldInterpreter _interp;
 
     /** A list of flags corresponding to the _fields (and the table columns)