commit | 60e24c9ee31d96ad769f28ba5b46c0c3ee21ee9f | [log] [tgz] |
---|---|---|
author | Googler <noreply@google.com> | Mon Aug 20 04:55:28 2018 -0700 |
committer | Copybara-Service <copybara-piper@google.com> | Mon Aug 20 04:57:38 2018 -0700 |
tree | 8cd04b9fc96ebe6571cd8538f3a0e6140ba228df | |
parent | 6cadf3140dafae650176ea762715943dca60cd03 [diff] |
Removed parameters from overloaded methods names. RELNOTES: None PiperOrigin-RevId: 209399281
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 59f8940..3ca4b02 100644 --- a/src/main/java/com/google/devtools/build/docgen/ApiExporter.java +++ b/src/main/java/com/google/devtools/build/docgen/ApiExporter.java
@@ -76,7 +76,7 @@ private static Value.Builder collectFieldInfo(SkylarkMethodDoc meth) { Value.Builder field = Value.newBuilder(); - field.setName(meth.getName()); + field.setName(meth.getShortName()); field.setDoc(meth.getDocumentation()); if (meth.isCallable()) { Callable.Builder callable = Callable.newBuilder();
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 8707986..448dc28 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
@@ -83,6 +83,11 @@ } @Override + public String getShortName() { + return name; + } + + @Override public String getDocumentation() { return SkylarkDocUtils.substituteVariables(callable.doc()); }
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 bb7edb1..d7c2057 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
@@ -54,6 +54,17 @@ } /** + * Returns a string containing the method's name. GetName() returns the complete signature in case + * of overloaded methods. This is used to extract only the name of the method. + * + * <p>E.g. ctx.new_file is overloaded. In this case getName() returns "new_file(filename)", while + * getShortName() returns only "new_file". + */ + public String getShortName() { + return getName(); + } + + /** * Returns a list containing the documentation for each of the method's parameters. */ public List<SkylarkParamDoc> getParams() {