8013909: Fix doclint issues in javax.lang.model

Sun, 05 May 2013 21:04:41 -0700

author
darcy
date
Sun, 05 May 2013 21:04:41 -0700
changeset 1725
e8987ce7fb4b
parent 1724
d918b63a5509
child 1726
a7ff36d06fa2

8013909: Fix doclint issues in javax.lang.model
Reviewed-by: jjg

src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java file | annotate | diff | comparison | revisions
src/share/classes/javax/annotation/processing/SupportedOptions.java file | annotate | diff | comparison | revisions
src/share/classes/javax/annotation/processing/SupportedSourceVersion.java file | annotate | diff | comparison | revisions
src/share/classes/javax/lang/model/AnnotatedConstruct.java file | annotate | diff | comparison | revisions
src/share/classes/javax/lang/model/element/NestingKind.java file | annotate | diff | comparison | revisions
src/share/classes/javax/lang/model/util/ElementScanner6.java file | annotate | diff | comparison | revisions
src/share/classes/javax/lang/model/util/Elements.java file | annotate | diff | comparison | revisions
src/share/classes/javax/lang/model/util/Types.java file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java	Fri May 03 17:44:38 2013 -0700
     1.2 +++ b/src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java	Sun May 05 21:04:41 2013 -0700
     1.3 @@ -1,5 +1,5 @@
     1.4  /*
     1.5 - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
     1.6 + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
     1.7   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.8   *
     1.9   * This code is free software; you can redistribute it and/or modify it
    1.10 @@ -47,5 +47,9 @@
    1.11  @Target(TYPE)
    1.12  @Retention(RUNTIME)
    1.13  public @interface SupportedAnnotationTypes {
    1.14 -  String [] value();
    1.15 +    /**
    1.16 +     * Returns the names of the supported annotation types.
    1.17 +     * @return the names of the supported annotation types
    1.18 +     */
    1.19 +    String [] value();
    1.20  }
     2.1 --- a/src/share/classes/javax/annotation/processing/SupportedOptions.java	Fri May 03 17:44:38 2013 -0700
     2.2 +++ b/src/share/classes/javax/annotation/processing/SupportedOptions.java	Sun May 05 21:04:41 2013 -0700
     2.3 @@ -1,5 +1,5 @@
     2.4  /*
     2.5 - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
     2.6 + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
     2.7   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2.8   *
     2.9   * This code is free software; you can redistribute it and/or modify it
    2.10 @@ -46,5 +46,9 @@
    2.11  @Target(TYPE)
    2.12  @Retention(RUNTIME)
    2.13  public @interface SupportedOptions {
    2.14 -  String [] value();
    2.15 +    /**
    2.16 +     * Returns the supported options.
    2.17 +     * @return the supported options
    2.18 +     */
    2.19 +    String [] value();
    2.20  }
     3.1 --- a/src/share/classes/javax/annotation/processing/SupportedSourceVersion.java	Fri May 03 17:44:38 2013 -0700
     3.2 +++ b/src/share/classes/javax/annotation/processing/SupportedSourceVersion.java	Sun May 05 21:04:41 2013 -0700
     3.3 @@ -1,5 +1,5 @@
     3.4  /*
     3.5 - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
     3.6 + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
     3.7   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     3.8   *
     3.9   * This code is free software; you can redistribute it and/or modify it
    3.10 @@ -47,5 +47,9 @@
    3.11  @Target(TYPE)
    3.12  @Retention(RUNTIME)
    3.13  public @interface SupportedSourceVersion {
    3.14 +    /**
    3.15 +     * Returns the latest supported source version.
    3.16 +     * @return the latest supported source version
    3.17 +     */
    3.18      SourceVersion value();
    3.19  }
     4.1 --- a/src/share/classes/javax/lang/model/AnnotatedConstruct.java	Fri May 03 17:44:38 2013 -0700
     4.2 +++ b/src/share/classes/javax/lang/model/AnnotatedConstruct.java	Sun May 05 21:04:41 2013 -0700
     4.3 @@ -51,7 +51,7 @@
     4.4   * <li> for an invocation of {@code getAnnotation(Class<T>)} or
     4.5   * {@code getAnnotationMirrors()}, <i>E</i>'s annotations contain <i>A</i>.
     4.6   *
     4.7 - * <li> for an invocation of getAnnotationsByType(Class<T>),
     4.8 + * <li> for an invocation of {@code getAnnotationsByType(Class<T>)},
     4.9   * <i>E</i>'s annotations either contain <i>A</i> or, if the type of
    4.10   * <i>A</i> is repeatable, contain exactly one annotation whose value
    4.11   * element contains <i>A</i> and whose type is the containing
     5.1 --- a/src/share/classes/javax/lang/model/element/NestingKind.java	Fri May 03 17:44:38 2013 -0700
     5.2 +++ b/src/share/classes/javax/lang/model/element/NestingKind.java	Sun May 05 21:04:41 2013 -0700
     5.3 @@ -1,5 +1,5 @@
     5.4  /*
     5.5 - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
     5.6 + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
     5.7   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     5.8   *
     5.9   * This code is free software; you can redistribute it and/or modify it
    5.10 @@ -82,9 +82,24 @@
    5.11   * @since 1.6
    5.12   */
    5.13  public enum NestingKind {
    5.14 +    /**
    5.15 +     * A top-level type, not contained within another type.
    5.16 +     */
    5.17      TOP_LEVEL,
    5.18 +
    5.19 +    /**
    5.20 +     * A type that is a named member of another type.
    5.21 +     */
    5.22      MEMBER,
    5.23 +
    5.24 +    /**
    5.25 +     * A named type declared within a construct other than a type.
    5.26 +     */
    5.27      LOCAL,
    5.28 +
    5.29 +    /**
    5.30 +     * A type without a name.
    5.31 +     */
    5.32      ANONYMOUS;
    5.33  
    5.34      /**
    5.35 @@ -92,6 +107,7 @@
    5.36       * A <i>nested</i> type element is any that is not top-level.
    5.37       * An <i>inner</i> type element is any nested type element that
    5.38       * is not {@linkplain Modifier#STATIC static}.
    5.39 +     * @return whether or not the constant is nested
    5.40       */
    5.41      public boolean isNested() {
    5.42          return this != TOP_LEVEL;
     6.1 --- a/src/share/classes/javax/lang/model/util/ElementScanner6.java	Fri May 03 17:44:38 2013 -0700
     6.2 +++ b/src/share/classes/javax/lang/model/util/ElementScanner6.java	Sun May 05 21:04:41 2013 -0700
     6.3 @@ -1,5 +1,5 @@
     6.4  /*
     6.5 - * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
     6.6 + * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
     6.7   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     6.8   *
     6.9   * This code is free software; you can redistribute it and/or modify it
    6.10 @@ -135,6 +135,9 @@
    6.11      /**
    6.12       * Processes an element by calling {@code e.accept(this, p)};
    6.13       * this method may be overridden by subclasses.
    6.14 +     *
    6.15 +     * @param e the element to scan
    6.16 +     * @param p a scanner-specified parameter
    6.17       * @return the result of visiting {@code e}.
    6.18       */
    6.19      public R scan(Element e, P p) {
    6.20 @@ -143,6 +146,8 @@
    6.21  
    6.22      /**
    6.23       * Convenience method equivalent to {@code v.scan(e, null)}.
    6.24 +     *
    6.25 +     * @param e the element to scan
    6.26       * @return the result of scanning {@code e}.
    6.27       */
    6.28      public final R scan(Element e) {
     7.1 --- a/src/share/classes/javax/lang/model/util/Elements.java	Fri May 03 17:44:38 2013 -0700
     7.2 +++ b/src/share/classes/javax/lang/model/util/Elements.java	Sun May 05 21:04:41 2013 -0700
     7.3 @@ -247,6 +247,7 @@
     7.4       * argument.
     7.5       *
     7.6       * @param cs the character sequence to return as a name
     7.7 +     * @return a name with the same sequence of characters as the argument
     7.8       */
     7.9      Name getName(CharSequence cs);
    7.10  
     8.1 --- a/src/share/classes/javax/lang/model/util/Types.java	Fri May 03 17:44:38 2013 -0700
     8.2 +++ b/src/share/classes/javax/lang/model/util/Types.java	Sun May 05 21:04:41 2013 -0700
     8.3 @@ -52,6 +52,7 @@
     8.4       * Returns {@code null} if the type is not one with a
     8.5       * corresponding element.
     8.6       *
     8.7 +     * @param t the type to map to an element
     8.8       * @return the element corresponding to the given type
     8.9       */
    8.10      Element asElement(TypeMirror t);

mercurial