Enforce @SkylarkCallable must have a non-empty doc string or explicitly be documented=false.
RELNOTES: None.
PiperOrigin-RevId: 191112140
diff --git a/src/test/java/com/google/devtools/build/lib/syntax/SkylarkEvaluationTest.java b/src/test/java/com/google/devtools/build/lib/syntax/SkylarkEvaluationTest.java
index 4a1a09d..ed8fb91 100644
--- a/src/test/java/com/google/devtools/build/lib/syntax/SkylarkEvaluationTest.java
+++ b/src/test/java/com/google/devtools/build/lib/syntax/SkylarkEvaluationTest.java
@@ -86,24 +86,24 @@
super(CONSTRUCTOR);
}
- @SkylarkCallable(name = "callable_string", doc = "", structField = false)
+ @SkylarkCallable(name = "callable_string", documented = false, structField = false)
public String callableString() {
return "a";
}
- @SkylarkCallable(name = "struct_field_string", doc = "", structField = true)
+ @SkylarkCallable(name = "struct_field_string", documented = false, structField = true)
public String structFieldString() {
return "a";
}
- @SkylarkCallable(name = "struct_field_callable", doc = "", structField = true)
+ @SkylarkCallable(name = "struct_field_callable", documented = false, structField = true)
public BuiltinFunction structFieldCallable() {
return foobar;
}
@SkylarkCallable(
name = "struct_field_none",
- doc = "",
+ documented = false,
structField = true,
allowReturnNones = true
)
@@ -114,58 +114,58 @@
@SkylarkModule(name = "Mock", doc = "")
static class Mock {
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public static Integer valueOf(String str) {
return Integer.valueOf(str);
}
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public Boolean isEmpty(String str) {
return str.isEmpty();
}
public void value() {}
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public Bad returnBad() {
return new Bad();
}
- @SkylarkCallable(name = "struct_field", doc = "", structField = true)
+ @SkylarkCallable(name = "struct_field", documented = false, structField = true)
public String structField() {
return "a";
}
- @SkylarkCallable(name = "struct_field_callable", doc = "", structField = true)
+ @SkylarkCallable(name = "struct_field_callable", documented = false, structField = true)
public BuiltinFunction structFieldCallable() {
return foobar;
}
- @SkylarkCallable(name = "function", doc = "", structField = false)
+ @SkylarkCallable(name = "function", documented = false, structField = false)
public String function() {
return "a";
}
@SuppressWarnings("unused")
- @SkylarkCallable(name = "nullfunc_failing", doc = "", allowReturnNones = false)
+ @SkylarkCallable(name = "nullfunc_failing", documented = false, allowReturnNones = false)
public SkylarkValue nullfuncFailing(String p1, Integer p2) {
return null;
}
- @SkylarkCallable(name = "nullfunc_working", doc = "", allowReturnNones = true)
+ @SkylarkCallable(name = "nullfunc_working", documented = false, allowReturnNones = true)
public SkylarkValue nullfuncWorking() {
return null;
}
- @SkylarkCallable(name = "voidfunc", doc = "")
+ @SkylarkCallable(name = "voidfunc", documented = false)
public void voidfunc() {}
- @SkylarkCallable(name = "string_list", doc = "")
+ @SkylarkCallable(name = "string_list", documented = false)
public ImmutableList<String> stringList() {
return ImmutableList.<String>of("a", "b");
}
- @SkylarkCallable(name = "string", doc = "")
+ @SkylarkCallable(name = "string", documented = false)
public String string() {
return "a";
}
- @SkylarkCallable(name = "string_list_dict", doc = "")
+ @SkylarkCallable(name = "string_list_dict", documented = false)
public Map<String, List<String>> stringListDict() {
return ImmutableMap.of("a", ImmutableList.of("b", "c"));
}
@SkylarkCallable(
name = "with_params",
- doc = "",
+ documented = false,
mandatoryPositionals = 1,
parameters = {
@Param(name = "pos2", defaultValue = "False", type = Boolean.class),
@@ -241,7 +241,7 @@
@SkylarkCallable(
name = "with_extra",
- doc = "",
+ documented = false,
useLocation = true,
useAst = true,
useEnvironment = true,
@@ -262,7 +262,7 @@
@SkylarkCallable(
name = "with_params_and_extra",
- doc = "",
+ documented = false,
mandatoryPositionals = 1,
parameters = {
@Param(name = "pos2", defaultValue = "False", type = Boolean.class),
@@ -360,7 +360,7 @@
@SkylarkModule(name = "MockInterface", doc = "")
static interface MockInterface {
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public Boolean isEmptyInterface(String str);
}
@@ -373,13 +373,13 @@
public Boolean isEmptyInterface(String str) {
return str.isEmpty();
}
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public Boolean isEmptyClassNotAnnotated(String str) {
return str.isEmpty();
}
}
- @SkylarkModule(name = "MockClassObject", doc = "", documented = false)
+ @SkylarkModule(name = "MockClassObject", documented = false, doc = "")
static final class MockClassObject implements ClassObject {
@Override
public Object getValue(String name) {
@@ -404,10 +404,10 @@
@SkylarkModule(name = "MockMultipleMethodClass", doc = "")
static final class MockMultipleMethodClass {
@SuppressWarnings("unused")
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public void method(Object o) {}
@SuppressWarnings("unused")
- @SkylarkCallable(doc = "")
+ @SkylarkCallable(documented = false)
public void method(String i) {}
}
@@ -1694,22 +1694,22 @@
Location.BUILTIN);
}
- @SkylarkCallable(name = "callable_only_field", doc = "", structField = true)
+ @SkylarkCallable(name = "callable_only_field", documented = false, structField = true)
public String getCallableOnlyField() {
return "fromSkylarkCallable";
}
- @SkylarkCallable(name = "callable_only_method", doc = "", structField = false)
+ @SkylarkCallable(name = "callable_only_method", documented = false, structField = false)
public String getCallableOnlyMethod() {
return "fromSkylarkCallable";
}
- @SkylarkCallable(name = "collision_field", doc = "", structField = true)
+ @SkylarkCallable(name = "collision_field", documented = false, structField = true)
public String getCollisionField() {
return "fromSkylarkCallable";
}
- @SkylarkCallable(name = "collision_method", doc = "", structField = false)
+ @SkylarkCallable(name = "collision_method", documented = false, structField = false)
public String getCollisionMethod() {
return "fromSkylarkCallable";
}
