[cp-patches] FYI: Added API docs to JScrollPane

[Roman Kennke]

2005-07-05  Roman Kennke  <address@hidden>

       * javax/swing/JScrollPane.java:
       Added API documentation for class and constructors.

/Roman

Index: javax/swing/JScrollPane.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/JScrollPane.java,v
retrieving revision 1.24
diff -u -r1.24 JScrollPane.java
--- javax/swing/JScrollPane.java        2 Jul 2005 20:32:48 -0000       1.24
+++ javax/swing/JScrollPane.java        5 Jul 2005 12:04:33 -0000
@@ -54,6 +54,9 @@
 import javax.swing.plaf.UIResource;
 
 /**
+ * A component that embeds another component and enables it to be scrolled
+ * both in horizontal and vertical direction.
+ *
  * <table>
  * <tr><th>Property                    </th><th>Stored in       
</th><th>Bound?</th></tr>
  * <tr><td>columnHeader                </td><td>scrollPane      </td><td>yes   
</td></tr>
@@ -564,11 +567,25 @@
   }
 
 
+  /**
+   * Creates a new <code>JScrollPane</code> without a view. The scrollbar
+   * policy is set to address@hidden #VERTICAL_SCROLLBAR_AS_NEEDED} and
+   * address@hidden #HORIZONTAL_SCROLLBAR_AS_NEEDED}.
+   *
+   * @param view the component that is embedded inside the JScrollPane
+   */
   public JScrollPane() 
   {
     this(null);
   }
-    
+
+  /**
+   * Creates a new <code>JScrollPane</code> that embeds the specified
+   * <code>view</code> component, displaying vertical and horizontal scrollbars
+   * as needed.
+   *
+   * @param view the component that is embedded inside the JScrollPane
+   */
   public JScrollPane(Component view) 
   {
     this(view, 
@@ -576,11 +593,40 @@
          HORIZONTAL_SCROLLBAR_AS_NEEDED);
   }
 
+  /**
+   * Creates a new <code>JScrollPane</code> without a view; The scrollbar
+   * policies are set to <code>vsbPolicy</code> and <code>hsbPolicy</code>.
+   *
+   * @param vsbPolicy the vertical scrollbar policy to set
+   * @param hsbPolicy the vertical scrollbar policy to set
+   *
+   * @see address@hidden ScrollPaneConstants#HORIZONTAL_SCROLLBAR_ALWAYS}
+   * @see address@hidden ScrollPaneConstants#HORIZONTAL_SCROLLBAR_AS_NEEDED}
+   * @see address@hidden ScrollPaneConstants#HORIZONTAL_SCROLLBAR_NEVER}
+   * @see address@hidden ScrollPaneConstants#VERTICAL_SCROLLBAR_ALWAYS}
+   * @see address@hidden ScrollPaneConstants#VERTICAL_SCROLLBAR_AS_NEEDED}
+   * @see address@hidden ScrollPaneConstants#VERTICAL_SCROLLBAR_NEVER}
+   */
   public JScrollPane(int vsbPolicy, int hsbPolicy) 
   {
     this(null, vsbPolicy, hsbPolicy);
   }
 
+  /**
+   * Creates a new <code>JScrollPane</code> that embeds the specified
+   * <code>view</code> component; The scrollbar
+   * policies are set to <code>vsbPolicy</code> and <code>hsbPolicy</code>.
+   *
+   * @param vsbPolicy the vertical scrollbar policy to set
+   * @param hsbPolicy the vertical scrollbar policy to set
+   *
+   * @see address@hidden ScrollPaneConstants#HORIZONTAL_SCROLLBAR_ALWAYS}
+   * @see address@hidden ScrollPaneConstants#HORIZONTAL_SCROLLBAR_AS_NEEDED}
+   * @see address@hidden ScrollPaneConstants#HORIZONTAL_SCROLLBAR_NEVER}
+   * @see address@hidden ScrollPaneConstants#VERTICAL_SCROLLBAR_ALWAYS}
+   * @see address@hidden ScrollPaneConstants#VERTICAL_SCROLLBAR_AS_NEEDED}
+   * @see address@hidden ScrollPaneConstants#VERTICAL_SCROLLBAR_NEVER}
+   */
   public JScrollPane(Component view, int vsbPolicy, int hsbPolicy) 
   {
     scrollListener = createScrollListener();