changeset 9522:6cc8c2ad9804

8022453: Fix doclint issues in javax.accessibility Reviewed-by: prr
author darcy
date Tue, 06 Aug 2013 16:45:43 -0700
parents 939c3be6cc86
children 7ab5f19a9a31
files src/share/classes/javax/accessibility/Accessible.java src/share/classes/javax/accessibility/AccessibleBundle.java src/share/classes/javax/accessibility/AccessibleExtendedTable.java src/share/classes/javax/accessibility/AccessibleRelationSet.java src/share/classes/javax/accessibility/AccessibleTable.java src/share/classes/javax/accessibility/AccessibleTableModelChange.java src/share/classes/javax/accessibility/AccessibleTextSequence.java src/share/classes/javax/accessibility/AccessibleValue.java
diffstat 8 files changed, 26 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/javax/accessibility/Accessible.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/Accessible.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -45,6 +45,7 @@
      * of an object that implements Accessible, and that subclass
      * is not Accessible, the developer should override the
      * getAccessibleContext method to return null.
+     * @return the AccessibleContext associated with this object
      */
     public AccessibleContext getAccessibleContext();
 }
--- a/src/share/classes/javax/accessibility/AccessibleBundle.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleBundle.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2002, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -53,6 +53,9 @@
     private final String defaultResourceBundleName
         = "com.sun.accessibility.internal.resources.accessibility";
 
+    /**
+     * Construct an {@code AccessibleBundle}.
+     */
     public AccessibleBundle() {
     }
 
--- a/src/share/classes/javax/accessibility/AccessibleExtendedTable.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleExtendedTable.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2013, 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
@@ -60,7 +60,7 @@
       */
      public int getAccessibleColumn(int index);
 
-     /*
+    /**
       * Returns the index at a row and column in the table.
       *
       * @param r zero-based row of the table
--- a/src/share/classes/javax/accessibility/AccessibleRelationSet.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleRelationSet.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, 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
@@ -163,6 +163,7 @@
 
     /**
      * Returns the number of relations in the relation set.
+     * @return the number of relations in the relation set
      */
     public int size() {
         if (relations == null) {
--- a/src/share/classes/javax/accessibility/AccessibleTable.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleTable.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, 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
@@ -90,6 +90,8 @@
      * Returns the number of rows occupied by the Accessible at
      * a specified row and column in the table.
      *
+     * @param r zero-based row of the table
+     * @param c zero-based column of the table
      * @return the number of rows occupied by the Accessible at a
      * given specified (row, column)
      */
@@ -99,6 +101,8 @@
      * Returns the number of columns occupied by the Accessible at
      * a specified row and column in the table.
      *
+     * @param r zero-based row of the table
+     * @param c zero-based column of the table
      * @return the number of columns occupied by the Accessible at a
      * given specified row and column
      */
--- a/src/share/classes/javax/accessibility/AccessibleTableModelChange.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleTableModelChange.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, 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
@@ -71,8 +71,8 @@
     public static final int DELETE = -1;
 
     /**
-     *  Returns the type of event
-     *
+     *  Returns the type of event.
+     *  @return the type of event
      *  @see #INSERT
      *  @see #UPDATE
      *  @see #DELETE
@@ -81,21 +81,25 @@
 
     /**
      * Returns the first row that changed.
+     * @return the first row that changed
      */
     public int getFirstRow();
 
     /**
      * Returns the last row that changed.
+     * @return the last row that changed
      */
     public int getLastRow();
 
     /**
      * Returns the first column that changed.
+     * @return the first column that changed
      */
     public int getFirstColumn();
 
     /**
      * Returns the last column that changed.
+     * @return the last column that changed
      */
     public int getLastColumn();
 }
--- a/src/share/classes/javax/accessibility/AccessibleTextSequence.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleTextSequence.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2013, 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
@@ -49,7 +49,7 @@
  */
 public class AccessibleTextSequence {
 
-    /* The start index of the text sequence */
+    /** The start index of the text sequence */
     public int startIndex;
 
     /** The end index of the text sequence */
--- a/src/share/classes/javax/accessibility/AccessibleValue.java	Fri Jun 28 16:26:54 2013 -0400
+++ b/src/share/classes/javax/accessibility/AccessibleValue.java	Tue Aug 06 16:45:43 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2013, 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
@@ -60,6 +60,7 @@
     /**
      * Set the value of this object as a Number.
      *
+     * @param n the number to use for the value
      * @return True if the value was set; else False
      * @see #getCurrentAccessibleValue
      */