aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/skydoc/rendering
diff options
context:
space:
mode:
authorGravatar cparsons <cparsons@google.com>2018-07-11 10:30:02 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-07-11 10:31:10 -0700
commit11c9f2008f863d076ff5422ff28930a9bb11a87b (patch)
treea60a2dd3ac5c9f33a95773f9c06a82d3905ade7a /src/main/java/com/google/devtools/build/skydoc/rendering
parent29c43683db7dbcf437115bf46ae6fec723a9a29e (diff)
Add attribute information to skydoc output
RELNOTES: None. PiperOrigin-RevId: 204147228
Diffstat (limited to 'src/main/java/com/google/devtools/build/skydoc/rendering')
-rw-r--r--src/main/java/com/google/devtools/build/skydoc/rendering/AttributeInfo.java21
-rw-r--r--src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java2
-rw-r--r--src/main/java/com/google/devtools/build/skydoc/rendering/templates/rule.vm (renamed from src/main/java/com/google/devtools/build/skydoc/rendering/templates/test.vm)9
3 files changed, 29 insertions, 3 deletions
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/AttributeInfo.java b/src/main/java/com/google/devtools/build/skydoc/rendering/AttributeInfo.java
index 8051057321..696fe2deb6 100644
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/AttributeInfo.java
+++ b/src/main/java/com/google/devtools/build/skydoc/rendering/AttributeInfo.java
@@ -21,17 +21,36 @@ public class AttributeInfo {
private final String name;
private final String docString;
+ private final String typeString;
+ private final boolean mandatory;
- public AttributeInfo(String name, String docString) {
+ public AttributeInfo(String name, String docString, String typeString, boolean mandatory) {
this.name = name;
this.docString = docString;
+ this.typeString = typeString;
+ this.mandatory = mandatory;
}
+ @SuppressWarnings("unused") // Used by markdown template.
public String getName() {
return name;
}
+ @SuppressWarnings("unused") // Used by markdown template.
public String getDocString() {
return docString;
}
+
+ @SuppressWarnings("unused") // Used by markdown template.
+ public String getTypeString() {
+ return typeString;
+ }
+
+ /**
+ * Returns a string representing whether this attribute is required or optional.
+ */
+ @SuppressWarnings("unused") // Used by markdown template.
+ public String getMandatoryString() {
+ return mandatory ? "required" : "optional";
+ }
}
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java b/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
index f9f5495134..9632d5342f 100644
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
+++ b/src/main/java/com/google/devtools/build/skydoc/rendering/MarkdownRenderer.java
@@ -33,7 +33,7 @@ import org.apache.velocity.runtime.resource.loader.JarResourceLoader;
public class MarkdownRenderer {
private static final String TEMPLATE_FILENAME =
- "com/google/devtools/build/skydoc/rendering/templates/test.vm";
+ "com/google/devtools/build/skydoc/rendering/templates/rule.vm";
private final VelocityEngine velocityEngine;
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/test.vm b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/rule.vm
index b1600e9a7f..cd5ebafccb 100644
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/test.vm
+++ b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/rule.vm
@@ -19,7 +19,14 @@ ${ruleInfo.docString}
#foreach ($attribute in $ruleInfo.attributes)
<tr id="#${ruleName}_${attribute.name}">
<td><code>${attribute.name}</code></td>
- <td>${attribute.docString}</td>
+ <td>
+ ${attribute.typeString}; ${attribute.mandatoryString}
+#if (!$attribute.docString.isEmpty())
+ <p>
+ ${attribute.docString}
+ </p>
+#end
+ </td>
</tr>
#end
</tbody>