commit fe42154578c6b4a39e700451f497741d2bb8ec8b
author John Cater <jcater@google.com> Mon Jul 08 13:30:42 2019 -0700
committer Copybara-Service <copybara-worker@google.com> Mon Jul 08 13:31:37 2019 -0700
tree a0dd6e96c3e37b4657a07ad612ddb5bf9e517d17
parent 0321a15be38a71f9d3a5aa4ac6dc0f27807f52bf

Improve the docs for ToolchainInfo and link to the main toolchains do?

?c page.

Closes #8821.

PiperOrigin-RevId: 257044964

src/main/java/com/google/devtools/build/lib/skylarkbuildapi/platform/ToolchainInfoApi.java

diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/platform/ToolchainInfoApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/platform/ToolchainInfoApi.java
index ab37760..868c280 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/platform/ToolchainInfoApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/platform/ToolchainInfoApi.java
@@ -18,13 +18,12 @@
 import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
 import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
 
-/**
- * Info object representing data about a specific toolchain.
- */
+/** Info object representing data about a specific toolchain. */
 @SkylarkModule(
     name = "ToolchainInfo",
-    doc = "Provides access to data about a specific toolchain.",
-    category = SkylarkModuleCategory.PROVIDER
-)
-public interface ToolchainInfoApi extends StructApi {
-}
+    doc =
+        "Provider which allows rule-specific toolchains to communicate data back to the actual"
+            + " rule implementation. Read more about <a"
+            + " href='../../toolchains.$DOC_EXT'>toolchains</a> for more information.",
+    category = SkylarkModuleCategory.PROVIDER)
+public interface ToolchainInfoApi extends StructApi {}