aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib
diff options
context:
space:
mode:
authorGravatar Dmitry Lomov <dslomov@google.com>2016-03-14 12:13:18 +0000
committerGravatar Dmitry Lomov <dslomov@google.com>2016-03-14 13:59:52 +0000
commit692b127f413ba0649c3505cc4c8ca464593aa44c (patch)
tree7913bad448091ba0a3273d6f5e5fff6009fbd9b4 /src/main/java/com/google/devtools/build/lib
parent8cad4bd417584d01157326742fea024196e77b26 (diff)
Expose more documentation to Skylark.
-- MOS_MIGRATED_REVID=117123912
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/android/AndroidSkylarkApiProvider.java3
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/cpp/CcSkylarkApiProvider.java4
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkApiProvider.java4
3 files changed, 8 insertions, 3 deletions
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";