Summary
Add index entries for the names of some key public APIs in the java.compiler
and jdk.compiler
modules.
Problem
In external documentation, it is desirable to refer to:
- The Language Model API
- The Annotation Processing API
- The Compiler API
- The Compiler Tree API
It would be good to add entries into the search index for these terms.
Solution
Use the {@index ...}
tag introduced in JDK ??.
There is no existing sentence (or package) that describes the Compiler Tree API. Ideally, the term would be defined in a com.sun.source
package, but that package is currently empty. Instead, a short sentence is added to the jdk.compiler
module spec.
Specification
diff --git a/src/java.compiler/share/classes/module-info.java b/src/java.compiler/share/classes/module-info.java
index 3d937e09f0c..4a28bb7858c 100644
--- a/src/java.compiler/share/classes/module-info.java
+++ b/src/java.compiler/share/classes/module-info.java
@@ -24,7 +24,9 @@
*/
/**
- * Defines the Language Model, Annotation Processing, and Java Compiler APIs.
+ * Defines the {@index "Language Model"}, {@index "Annotation Processing"}, and
+ * {@index "Java Compiler"} APIs.
+ *
* <p>
* These APIs model declarations and types of the Java programming language,
* and define interfaces for tools such as compilers which can be invoked
diff --git a/src/jdk.compiler/share/classes/module-info.java b/src/jdk.compiler/share/classes/module-info.java
index 88066d3c363..613ae320e48 100644
--- a/src/jdk.compiler/share/classes/module-info.java
+++ b/src/jdk.compiler/share/classes/module-info.java
@@ -28,6 +28,10 @@
* {@linkplain javax.tools.ToolProvider#getSystemJavaCompiler system Java compiler}
* and its command line equivalent, <em>{@index javac javac tool}</em>.
*
+ * <p>The {@code com.sun.source.*} packages provide the {@index "Compiler Tree API"}:
+ * an API for accessing the abstract trees (ASTs) representing Java source code
+ * and documentation comments, used by <em>javac</em>, <em>javadoc</em> and related tools.
+ *
* <h2 style="font-family:'DejaVu Sans Mono', monospace; font-style:italic">javac</h2>
*
* <p>
- csr of
-
JDK-8278318 Create {@index} entries for key LangTools terms
- Resolved
- links to
-
Review openjdk/jdk/6729