diff options
Diffstat (limited to 'src/main/java')
5 files changed, 26 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/ApiExporter.java b/src/main/java/com/google/devtools/build/docgen/ApiExporter.java index cfd569531f..993c4d245a 100644 --- a/src/main/java/com/google/devtools/build/docgen/ApiExporter.java +++ b/src/main/java/com/google/devtools/build/docgen/ApiExporter.java @@ -74,7 +74,6 @@ public class ApiExporter { field.setName(meth.getName()); field.setDoc(meth.getDocumentation()); // TODO(andreeabican): Add type string. - if (!meth.getParams().isEmpty()) { Callable.Builder callable = Callable.newBuilder(); for (SkylarkParamDoc par : meth.getParams()) { @@ -84,7 +83,7 @@ public class ApiExporter { param.setDoc(par.getDocumentation()); callable.addParam(param); } - // TODO(andreeabican): Add type string. + callable.setReturnType(meth.getReturnType()); field.setCallable(callable); } return field; diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkBuiltinMethodDoc.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkBuiltinMethodDoc.java index 396b3b0989..7b128a1366 100644 --- a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkBuiltinMethodDoc.java +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkBuiltinMethodDoc.java @@ -15,6 +15,7 @@ package com.google.devtools.build.docgen.skylark; import com.google.devtools.build.lib.skylarkinterface.SkylarkSignature; import com.google.devtools.build.lib.syntax.BaseFunction; +import com.google.devtools.build.lib.syntax.EvalUtils; import java.util.List; /** @@ -77,6 +78,11 @@ public final class SkylarkBuiltinMethodDoc extends SkylarkMethodDoc { } @Override + public String getReturnType() { + return EvalUtils.getDataTypeNameFromClass(annotation.returnType()); + } + + @Override public List<SkylarkParamDoc> getParams() { return params; } diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkConstructorMethodDoc.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkConstructorMethodDoc.java index 44cde7340e..354eccf15d 100644 --- a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkConstructorMethodDoc.java +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkConstructorMethodDoc.java @@ -15,6 +15,7 @@ package com.google.devtools.build.docgen.skylark; import com.google.common.collect.ImmutableList; import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; +import com.google.devtools.build.lib.syntax.EvalUtils; import java.lang.reflect.Method; import java.util.List; @@ -75,6 +76,11 @@ public final class SkylarkConstructorMethodDoc extends SkylarkMethodDoc { } @Override + public String getReturnType() { + return EvalUtils.getDataTypeNameFromClass(method.getReturnType()); + } + + @Override public List<SkylarkParamDoc> getParams() { return params; } diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkJavaMethodDoc.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkJavaMethodDoc.java index 24524eba62..f81860067e 100644 --- a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkJavaMethodDoc.java +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkJavaMethodDoc.java @@ -17,6 +17,7 @@ import com.google.common.base.Joiner; import com.google.common.collect.ImmutableList; import com.google.devtools.build.lib.skylarkinterface.Param; import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; +import com.google.devtools.build.lib.syntax.EvalUtils; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.List; @@ -99,6 +100,11 @@ public final class SkylarkJavaMethodDoc extends SkylarkMethodDoc { } @Override + public String getReturnType() { + return EvalUtils.getDataTypeNameFromClass(method.getReturnType()); + } + + @Override public List<SkylarkParamDoc> getParams() { return params; } diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java index a0d22bfc82..868998a901 100644 --- a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java @@ -39,6 +39,13 @@ public abstract class SkylarkMethodDoc extends SkylarkDoc { return ""; } + /** + * Returns a string containing a name for the method's return type. + */ + public String getReturnType() { + return ""; + } + /** * Returns a list containing the documentation for each of the method's parameters. */ |