From 6fede334f9693fdf546c8b4dcde9e37cd5b2e71a Mon Sep 17 00:00:00 2001 From: Joe Darcy Date: Tue, 6 Aug 2013 16:45:43 -0700 Subject: [PATCH] 8022453: Fix doclint issues in javax.accessibility Reviewed-by: prr --- .../share/classes/javax/accessibility/Accessible.java | 3 ++- .../classes/javax/accessibility/AccessibleBundle.java | 5 ++++- .../javax/accessibility/AccessibleExtendedTable.java | 4 ++-- .../javax/accessibility/AccessibleRelationSet.java | 3 ++- .../classes/javax/accessibility/AccessibleTable.java | 6 +++++- .../accessibility/AccessibleTableModelChange.java | 10 +++++++--- .../javax/accessibility/AccessibleTextSequence.java | 4 ++-- .../classes/javax/accessibility/AccessibleValue.java | 3 ++- 8 files changed, 26 insertions(+), 12 deletions(-) diff --git a/jdk/src/share/classes/javax/accessibility/Accessible.java b/jdk/src/share/classes/javax/accessibility/Accessible.java index 0a22e5578b0..c7793715a84 100644 --- a/jdk/src/share/classes/javax/accessibility/Accessible.java +++ b/jdk/src/share/classes/javax/accessibility/Accessible.java @@ -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 @@ public interface Accessible { * 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(); } diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleBundle.java b/jdk/src/share/classes/javax/accessibility/AccessibleBundle.java index 282cc2afbe0..65ce81bed6f 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleBundle.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleBundle.java @@ -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 @@ public abstract class AccessibleBundle { private final String defaultResourceBundleName = "com.sun.accessibility.internal.resources.accessibility"; + /** + * Construct an {@code AccessibleBundle}. + */ public AccessibleBundle() { } diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleExtendedTable.java b/jdk/src/share/classes/javax/accessibility/AccessibleExtendedTable.java index 485d68daa59..87385639db1 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleExtendedTable.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleExtendedTable.java @@ -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 interface AccessibleExtendedTable extends AccessibleTable { */ public int getAccessibleColumn(int index); - /* + /** * Returns the index at a row and column in the table. * * @param r zero-based row of the table diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleRelationSet.java b/jdk/src/share/classes/javax/accessibility/AccessibleRelationSet.java index d6b0ece3da2..e1409089fb9 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleRelationSet.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleRelationSet.java @@ -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 @@ public class AccessibleRelationSet { /** * Returns the number of relations in the relation set. + * @return the number of relations in the relation set */ public int size() { if (relations == null) { diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleTable.java b/jdk/src/share/classes/javax/accessibility/AccessibleTable.java index c1921aa823f..74c7a03dc0d 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleTable.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleTable.java @@ -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 @@ public interface AccessibleTable { * 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 @@ public interface AccessibleTable { * 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 */ diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleTableModelChange.java b/jdk/src/share/classes/javax/accessibility/AccessibleTableModelChange.java index 43bb28c6bd2..03cdf9ab666 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleTableModelChange.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleTableModelChange.java @@ -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 interface AccessibleTableModelChange { 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 @@ public interface AccessibleTableModelChange { /** * 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(); } diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleTextSequence.java b/jdk/src/share/classes/javax/accessibility/AccessibleTextSequence.java index 58af80b3be5..cc70970af77 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleTextSequence.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleTextSequence.java @@ -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 @@ package javax.accessibility; */ 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 */ diff --git a/jdk/src/share/classes/javax/accessibility/AccessibleValue.java b/jdk/src/share/classes/javax/accessibility/AccessibleValue.java index 5108428f933..448eaac4f37 100644 --- a/jdk/src/share/classes/javax/accessibility/AccessibleValue.java +++ b/jdk/src/share/classes/javax/accessibility/AccessibleValue.java @@ -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 @@ public interface AccessibleValue { /** * 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 */