commit 27a91eb6a9dfd2db9cffad894833d92c8cb42c9b
author gregce <gregce@google.com> Tue Apr 04 22:30:25 2017 +0000
committer Damien Martin-Guillerez <dmarting@google.com> Wed Apr 05 15:19:54 2017 +0200
tree cc5b07f9342dc7aabc1e1f8e836adb98c8b0b10c
parent e11775c2394fc48ac7fe5b632b47ae952dd552b4

Hyperlink "nonconfigurable"-tagged attributes to Bazel's
configurable attributes documentation.

PiperOrigin-RevId: 152188409

src/main/java/com/google/devtools/build/docgen/RuleDocumentation.java

diff --git a/src/main/java/com/google/devtools/build/docgen/RuleDocumentation.java b/src/main/java/com/google/devtools/build/docgen/RuleDocumentation.java
index f173bdf..6b9d5ae 100644
--- a/src/main/java/com/google/devtools/build/docgen/RuleDocumentation.java
+++ b/src/main/java/com/google/devtools/build/docgen/RuleDocumentation.java
@@ -60,6 +60,11 @@
   private RuleLinkExpander linkExpander;
 
   /**
+   * Name of the page documenting common build rule terms and concepts.
+   */
+  static final String COMMON_DEFINITIONS_PAGE = "common-definitions.html";
+
+  /**
    * Creates a RuleDocumentation from the rule's name, type, family and raw html documentation
    * (meaning without expanding the variables in the doc).
    */
@@ -250,7 +255,8 @@
       String attrName = attributeDoc.getAttributeName();
       // Generate the link for the attribute documentation
       if (attributeDoc.isCommonType()) {
-        sb.append(String.format("<a href=\"common-definitions.html#%s.%s\">%s</a>",
+        sb.append(String.format("<a href=\"%s#%s.%s\">%s</a>",
+            COMMON_DEFINITIONS_PAGE,
             attributeDoc.getGeneratedInRule(ruleName).toLowerCase(),
             attrName,
             attrName));

src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java

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 b655284..aec9eb1 100644
--- a/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
+++ b/src/main/java/com/google/devtools/build/docgen/RuleDocumentationAttribute.java
@@ -182,7 +182,10 @@
     StringBuilder sb = new StringBuilder()
         .append(TYPE_DESC.get(attribute.getType()))
         .append("; " + (attribute.isMandatory() ? "required" : "optional"))
-        .append(!attribute.isConfigurable() ? "; nonconfigurable" : "")
+        .append(!attribute.isConfigurable()
+            ? String.format("; <a href=\"%s#configurable-attributes\">nonconfigurable</a>",
+                RuleDocumentation.COMMON_DEFINITIONS_PAGE)
+            : "")
         .append(getDefaultValue());
     return sb.toString();
   }