aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java
diff options
context:
space:
mode:
authorGravatar Francois-Rene Rideau <tunes@google.com>2015-04-10 18:56:21 +0000
committerGravatar Lukacs Berki <lberki@google.com>2015-04-13 11:46:41 +0000
commit4a8da557b5878db1bcf66da32f48a0f97ca37e7a (patch)
treeb3131bec195c9962ad96ddfa80b772b6946e96b4 /src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java
parente6a46b82e8e4e402fc70848f761d5486d2316d8f (diff)
Skylark builtin function cleanups
Clean up related to Skylark builtin functions. Replace "hidden" field of some annotations with a "documented" field (with reversed semantics). -- MOS_MIGRATED_REVID=90827020
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java b/src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java
index 6d7b1dbb1f..bacb78a7dc 100644
--- a/src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java
+++ b/src/main/java/com/google/devtools/build/lib/syntax/SkylarkSignatureProcessor.java
@@ -54,8 +54,8 @@ public class SkylarkSignatureProcessor {
? null : new HashMap<String, SkylarkType>();
HashMap<String, String> doc = new HashMap<>();
- boolean undocumented = annotation.undocumented();
- if (annotation.doc().isEmpty() && !undocumented) {
+ boolean documented = annotation.documented();
+ if (annotation.doc().isEmpty() && documented) {
throw new RuntimeException(String.format("function %s is undocumented", name));
}
@@ -63,11 +63,11 @@ public class SkylarkSignatureProcessor {
? null : defaultValues.iterator();
try {
for (Param param : annotation.mandatoryPositionals()) {
- paramList.add(getParameter(name, param, enforcedTypes, doc, undocumented,
+ paramList.add(getParameter(name, param, enforcedTypes, doc, documented,
/*mandatory=*/true, /*star=*/false, /*starStar=*/false, /*defaultValue=*/null));
}
for (Param param : annotation.optionalPositionals()) {
- paramList.add(getParameter(name, param, enforcedTypes, doc, undocumented,
+ paramList.add(getParameter(name, param, enforcedTypes, doc, documented,
/*mandatory=*/false, /*star=*/false, /*starStar=*/false,
/*defaultValue=*/getDefaultValue(param, defaultValuesIterator)));
}
@@ -79,22 +79,22 @@ public class SkylarkSignatureProcessor {
Preconditions.checkArgument(annotation.extraPositionals().length == 1);
starParam = annotation.extraPositionals()[0];
}
- paramList.add(getParameter(name, starParam, enforcedTypes, doc, undocumented,
+ paramList.add(getParameter(name, starParam, enforcedTypes, doc, documented,
/*mandatory=*/false, /*star=*/true, /*starStar=*/false, /*defaultValue=*/null));
}
for (Param param : annotation.mandatoryNamedOnly()) {
- paramList.add(getParameter(name, param, enforcedTypes, doc, undocumented,
+ paramList.add(getParameter(name, param, enforcedTypes, doc, documented,
/*mandatory=*/true, /*star=*/false, /*starStar=*/false, /*defaultValue=*/null));
}
for (Param param : annotation.optionalNamedOnly()) {
- paramList.add(getParameter(name, param, enforcedTypes, doc, undocumented,
+ paramList.add(getParameter(name, param, enforcedTypes, doc, documented,
/*mandatory=*/false, /*star=*/false, /*starStar=*/false,
/*defaultValue=*/getDefaultValue(param, defaultValuesIterator)));
}
if (annotation.extraKeywords().length > 0) {
Preconditions.checkArgument(annotation.extraKeywords().length == 1);
paramList.add(
- getParameter(name, annotation.extraKeywords()[0], enforcedTypes, doc, undocumented,
+ getParameter(name, annotation.extraKeywords()[0], enforcedTypes, doc, documented,
/*mandatory=*/false, /*star=*/false, /*starStar=*/true, /*defaultValue=*/null));
}
FunctionSignature.WithValues<Object, SkylarkType> signature =
@@ -124,7 +124,7 @@ public class SkylarkSignatureProcessor {
// Then the only per-parameter information needed is a documentation string.
private static Parameter<Object, SkylarkType> getParameter(
String name, Param param, Map<String, SkylarkType> enforcedTypes,
- Map<String, String> paramDoc, boolean undocumented,
+ Map<String, String> paramDoc, boolean documented,
boolean mandatory, boolean star, boolean starStar, @Nullable Object defaultValue)
throws FunctionSignature.SignatureException {
@@ -166,7 +166,7 @@ public class SkylarkSignatureProcessor {
if (enforcedTypes != null) {
enforcedTypes.put(param.name(), enforcedType);
}
- if (param.doc().isEmpty() && !undocumented) {
+ if (param.doc().isEmpty() && documented) {
throw new RuntimeException(String.format("parameter %s is undocumented", name));
}
if (paramDoc != null) {