[cp-patches] FYI: EventListenerList - updated API doc comment

[David Gilbert]

This patch (committed) updates an API doc comment:

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

        * javax/swing/event/EventListenerList.java
        (getListenerList): Updated API docs.

Regards,

Dave

Index: javax/swing/event/EventListenerList.java
===================================================================
RCS file: 
/sources/classpath/classpath/javax/swing/event/EventListenerList.java,v
retrieving revision 1.15
diff -u -r1.15 EventListenerList.java
--- javax/swing/event/EventListenerList.java    3 Mar 2006 23:36:59 -0000       
1.15
+++ javax/swing/event/EventListenerList.java    31 May 2006 05:06:59 -0000
@@ -1,5 +1,5 @@
 /* EventListenerList.java --
-   Copyright (C) 2002, 2004, 2005  Free Software Foundation, Inc.
+   Copyright (C) 2002, 2004, 2005, 2006,  Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -187,11 +187,15 @@
 
 
   /**
-   * Get a list of listenerType/listener pairs
-   * @return Listener list
+   * Returns an array containing a sequence of listenerType/listener pairs, one
+   * for each listener.
+   * 
+   * @return An array containing the listener types and references.
    */
   public Object[] getListenerList()
   {
+    // returning the internal storage is a bad idea, but tests show that the
+    // reference implementation does this...
     return listenerList;
   }