changeset 2097:e8987ce7fb4b

8013909: Fix doclint issues in javax.lang.model Reviewed-by: jjg
author darcy
date Sun, 05 May 2013 21:04:41 -0700
parents d918b63a5509
children a7ff36d06fa2
files src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java src/share/classes/javax/annotation/processing/SupportedOptions.java src/share/classes/javax/annotation/processing/SupportedSourceVersion.java src/share/classes/javax/lang/model/AnnotatedConstruct.java src/share/classes/javax/lang/model/element/NestingKind.java src/share/classes/javax/lang/model/util/ElementScanner6.java src/share/classes/javax/lang/model/util/Elements.java src/share/classes/javax/lang/model/util/Types.java
diffstat 8 files changed, 43 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java	Sun May 05 21:04:41 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -47,5 +47,9 @@
 @Target(TYPE)
 @Retention(RUNTIME)
 public @interface SupportedAnnotationTypes {
-  String [] value();
+    /**
+     * Returns the names of the supported annotation types.
+     * @return the names of the supported annotation types
+     */
+    String [] value();
 }
--- a/src/share/classes/javax/annotation/processing/SupportedOptions.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/annotation/processing/SupportedOptions.java	Sun May 05 21:04:41 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -46,5 +46,9 @@
 @Target(TYPE)
 @Retention(RUNTIME)
 public @interface SupportedOptions {
-  String [] value();
+    /**
+     * Returns the supported options.
+     * @return the supported options
+     */
+    String [] value();
 }
--- a/src/share/classes/javax/annotation/processing/SupportedSourceVersion.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/annotation/processing/SupportedSourceVersion.java	Sun May 05 21:04:41 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -47,5 +47,9 @@
 @Target(TYPE)
 @Retention(RUNTIME)
 public @interface SupportedSourceVersion {
+    /**
+     * Returns the latest supported source version.
+     * @return the latest supported source version
+     */
     SourceVersion value();
 }
--- a/src/share/classes/javax/lang/model/AnnotatedConstruct.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/lang/model/AnnotatedConstruct.java	Sun May 05 21:04:41 2013 -0700
@@ -51,7 +51,7 @@
  * <li> for an invocation of {@code getAnnotation(Class<T>)} or
  * {@code getAnnotationMirrors()}, <i>E</i>'s annotations contain <i>A</i>.
  *
- * <li> for an invocation of getAnnotationsByType(Class<T>),
+ * <li> for an invocation of {@code getAnnotationsByType(Class<T>)},
  * <i>E</i>'s annotations either contain <i>A</i> or, if the type of
  * <i>A</i> is repeatable, contain exactly one annotation whose value
  * element contains <i>A</i> and whose type is the containing
--- a/src/share/classes/javax/lang/model/element/NestingKind.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/lang/model/element/NestingKind.java	Sun May 05 21:04:41 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -82,9 +82,24 @@
  * @since 1.6
  */
 public enum NestingKind {
+    /**
+     * A top-level type, not contained within another type.
+     */
     TOP_LEVEL,
+
+    /**
+     * A type that is a named member of another type.
+     */
     MEMBER,
+
+    /**
+     * A named type declared within a construct other than a type.
+     */
     LOCAL,
+
+    /**
+     * A type without a name.
+     */
     ANONYMOUS;
 
     /**
@@ -92,6 +107,7 @@
      * A <i>nested</i> type element is any that is not top-level.
      * An <i>inner</i> type element is any nested type element that
      * is not {@linkplain Modifier#STATIC static}.
+     * @return whether or not the constant is nested
      */
     public boolean isNested() {
         return this != TOP_LEVEL;
--- a/src/share/classes/javax/lang/model/util/ElementScanner6.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/lang/model/util/ElementScanner6.java	Sun May 05 21:04:41 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -135,6 +135,9 @@
     /**
      * Processes an element by calling {@code e.accept(this, p)};
      * this method may be overridden by subclasses.
+     *
+     * @param e the element to scan
+     * @param p a scanner-specified parameter
      * @return the result of visiting {@code e}.
      */
     public R scan(Element e, P p) {
@@ -143,6 +146,8 @@
 
     /**
      * Convenience method equivalent to {@code v.scan(e, null)}.
+     *
+     * @param e the element to scan
      * @return the result of scanning {@code e}.
      */
     public final R scan(Element e) {
--- a/src/share/classes/javax/lang/model/util/Elements.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/lang/model/util/Elements.java	Sun May 05 21:04:41 2013 -0700
@@ -247,6 +247,7 @@
      * argument.
      *
      * @param cs the character sequence to return as a name
+     * @return a name with the same sequence of characters as the argument
      */
     Name getName(CharSequence cs);
 
--- a/src/share/classes/javax/lang/model/util/Types.java	Fri May 03 17:44:38 2013 -0700
+++ b/src/share/classes/javax/lang/model/util/Types.java	Sun May 05 21:04:41 2013 -0700
@@ -52,6 +52,7 @@
      * Returns {@code null} if the type is not one with a
      * corresponding element.
      *
+     * @param t the type to map to an element
      * @return the element corresponding to the given type
      */
     Element asElement(TypeMirror t);