aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/skylark/SkylarkMethodDoc.java21
1 files changed, 13 insertions, 8 deletions
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 9fd398789b..293c56e863 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
@@ -31,12 +31,6 @@ public abstract class SkylarkMethodDoc extends SkylarkDoc {
public abstract boolean documented();
/**
- * Returns a string representing the method signature of the Skylark method, which contains
- * HTML links to the documentation of parameter types if available.
- */
- public abstract String getSignature();
-
- /**
* Returns a string containing additional documentation about the method's return value.
*
* <p>Returns an empty string by default.
@@ -81,14 +75,25 @@ public abstract class SkylarkMethodDoc extends SkylarkDoc {
return Joiner.on(", ").join(argList);
}
+ /**
+ * Returns a string representing the method signature of the Skylark method, which contains
+ * HTML links to the documentation of parameter types if available.
+ */
+ public abstract String getSignature();
+
protected String getSignature(String objectName, String methodName, Method method) {
String objectDotExpressionPrefix =
objectName.isEmpty() ? "" : objectName + ".";
+
+ return getSignature(objectDotExpressionPrefix + methodName, method);
+ }
+
+ protected String getSignature(String fullyQualifiedMethodName, Method method) {
String args = SkylarkInterfaceUtils.getSkylarkCallable(method).structField()
? "" : "(" + getParameterString(method) + ")";
- return String.format("%s %s%s%s",
- getTypeAnchor(method.getReturnType()), objectDotExpressionPrefix, methodName, args);
+ return String.format("%s %s%s",
+ getTypeAnchor(method.getReturnType()), fullyQualifiedMethodName, args);
}
protected String getSignature(String objectName, SkylarkSignature method) {