improve documentation

Author: dougxc

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/GraalHotSpotVMConfig.java

@@ -51,7 +51,17 @@ public class GraalHotSpotVMConfig extends GraalHotSpotVMConfigAccess {
      * {@link GraalHotSpotVMConfig} parameter to a {@linkplain Fold foldable} method.
      */
     public static final GraalHotSpotVMConfig INJECTED_VMCONFIG = null;
+
+    /**
+     * Sentinel value to use for an {@linkplain InjectedParameter injected}
+     * {@link MetaAccessProvider} parameter to a {@linkplain Fold foldable} method.
+     */
     public static final MetaAccessProvider INJECTED_METAACCESS = null;
+
+    /**
+     * Sentinel value to use for an {@linkplain InjectedParameter injected} {@link OptionValues}
+     * parameter to a {@linkplain Fold foldable} method.
+     */
     public static final OptionValues INJECTED_OPTIONVALUES = null;
 
     GraalHotSpotVMConfig(HotSpotVMConfigStore store) {

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/SymbolicSnippetEncoder.java

@@ -42,6 +42,7 @@
 import java.util.Set;
 import java.util.function.BiFunction;
 
+import jdk.graal.compiler.serviceprovider.GraalServices;
 import org.graalvm.collections.EconomicMap;
 import org.graalvm.collections.EconomicSet;
 import org.graalvm.collections.MapCursor;
@@ -142,8 +143,7 @@
  * method references into a symbolic form that can be resolved at graph decode time using
  * {@link SymbolicJVMCIReference}.
  * <p>
- * An instance of this class only exist when
- * {@link org.graalvm.nativeimage.ImageInfo#inImageBuildtimeCode()} is true.
+ * An instance of this class only exist when {@link GraalServices#isBuildingLibgraal()} is true.
  */
 public class SymbolicSnippetEncoder {
 

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/hotspot/meta/HotSpotGraphBuilderPlugins.java

@@ -278,8 +278,7 @@ public void run() {
 
         });
         if (!inImageRuntimeCode()) {
-            // In libgraal, all NodeIntrinsics have been converted into special nodes so the plugins
-            // aren't needed.
+            // In libgraal, all NodeIntrinsics have already been converted into nodes.
             NodeIntrinsificationProvider nodeIntrinsificationProvider = new NodeIntrinsificationProvider(metaAccess, snippetReflection, foreignCalls, wordTypes, target);
             invocationPlugins.defer(() -> {
                 for (GeneratedPluginFactory factory : GraalServices.load(GeneratedPluginFactory.class)) {

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/GeneratedPluginFactory.java

@@ -24,10 +24,22 @@
  */
 package jdk.graal.compiler.nodes.graphbuilderconf;
 
+import jdk.graal.compiler.api.replacements.Fold;
+import jdk.graal.compiler.graph.Node.NodeIntrinsic;
 import jdk.graal.compiler.serviceprovider.LibGraalService;
 
+/**
+ * Interface implemented by a (generated) class that can register a set of
+ * {@link GeneratedInvocationPlugin}s. The set of plugins are typically for the
+ * {@link NodeIntrinsic} and {@link Fold} methods in a single top-level class.
+ */
 @LibGraalService
 public interface GeneratedPluginFactory {
 
+    /**
+     * Registers a set of {@link InvocationPlugin}s with {@code plugins}.
+     *
+     * @param injection provides values for injected parameters
+     */
     void registerPlugins(InvocationPlugins plugins, GeneratedPluginInjectionProvider injection);
 }

compiler/src/jdk.graal.compiler/src/jdk/graal/compiler/nodes/graphbuilderconf/GeneratedPluginInjectionProvider.java

@@ -26,8 +26,16 @@
 
 import jdk.graal.compiler.core.common.type.Stamp;
 
+/**
+ * A provider for {@link jdk.graal.compiler.api.replacements.Fold.InjectedParameter injected
+ * parameters} of a method.
+ */
 public interface GeneratedPluginInjectionProvider {
 
+    /**
+     * Gets an injected value of type {@code type}. There will be at most one parameter of this type
+     * in the annotated method.
+     */
     <T> T getInjectedArgument(Class<T> type);
 
     /**