aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--src/main/java/com/google/devtools/build/lib/skylarkinterface/Param.java4
-rw-r--r--src/main/java/com/google/devtools/build/lib/skylarkinterface/ParamType.java4
2 files changed, 8 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkinterface/Param.java b/src/main/java/com/google/devtools/build/lib/skylarkinterface/Param.java
index 45ad6edc51..66aa4c767f 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkinterface/Param.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkinterface/Param.java
@@ -65,6 +65,10 @@ public @interface Param {
* {@link com.google.devtools.build.lib.syntax.SkylarkList}), specify the type parameter (e.g.
* {@link String}.class} along with {@link com.google.devtools.build.lib.syntax.SkylarkList} for
* {@link #type()} to specify a list of strings).
+ *
+ * <p>This is only used for documentation generation. The actual generic type is not checked at
+ * runtime, so the Java method signature should use a generic type of Object and cast
+ * appropriately.
*/
Class<?> generic1() default Object.class;
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkinterface/ParamType.java b/src/main/java/com/google/devtools/build/lib/skylarkinterface/ParamType.java
index 0e4cfb9462..7cf9e4566e 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkinterface/ParamType.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkinterface/ParamType.java
@@ -32,6 +32,10 @@ public @interface ParamType {
* {@link com.google.devtools.build.lib.syntax.SkylarkList}), specify the type parameter (e.g.
* {@link String}.class} along with {@link com.google.devtools.build.lib.syntax.SkylarkList} for
* {@link #type()} to specify a list of strings).
+ *
+ * <p>This is only used for documentation generation. The actual generic type is not checked at
+ * runtime, so the Java method signature should use a generic type of Object and cast
+ * appropriately.
*/
Class<?> generic1() default Object.class;
}