[cp-patches] FYI: ColorSelectionModel.java - added API docs

[David Gilbert]

This patch (committed) adds API doc comments to the ColorSelectionModel 
interface:

2006-03-05  David Gilbert  <[EMAIL PROTECTED]>

        * javax/swing/colorchooser/ColorSelectionModel.java: Reformatted and
        added API docs all over.

Regards,

Dave

Index: javax/swing/colorchooser/ColorSelectionModel.java
===================================================================
RCS file: 
/sources/classpath/classpath/javax/swing/colorchooser/ColorSelectionModel.java,v
retrieving revision 1.5
diff -u -r1.5 ColorSelectionModel.java
--- javax/swing/colorchooser/ColorSelectionModel.java   2 Jul 2005 20:32:49 
-0000       1.5
+++ javax/swing/colorchooser/ColorSelectionModel.java   5 Mar 2006 20:10:46 
-0000
@@ -1,5 +1,5 @@
 /* ColorSelectionModel.java --
-   Copyright (C) 2002, 2004  Free Software Foundation, Inc.
+   Copyright (C) 2002, 2004, 2006,  Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -40,42 +40,47 @@
 
 import java.awt.Color;
 
+import javax.swing.JColorChooser;
+import javax.swing.event.ChangeEvent;
 import javax.swing.event.ChangeListener;
 
 /**
- * ColorSelectionModel
+ * A model that is used by the [EMAIL PROTECTED] JColorChooser} component to 
represent the
+ * selected color.
+ * 
  * @author     Andrew Selkirk
- * @version    1.0
  */
-public interface ColorSelectionModel {
+public interface ColorSelectionModel 
+{
 
-       //-------------------------------------------------------------
-       // Methods ----------------------------------------------------
-       //-------------------------------------------------------------
-
-       /**
-        * getSelectedColor
-        * @returns Color
-        */
-       Color getSelectedColor();
-
-       /**
-        * setSelectedColor
-        * @param color TODO
-        */
-       void setSelectedColor(Color color);
-
-       /**
-        * addChangeListener
-        * @param listener TODO
-        */
-       void addChangeListener(ChangeListener listener);
-
-       /**
-        * removeChangeListener
-        * @param listener TODO
-        */
-       void removeChangeListener(ChangeListener listener);
+  /**
+   * Returns the selected color.
+   * 
+   * @return The selected color.
+   */
+  Color getSelectedColor();
+
+  /**
+   * Sets the selected color.
+   * 
+   * @param color  the selected color.
+   */
+  void setSelectedColor(Color color);
+
+  /**
+   * Registers a listener to receive [EMAIL PROTECTED] ChangeEvent} 
notifications
+   * from this model.
+   * 
+   * @param listener  the listener.
+   */
+  void addChangeListener(ChangeListener listener);
+
+  /**
+   * Deregisters a listener so that it no longer receives [EMAIL PROTECTED] 
ChangeEvent} 
+   * notifications from this action.
+   *
+   * @param listener  the listener.
+   */
+  void removeChangeListener(ChangeListener listener);
 
-
-} // ColorSelectionModel
+}