stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8013909: Fix doclint issues in javax.lang.model

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Joe Darcy 2013-05-05 21:04:41 -07:00
parent 4b44fd7622
commit d606b9d0d6
8 changed files with 43 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
langtools/src/share/classes/javax/annotation/processing/SupportedAnnotationTypes.java
View File

@ -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 @@ import static java.lang.annotation.ElementType.*;
@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();
}

8
langtools/src/share/classes/javax/annotation/processing/SupportedOptions.java
View File

@ -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 @@ import static java.lang.annotation.ElementType.*;
@Target(TYPE)
@Retention(RUNTIME)
public @interface SupportedOptions {
String [] value();
/**
* Returns the supported options.
* @return the supported options
*/
String [] value();
}

6
langtools/src/share/classes/javax/annotation/processing/SupportedSourceVersion.java
View File

@ -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 @@ import javax.lang.model.SourceVersion;
@Target(TYPE)
@Retention(RUNTIME)
public @interface SupportedSourceVersion {
/**
* Returns the latest supported source version.
* @return the latest supported source version
*/
SourceVersion value();
}

2
langtools/src/share/classes/javax/lang/model/AnnotatedConstruct.java
View File

@ -51,7 +51,7 @@ import javax.lang.model.type.*;
* <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

18
langtools/src/share/classes/javax/lang/model/element/NestingKind.java
View File

@ -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 @@ package javax.lang.model.element;
* @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 @@ public enum NestingKind {
* 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;

7
langtools/src/share/classes/javax/lang/model/util/ElementScanner6.java
View File

@ -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 @@ public class ElementScanner6<R, P> extends AbstractElementVisitor6<R, P> {
/**
* 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 @@ public class ElementScanner6<R, P> extends AbstractElementVisitor6<R, P> {
/**
* 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) {

1
langtools/src/share/classes/javax/lang/model/util/Elements.java
View File

@ -247,6 +247,7 @@ public interface Elements {
* 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);

1
langtools/src/share/classes/javax/lang/model/util/Types.java
View File

@ -52,6 +52,7 @@ public interface Types {
* 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);