8022453: Fix doclint issues in javax.accessibility

Reviewed-by: prr
This commit is contained in:
Joe Darcy 2013-08-06 16:45:43 -07:00
parent e11ec149ce
commit 6fede334f9
8 changed files with 26 additions and 12 deletions

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -45,6 +45,7 @@ public interface Accessible {
* of an object that implements Accessible, and that subclass * of an object that implements Accessible, and that subclass
* is not Accessible, the developer should override the * is not Accessible, the developer should override the
* getAccessibleContext method to return null. * getAccessibleContext method to return null.
* @return the AccessibleContext associated with this object
*/ */
public AccessibleContext getAccessibleContext(); public AccessibleContext getAccessibleContext();
} }

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -53,6 +53,9 @@ public abstract class AccessibleBundle {
private final String defaultResourceBundleName private final String defaultResourceBundleName
= "com.sun.accessibility.internal.resources.accessibility"; = "com.sun.accessibility.internal.resources.accessibility";
/**
* Construct an {@code AccessibleBundle}.
*/
public AccessibleBundle() { public AccessibleBundle() {
} }

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -60,7 +60,7 @@ public interface AccessibleExtendedTable extends AccessibleTable {
*/ */
public int getAccessibleColumn(int index); public int getAccessibleColumn(int index);
/* /**
* Returns the index at a row and column in the table. * Returns the index at a row and column in the table.
* *
* @param r zero-based row of the table * @param r zero-based row of the table

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -163,6 +163,7 @@ public class AccessibleRelationSet {
/** /**
* Returns the number of relations in the relation set. * Returns the number of relations in the relation set.
* @return the number of relations in the relation set
*/ */
public int size() { public int size() {
if (relations == null) { if (relations == null) {

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -90,6 +90,8 @@ public interface AccessibleTable {
* Returns the number of rows occupied by the Accessible at * Returns the number of rows occupied by the Accessible at
* a specified row and column in the table. * 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 * @return the number of rows occupied by the Accessible at a
* given specified (row, column) * given specified (row, column)
*/ */
@ -99,6 +101,8 @@ public interface AccessibleTable {
* Returns the number of columns occupied by the Accessible at * Returns the number of columns occupied by the Accessible at
* a specified row and column in the table. * 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 * @return the number of columns occupied by the Accessible at a
* given specified row and column * given specified row and column
*/ */

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -71,8 +71,8 @@ public interface AccessibleTableModelChange {
public static final int DELETE = -1; public static final int DELETE = -1;
/** /**
* Returns the type of event * Returns the type of event.
* * @return the type of event
* @see #INSERT * @see #INSERT
* @see #UPDATE * @see #UPDATE
* @see #DELETE * @see #DELETE
@ -81,21 +81,25 @@ public interface AccessibleTableModelChange {
/** /**
* Returns the first row that changed. * Returns the first row that changed.
* @return the first row that changed
*/ */
public int getFirstRow(); public int getFirstRow();
/** /**
* Returns the last row that changed. * Returns the last row that changed.
* @return the last row that changed
*/ */
public int getLastRow(); public int getLastRow();
/** /**
* Returns the first column that changed. * Returns the first column that changed.
* @return the first column that changed
*/ */
public int getFirstColumn(); public int getFirstColumn();
/** /**
* Returns the last column that changed. * Returns the last column that changed.
* @return the last column that changed
*/ */
public int getLastColumn(); public int getLastColumn();
} }

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -49,7 +49,7 @@ package javax.accessibility;
*/ */
public class AccessibleTextSequence { public class AccessibleTextSequence {
/* The start index of the text sequence */ /** The start index of the text sequence */
public int startIndex; public int startIndex;
/** The end index of the text sequence */ /** The end index of the text sequence */

View File

@ -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. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -60,6 +60,7 @@ public interface AccessibleValue {
/** /**
* Set the value of this object as a Number. * 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 * @return True if the value was set; else False
* @see #getCurrentAccessibleValue * @see #getCurrentAccessibleValue
*/ */