Add documentation for JavaInfo constructor. RELNOTES:none PiperOrigin-RevId: 188066111
diff --git a/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java b/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java index f42d65b..33ef7f8 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java +++ b/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java
@@ -55,7 +55,143 @@ /** A Skylark declared provider that encapsulates all providers that are needed by Java rules. */ @SkylarkModule( name = "JavaInfo", - doc = "Encapsulates all information provided by Java rules", + doc = + "Encapsulates all information provided by Java rules. " + + "<p>JavaInfo can be created in Skylark by calling constructor " + + "<code>JavaInfo(...)</code> " + + "with parameters:</p>" + + "<table class=\"table table-bordered table-condensed table-params\">" + + " <colgroup>" + + " <col class=\"col-param\">" + + " <col class=\"param-description\">" + + " </colgroup>" + + " <thead>" + + " <tr>" + + " <th>Parameter</th>" + + " <th>Description</th>" + + " </tr>" + + " </thead>" + + " <tbody>" + + " <tr>" + + " <td id=\"JavaInfo.output_jar\">" + + " <code>output_jar</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"File.html\">File</a></code></p>" + + " <p>The jar that was created as a result of a compilation (e.g. javac, scalac," + + " etc).</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.sources\">" + + " <code>sources</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"list.html\">sequence</a> or " + + "<a class=\"anchor\" href=\"depset.html\">depset</a> of " + + "<a class=\"anchor\" href=\"File.html\">File</a>s</code></p>" + + " <p>The sources that were used to create the output jar.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.source_jars\">" + + " <code>source_jars</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"list.html\">sequence</a> or " + + "<a class=\"anchor\" href=\"depset.html\">depset</a> of " + + "<a class=\"anchor\" href=\"File.html\">File</a>s</code></p>" + + " <p>The source jars that were used to create the output jar.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.use_ijar\">" + + " <code>use_ijar</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"bool.html\">bool</a> " + + "(default = True, optional)</code></p>" + + " <p>If an ijar of the output jar should be created and stored in the " + + "provider. </p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.neverlink\">" + + " <code>neverlink</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"bool.html\">bool</a> " + + "(default = False, optional)</code></p>" + + " <p>If true only use this library for compilation and not at runtime.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.deps\">" + + " <code>deps</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"list.html\">sequence</a> or " + + "<a class=\"anchor\" href=\"depset.html\">depset</a> of " + + "<a class=\"anchor\" href=\"JavaInfo.html\">JavaInfo</a>s</code></p>" + + " <p>Compile time dependencies that were used to create the output jar.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.runtime_deps\">" + + " <code>runtime_deps</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"list.html\">sequence</a> or " + + "<a class=\"anchor\" href=\"depset.html\">depset</a> of " + + "<a class=\"anchor\" href=\"JavaInfo.html\">JavaInfo</a>s</code></p>" + + " <p>Runtime dependencies that are needed for this library.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.exports\">" + + " <code>exports</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"list.html\">sequence</a> or " + + "<a class=\"anchor\" href=\"depset.html\">depset</a> of " + + "<a class=\"anchor\" href=\"JavaInfo.html\">JavaInfo</a>s</code></p>" + + " <p>Libraries to make available for users of this library. See also " + + "<a class=\"anchor\" " + + "href=\"https://docs.bazel.build/versions/master/be/java.html#java_library.exports\">" + + "java_library.exports</a>.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.actions\">" + + " <code>actions</code>" + + " </td>" + + " <td>" + + " <p><code><a class=\"anchor\" href=\"actions.html\">actions</a></code></p>" + + " <p>Used to create the ijar and pack source files to jar actions.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.java_toolchain\">" + + " <code>java_toolchain</code>" + + " </td>" + + " <td>" + + " <p>Target</p>" + + " <p>The toolchain to be used for retrieving the ijar tool and packing source " + + "files to Jar.</p>" + + " </td>" + + " </tr>" + + " <tr>" + + " <td id=\"JavaInfo.host_javabase\">" + + " <code>host_javabase</code>" + + " </td>" + + " <td>" + + " <p>Target</p>" + + " <p>The host_javabase to be used for packing source files to Jar.</p>" + + " </td>" + + " </tr>" + + " </tbody>" + + "</table>" + + "", category = SkylarkModuleCategory.PROVIDER ) @Immutable @@ -567,3 +703,4 @@ } } } +