Expose loadStatement in template

Author: fmeum

docs/stardoc_rule.md

@@ -8,6 +8,7 @@ Starlark rule for stardoc: a documentation generator tool written in Java.
 
 <pre>
 load("@stardoc//stardoc:stardoc.bzl", "stardoc")
+
 stardoc(<a href="#stardoc-name">name</a>, <a href="#stardoc-input">input</a>, <a href="#stardoc-out">out</a>, <a href="#stardoc-deps">deps</a>, <a href="#stardoc-format">format</a>, <a href="#stardoc-symbol_names">symbol_names</a>, <a href="#stardoc-renderer">renderer</a>, <a href="#stardoc-aspect_template">aspect_template</a>, <a href="#stardoc-func_template">func_template</a>,
         <a href="#stardoc-header_template">header_template</a>, <a href="#stardoc-table_of_contents_template">table_of_contents_template</a>, <a href="#stardoc-provider_template">provider_template</a>, <a href="#stardoc-rule_template">rule_template</a>,
         <a href="#stardoc-repository_rule_template">repository_rule_template</a>, <a href="#stardoc-module_extension_template">module_extension_template</a>, <a href="#stardoc-footer_template">footer_template</a>, <a href="#stardoc-render_main_repo_name">render_main_repo_name</a>,

src/main/java/com/google/devtools/build/stardoc/rendering/MarkdownUtil.java

@@ -219,7 +219,7 @@ public static String markdownCodeSpan(String code) {
   public String ruleSummary(String ruleName, RuleInfo ruleInfo) {
     ImmutableList<String> attributeNames =
         ruleInfo.getAttributeList().stream().map(AttributeInfo::getName).collect(toImmutableList());
-    return maybeLoad(ruleName) + summary(ruleName, attributeNames);
+    return summary(ruleName, attributeNames);
   }
 
   /**
@@ -233,7 +233,7 @@ public String providerSummary(String providerName, ProviderInfo providerInfo) {
         providerInfo.getFieldInfoList().stream()
             .map(StardocOutputProtos.ProviderFieldInfo::getName)
             .collect(toImmutableList());
-    return maybeLoad(providerName) + summary(providerName, fieldNames);
+    return summary(providerName, fieldNames);
   }
 
   /**
@@ -247,16 +247,7 @@ public String aspectSummary(String aspectName, AspectInfo aspectInfo) {
         aspectInfo.getAttributeList().stream()
             .map(AttributeInfo::getName)
             .collect(toImmutableList());
-    String aspectFlag =
-        entrypointBzlFile
-            // Namespaced aspects can't be referenced on the command line.
-            .filter(unused -> !aspectName.contains("."))
-            .map(
-                file ->
-                    String.format(
-                        "# or on the command line:\n# --aspects=%s%%%s\n", file, aspectName))
-            .orElse("");
-    return maybeLoad(aspectName) + aspectFlag + summary(aspectName, attributeNames);
+    return summary(aspectName, attributeNames);
   }
 
   /**
@@ -270,7 +261,7 @@ public String aspectSummary(String aspectName, AspectInfo aspectInfo) {
   public String repositoryRuleSummary(String ruleName, RepositoryRuleInfo ruleInfo) {
     ImmutableList<String> attributeNames =
         ruleInfo.getAttributeList().stream().map(AttributeInfo::getName).collect(toImmutableList());
-    return maybeLoad(ruleName) + summary(ruleName, attributeNames);
+    return summary(ruleName, attributeNames);
   }
 
   /**
@@ -319,12 +310,13 @@ public String funcSummary(StarlarkFunctionInfo funcInfo) {
         funcInfo.getParameterList().stream()
             .map(FunctionParamInfo::getName)
             .collect(toImmutableList());
-    return maybeLoad(funcInfo.getFunctionName()) + summary(funcInfo.getFunctionName(), paramNames);
+    return summary(funcInfo.getFunctionName(), paramNames);
   }
 
-  private String maybeLoad(String name) {
+  @SuppressWarnings("unused") // Used by markdown template.
+  public String loadStatement(String name) {
     return entrypointBzlFile
-        .map(file -> String.format("load(\"%s\", \"%s\")\n", file, name.split("\\.")[0]))
+        .map(file -> String.format("load(\"%s\", \"%s\")", file, name.split("\\.")[0]))
         .orElse("");
   }
 

stardoc/templates/html_tables/aspect.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${aspectName}
 
 <pre>
+${util.loadStatement($aspectName)}
+
 ${util.aspectSummary($aspectName, $aspectInfo)}
 </pre>
 

stardoc/templates/html_tables/func.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${funcInfo.functionName}
 
 <pre>
+${util.loadStatement($funcInfo.functionName)}
+
 ${util.funcSummary($funcInfo)}
 </pre>
 

stardoc/templates/html_tables/provider.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${providerName}
 
 <pre>
+${util.loadStatement($providerName)}
+
 ${util.providerSummary($providerName, $providerInfo)}
 </pre>
 

stardoc/templates/html_tables/repository_rule.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${ruleName}
 
 <pre>
+${util.loadStatement($ruleName)}
+
 ${util.repositoryRuleSummary($ruleName, $ruleInfo)}
 </pre>
 #if (!$ruleInfo.docString.isEmpty())

stardoc/templates/html_tables/rule.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${ruleName}
 
 <pre>
+${util.loadStatement($ruleName)}
+
 ${util.ruleSummary($ruleName, $ruleInfo)}
 </pre>
 

stardoc/templates/markdown_tables/aspect.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${aspectName}
 
 <pre>
+${util.loadStatement($aspectName)}
+
 ${util.aspectSummary($aspectName, $aspectInfo)}
 </pre>
 

stardoc/templates/markdown_tables/func.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${funcInfo.functionName}
 
 <pre>
+${util.loadStatement($funcInfo.functionName)}
+
 ${util.funcSummary($funcInfo)}
 </pre>
 

stardoc/templates/markdown_tables/provider.vm

@@ -3,6 +3,8 @@
 #[[##]]# ${providerName}
 
 <pre>
+${util.loadStatement($providerName)}
+
 ${util.providerSummary($providerName, $providerInfo)}
 </pre>