Add docs for the Starlark toolchain type APIs.

Removed the previous placeholder text. PiperOrigin-RevId: 433251900
bazelbuild · Mar 8, 2022 · 7bb2525 · 7bb2525
1 parent b59498a
commit 7bb2525
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/...n/java/com/google/devtools/build/lib/starlarkbuildapi/config/ConfigStarlarkCommonApi.java b/...n/java/com/google/devtools/build/lib/starlarkbuildapi/config/ConfigStarlarkCommonApi.java
@@ -60,14 +60,14 @@ public interface ConfigStarlarkCommonApi extends StarlarkValue {
               @ParamType(type = Label.class),
             },
             named = false,
-            doc = "TKTK"),
+            doc = "The toolchain type that is required."),
         @Param(
             name = "mandatory",
             allowedTypes = {@ParamType(type = Boolean.class)},
             named = true,
             positional = false,
             defaultValue = "True",
-            doc = "TKTK")
+            doc = "Whether the toolchain type is mandatory or optional.")
       },
       useStarlarkThread = true)
   StarlarkToolchainTypeRequirement toolchainType(

diff --git a/...m/google/devtools/build/lib/starlarkbuildapi/config/StarlarkToolchainTypeRequirement.java b/...m/google/devtools/build/lib/starlarkbuildapi/config/StarlarkToolchainTypeRequirement.java
@@ -21,12 +21,21 @@
 import net.starlark.java.eval.StarlarkValue;
 
 /** Starlark API for accessing details of a ToolchainTypeRequirement. */
-@StarlarkBuiltin(name = "toolchain_type", category = DocCategory.BUILTIN, doc = "TKTK")
+@StarlarkBuiltin(
+    name = "toolchain_type",
+    category = DocCategory.BUILTIN,
+    doc = "A data type describing a dependency on a specific toolchain type.")
 public interface StarlarkToolchainTypeRequirement extends StarlarkValue {
 
-  @StarlarkMethod(name = "toolchain_type", doc = "TKTK", structField = true)
+  @StarlarkMethod(
+      name = "toolchain_type",
+      doc = "The toolchain type that is required.",
+      structField = true)
   Label toolchainType();
 
-  @StarlarkMethod(name = "mandatory", doc = "TKTK", structField = true)
+  @StarlarkMethod(
+      name = "mandatory",
+      doc = "Whether the toolchain type is mandatory or optional.",
+      structField = true)
   boolean mandatory();
 }