8013909: Fix doclint issues in javax.lang.model
Reviewed-by: jjg
This commit is contained in:
parent
4b44fd7622
commit
d606b9d0d6
@ -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.
|
* 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
|
||||||
@ -47,5 +47,9 @@ import static java.lang.annotation.ElementType.*;
|
|||||||
@Target(TYPE)
|
@Target(TYPE)
|
||||||
@Retention(RUNTIME)
|
@Retention(RUNTIME)
|
||||||
public @interface SupportedAnnotationTypes {
|
public @interface SupportedAnnotationTypes {
|
||||||
String [] value();
|
/**
|
||||||
|
* Returns the names of the supported annotation types.
|
||||||
|
* @return the names of the supported annotation types
|
||||||
|
*/
|
||||||
|
String [] value();
|
||||||
}
|
}
|
||||||
|
@ -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.
|
* 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
|
||||||
@ -46,5 +46,9 @@ import static java.lang.annotation.ElementType.*;
|
|||||||
@Target(TYPE)
|
@Target(TYPE)
|
||||||
@Retention(RUNTIME)
|
@Retention(RUNTIME)
|
||||||
public @interface SupportedOptions {
|
public @interface SupportedOptions {
|
||||||
String [] value();
|
/**
|
||||||
|
* Returns the supported options.
|
||||||
|
* @return the supported options
|
||||||
|
*/
|
||||||
|
String [] value();
|
||||||
}
|
}
|
||||||
|
@ -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.
|
* 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
|
||||||
@ -47,5 +47,9 @@ import javax.lang.model.SourceVersion;
|
|||||||
@Target(TYPE)
|
@Target(TYPE)
|
||||||
@Retention(RUNTIME)
|
@Retention(RUNTIME)
|
||||||
public @interface SupportedSourceVersion {
|
public @interface SupportedSourceVersion {
|
||||||
|
/**
|
||||||
|
* Returns the latest supported source version.
|
||||||
|
* @return the latest supported source version
|
||||||
|
*/
|
||||||
SourceVersion value();
|
SourceVersion value();
|
||||||
}
|
}
|
||||||
|
@ -51,7 +51,7 @@ import javax.lang.model.type.*;
|
|||||||
* <li> for an invocation of {@code getAnnotation(Class<T>)} or
|
* <li> for an invocation of {@code getAnnotation(Class<T>)} or
|
||||||
* {@code getAnnotationMirrors()}, <i>E</i>'s annotations contain <i>A</i>.
|
* {@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>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
|
* <i>A</i> is repeatable, contain exactly one annotation whose value
|
||||||
* element contains <i>A</i> and whose type is the containing
|
* element contains <i>A</i> and whose type is the containing
|
||||||
|
@ -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.
|
* 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
|
||||||
@ -82,9 +82,24 @@ package javax.lang.model.element;
|
|||||||
* @since 1.6
|
* @since 1.6
|
||||||
*/
|
*/
|
||||||
public enum NestingKind {
|
public enum NestingKind {
|
||||||
|
/**
|
||||||
|
* A top-level type, not contained within another type.
|
||||||
|
*/
|
||||||
TOP_LEVEL,
|
TOP_LEVEL,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A type that is a named member of another type.
|
||||||
|
*/
|
||||||
MEMBER,
|
MEMBER,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A named type declared within a construct other than a type.
|
||||||
|
*/
|
||||||
LOCAL,
|
LOCAL,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A type without a name.
|
||||||
|
*/
|
||||||
ANONYMOUS;
|
ANONYMOUS;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -92,6 +107,7 @@ public enum NestingKind {
|
|||||||
* A <i>nested</i> type element is any that is not top-level.
|
* 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
|
* An <i>inner</i> type element is any nested type element that
|
||||||
* is not {@linkplain Modifier#STATIC static}.
|
* is not {@linkplain Modifier#STATIC static}.
|
||||||
|
* @return whether or not the constant is nested
|
||||||
*/
|
*/
|
||||||
public boolean isNested() {
|
public boolean isNested() {
|
||||||
return this != TOP_LEVEL;
|
return this != TOP_LEVEL;
|
||||||
|
@ -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.
|
* 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
|
||||||
@ -135,6 +135,9 @@ public class ElementScanner6<R, P> extends AbstractElementVisitor6<R, P> {
|
|||||||
/**
|
/**
|
||||||
* Processes an element by calling {@code e.accept(this, p)};
|
* Processes an element by calling {@code e.accept(this, p)};
|
||||||
* this method may be overridden by subclasses.
|
* 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}.
|
* @return the result of visiting {@code e}.
|
||||||
*/
|
*/
|
||||||
public R scan(Element e, P p) {
|
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)}.
|
* Convenience method equivalent to {@code v.scan(e, null)}.
|
||||||
|
*
|
||||||
|
* @param e the element to scan
|
||||||
* @return the result of scanning {@code e}.
|
* @return the result of scanning {@code e}.
|
||||||
*/
|
*/
|
||||||
public final R scan(Element e) {
|
public final R scan(Element e) {
|
||||||
|
@ -247,6 +247,7 @@ public interface Elements {
|
|||||||
* argument.
|
* argument.
|
||||||
*
|
*
|
||||||
* @param cs the character sequence to return as a name
|
* @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);
|
Name getName(CharSequence cs);
|
||||||
|
|
||||||
|
@ -52,6 +52,7 @@ public interface Types {
|
|||||||
* Returns {@code null} if the type is not one with a
|
* Returns {@code null} if the type is not one with a
|
||||||
* corresponding element.
|
* corresponding element.
|
||||||
*
|
*
|
||||||
|
* @param t the type to map to an element
|
||||||
* @return the element corresponding to the given type
|
* @return the element corresponding to the given type
|
||||||
*/
|
*/
|
||||||
Element asElement(TypeMirror t);
|
Element asElement(TypeMirror t);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user