JDK 14 RFR of JDK-8230882: Use @index in javax.lang.model javadoc
Jonathan Gibbons
jonathan.gibbons at oracle.com
Sun Sep 15 04:31:36 UTC 2019
+1
On 9/14/19 1:09 PM, Joe Darcy wrote:
> Hello,
>
> Please review the simple doc improvement for the javax.lang.model
> package javadoc:
>
> JDK-8230882: Use @index in javax.lang.model javadoc
>
> Patch below; thanks,
>
> -Joe
>
> diff -r 88bbe06ab8d6
> src/java.compiler/share/classes/javax/lang/model/package-info.java
> ---
> a/src/java.compiler/share/classes/javax/lang/model/package-info.java
> Fri Sep 13 09:33:54 2019 -0700
> +++
> b/src/java.compiler/share/classes/javax/lang/model/package-info.java
> Sat Sep 14 13:06:20 2019 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights
> reserved.
> + * Copyright (c) 2005, 2019, 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
> @@ -24,7 +24,8 @@
> */
>
> /**
> - * Classes and hierarchies of packages used to model the Java
> + * Types and hierarchies of packages comprising a {@index "Java language
> + * model"}, a model of the declarations and types of the Java
> * programming language.
> *
> * The members of this package and its subpackages are for use in
> @@ -41,14 +42,14 @@
> * Languages and Applications, October 2004.
> * </blockquote>
> *
> - * In particular, the model makes a distinction between static
> + * In particular, the model makes a distinction between declared
> * language constructs, like the {@linkplain javax.lang.model.element
> * element} representing {@code java.util.Set}, and the family of
> * {@linkplain javax.lang.model.type types} that may be associated
> * with an element, like the raw type {@code java.util.Set}, {@code
> * java.util.Set<String>}, and {@code java.util.Set<T>}.
> *
> - * <p> Unless otherwise specified, methods in this package will throw
> + * <p>Unless otherwise specified, methods in this package will throw
> * a {@code NullPointerException} if given a {@code null} argument.
> *
> * @author Joseph D. Darcy
>
More information about the compiler-dev
mailing list