diff options
5 files changed, 16 insertions, 3 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/BUILD b/src/main/java/com/google/devtools/build/docgen/BUILD index 64d5f8711e..0b1e0a78ff 100644 --- a/src/main/java/com/google/devtools/build/docgen/BUILD +++ b/src/main/java/com/google/devtools/build/docgen/BUILD @@ -9,6 +9,7 @@ java_library( srcs = glob(["**/*.java"]), resources = [":template_files"], deps = [ + "//src/main/java/com/google/devtools/build/lib:android-rules", "//src/main/java/com/google/devtools/build/lib:build-base", "//src/main/java/com/google/devtools/build/lib:common", "//src/main/java/com/google/devtools/build/lib:java-rules", diff --git a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationCollector.java b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationCollector.java index 1eabec0b2c..20a79ccd6b 100644 --- a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationCollector.java +++ b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationCollector.java @@ -22,9 +22,12 @@ import com.google.devtools.build.docgen.skylark.SkylarkModuleDoc; import com.google.devtools.build.lib.analysis.TransitiveInfoCollection; import com.google.devtools.build.lib.rules.SkylarkModules; import com.google.devtools.build.lib.rules.SkylarkRuleContext; +import com.google.devtools.build.lib.rules.android.AndroidSkylarkApiProvider; import com.google.devtools.build.lib.rules.apple.AppleConfiguration; import com.google.devtools.build.lib.rules.cpp.CppConfiguration; import com.google.devtools.build.lib.rules.java.JavaConfiguration; +import com.google.devtools.build.lib.rules.java.JavaRuleOutputJarsProvider; +import com.google.devtools.build.lib.rules.java.JavaSkylarkApiProvider; import com.google.devtools.build.lib.rules.java.Jvm; import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable; import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; @@ -172,10 +175,14 @@ final class SkylarkDocumentationCollector { Map<SkylarkModule, Class<?>> modules = new HashMap<>(); collectBuiltinModule(modules, SkylarkRuleContext.class); collectBuiltinModule(modules, TransitiveInfoCollection.class); + collectBuiltinModule(modules, AppleConfiguration.class); collectBuiltinModule(modules, CppConfiguration.class); collectBuiltinModule(modules, JavaConfiguration.class); collectBuiltinModule(modules, Jvm.class); + collectBuiltinModule(modules, JavaSkylarkApiProvider.class); + collectBuiltinModule(modules, JavaRuleOutputJarsProvider.OutputJar.class); + collectBuiltinModule(modules, AndroidSkylarkApiProvider.class); return modules; } diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java index 707e8ed794..a8b81ddbaf 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java @@ -36,7 +36,8 @@ import javax.annotation.Nullable; */ @SkylarkModule( name = "AndroidSkylarkApiProvider", - doc = "Provides access to information about Android rules" + doc = "Provides access to information about Android rules. Every Android-related target provides " + + "this struct, accessible as a 'java' field on a Target struct." ) public class AndroidSkylarkApiProvider extends SkylarkApiProvider { /** The name of the field in Skylark used to access this class. */ diff --git a/src/main/java/com/google/devtools/build/lib/rules/cpp/CcSkylarkApiProvider.java b/src/main/java/com/google/devtools/build/lib/rules/cpp/CcSkylarkApiProvider.java index 8bffba6719..674e68c6ca 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/cpp/CcSkylarkApiProvider.java +++ b/src/main/java/com/google/devtools/build/lib/rules/cpp/CcSkylarkApiProvider.java @@ -28,7 +28,9 @@ import com.google.devtools.build.lib.vfs.PathFragment; * simple and stable interface for Skylark users. */ @SkylarkModule( - name = "CcSkylarkApiProvider", doc = "Provides access to information about C++ rules") + name = "CcSkylarkApiProvider", doc = "Provides access to information about C++ rules. " + + "Every C++-related target provides this struct, accessible as a 'cc' field on " + + "a Target struct.") public final class CcSkylarkApiProvider extends SkylarkApiProvider { /** The name of the field in Skylark used to access this class. */ public static final String NAME = "cc"; diff --git a/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkApiProvider.java b/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkApiProvider.java index f06dd905d6..0ec029e1fd 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkApiProvider.java +++ b/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkApiProvider.java @@ -28,7 +28,9 @@ import com.google.devtools.build.lib.skylarkinterface.SkylarkModule; * simple and stable interface for Skylark users. */ @SkylarkModule( - name = "JavaSkylarkApiProvider", doc = "Provides access to information about Java rules") + name = "JavaSkylarkApiProvider", + doc = "Provides access to information about Java rules. Every Java-related target provides " + + "this struct, accessible as a 'java' field on a Target struct.") public final class JavaSkylarkApiProvider extends SkylarkApiProvider { /** The name of the field in Skylark used to access this class. */ public static final String NAME = "java"; |