changeset 25172:b345c47c02b3

8044281: Fix doclint warnings (missing javadoc tags) in javax.swing.table Reviewed-by: alexsch Contributed-by: Rocky Sloan <rocky.sloan@oracle.com>
author yan
date Thu, 26 Jun 2014 15:58:06 +0400
parents 5dd99a9e443b
children 4f093fa54fa1
files jdk/src/share/classes/javax/swing/table/DefaultTableColumnModel.java jdk/src/share/classes/javax/swing/table/DefaultTableModel.java jdk/src/share/classes/javax/swing/table/JTableHeader.java jdk/src/share/classes/javax/swing/table/TableCellRenderer.java jdk/src/share/classes/javax/swing/table/TableColumn.java jdk/src/share/classes/javax/swing/table/TableColumnModel.java
diffstat 6 files changed, 37 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/jdk/src/share/classes/javax/swing/table/DefaultTableColumnModel.java	Wed Jun 25 12:36:03 2014 -0700
+++ b/jdk/src/share/classes/javax/swing/table/DefaultTableColumnModel.java	Thu Jun 26 15:58:06 2014 +0400
@@ -716,6 +716,8 @@
 
     /**
      * Creates a new default list selection model.
+     *
+     * @return a newly created default list selection model.
      */
     protected ListSelectionModel createSelectionModel() {
         return new DefaultListSelectionModel();
--- a/jdk/src/share/classes/javax/swing/table/DefaultTableModel.java	Wed Jun 25 12:36:03 2014 -0700
+++ b/jdk/src/share/classes/javax/swing/table/DefaultTableModel.java	Thu Jun 26 15:58:06 2014 +0400
@@ -335,6 +335,8 @@
      *
      *  @see #setColumnCount
      * @since 1.3
+     *
+     * @param rowCount  number of rows in the model
      */
     public void setRowCount(int rowCount) {
         setNumRows(rowCount);
@@ -577,6 +579,9 @@
      *  element going to row 0, etc.  This method will send a
      *  <code>tableChanged</code> notification message to all the listeners.
      *
+     * @param columnName  identifier of the newly created column
+     * @param columnData  new data to be added to the column
+     *
      * @see #addColumn(Object, Vector)
      */
     public void addColumn(Object columnName, Object[] columnData) {
--- a/jdk/src/share/classes/javax/swing/table/JTableHeader.java	Wed Jun 25 12:36:03 2014 -0700
+++ b/jdk/src/share/classes/javax/swing/table/JTableHeader.java	Thu Jun 26 15:58:06 2014 +0400
@@ -336,6 +336,10 @@
      * Returns the index of the column that <code>point</code> lies in, or -1 if it
      * lies out of bounds.
      *
+     * @param point  if this <code>point</code> lies within a column, the index of
+     *               that column will be returned; otherwise it is out of bounds
+     *               and -1 is returned
+     *
      * @return  the index of the column that <code>point</code> lies in, or -1 if it
      *          lies out of bounds
      */
@@ -352,6 +356,8 @@
      * When the <code>column</code> parameter is out of bounds this method uses the
      * same conventions as the <code>JTable</code> method <code>getCellRect</code>.
      *
+     * @param column  index of the column
+     *
      * @return  the rectangle containing the header tile at <code>column</code>
      * @see JTable#getCellRect
      */
@@ -883,6 +889,10 @@
             /**
              *  Constructs an AccessiblJTableHeaaderEntry
              * @since 1.4
+             *
+             * @param c  the column index
+             * @param p  the parent <code>JTableHeader</code>
+             * @param t  the table <code>JTable</code>
              */
             public AccessibleJTableHeaderEntry(int c, JTableHeader p, JTable t) {
                 parent = p;
--- a/jdk/src/share/classes/javax/swing/table/TableCellRenderer.java	Wed Jun 25 12:36:03 2014 -0700
+++ b/jdk/src/share/classes/javax/swing/table/TableCellRenderer.java	Thu Jun 26 15:58:06 2014 +0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -86,6 +86,9 @@
      *                          drawing the header, the value of
      *                          <code>row</code> is -1
      * @param   column          the column index of the cell being drawn
+     *
+     * @return                  the component used for drawing the cell.
+     *
      * @see javax.swing.JComponent#isPaintingForPrint()
      */
     Component getTableCellRendererComponent(JTable table, Object value,
--- a/jdk/src/share/classes/javax/swing/table/TableColumn.java	Wed Jun 25 12:36:03 2014 -0700
+++ b/jdk/src/share/classes/javax/swing/table/TableColumn.java	Thu Jun 26 15:58:06 2014 +0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -201,6 +201,11 @@
      *  Cover method, using a default width of 75, a <code>null</code>
      *  renderer and a <code>null</code> editor.
      *  @see #TableColumn(int, int, TableCellRenderer, TableCellEditor)
+     *
+     *  @param modelIndex  the index of the column in the model
+     *  that supplies the data for this column in the table;
+     *  the model index remains the same even when columns
+     *  are reordered in the view
      */
     public TableColumn(int modelIndex) {
         this(modelIndex, 75, null, null);
@@ -210,6 +215,12 @@
      *  Cover method, using a <code>null</code> renderer and a
      *  <code>null</code> editor.
      *  @see #TableColumn(int, int, TableCellRenderer, TableCellEditor)
+     *
+     *  @param modelIndex  the index of the column in the model
+     *  that supplies the data for this column in the table;
+     *  the model index remains the same even when columns
+     *  are reordered in the view
+     *  @param width  this column's preferred width and initial width
      */
     public TableColumn(int modelIndex, int width) {
         this(modelIndex, width, null, null);
--- a/jdk/src/share/classes/javax/swing/table/TableColumnModel.java	Wed Jun 25 12:36:03 2014 -0700
+++ b/jdk/src/share/classes/javax/swing/table/TableColumnModel.java	Thu Jun 26 15:58:06 2014 +0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -162,6 +162,9 @@
      * model.  If the column index for a given X coordinate in 2D space is
      * required, <code>JTable.columnAtPoint</code> can be used instead.
      *
+     * @param xPosition  width from the start of the first column in
+     * the model.
+     *
      * @return  the index of the column; or -1 if no column is found
      * @see javax.swing.JTable#columnAtPoint
      */