aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorGravatar gregce <gregce@google.com>2017-07-14 22:21:36 +0200
committerGravatar Jakob Buchgraber <buchgr@google.com>2017-07-17 10:11:01 +0200
commitd5cfbfe3d7e5669191639d31c5048358ca7f0892 (patch)
tree681803178373194eb2d3945b5e8ab7a59e0cbcee /src
parentd1c4d22f548880f1c6b159735040dbba4c513eeb (diff)
Add new type descriptions for rule attribute documentation.
Motivation: properly document config_setting.values. The license type description is terse. But that's an obscure feature we don't really want to focus attention on. PiperOrigin-RevId: 161998339
Diffstat (limited to 'src')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java b/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
index aec9eb1d91..5f543f9796 100644
--- a/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
+++ b/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
@@ -43,6 +43,7 @@ public class RuleDocumentationAttribute implements Comparable<RuleDocumentationA
.put(Type.INTEGER, "Integer")
.put(Type.INTEGER_LIST, "List of integers")
.put(Type.STRING, "String")
+ .put(Type.STRING_DICT, "Dictionary: String -> String")
.put(Type.STRING_LIST, "List of strings")
.put(BuildType.TRISTATE, "Integer")
.put(BuildType.LABEL, "<a href=\"../build-ref.html#labels\">Label</a>")
@@ -50,6 +51,7 @@ public class RuleDocumentationAttribute implements Comparable<RuleDocumentationA
.put(
BuildType.LABEL_DICT_UNARY,
"Dictionary mapping strings to <a href=\"../build-ref.html#labels\">labels</a>")
+ .put(BuildType.LICENSE, "Licence type")
.put(BuildType.NODEP_LABEL, "<a href=\"../build-ref.html#name\">Name</a>")
.put(BuildType.NODEP_LABEL_LIST, "List of <a href=\"../build-ref.html#name\">names</a>")
.put(BuildType.OUTPUT, "<a href=\"../build-ref.html#filename\">Filename</a>")