aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
diff options
context:
space:
mode:
authorGravatar Googler <noreply@google.com>2015-03-19 15:24:12 +0000
committerGravatar Han-Wen Nienhuys <hanwen@google.com>2015-03-20 14:34:38 +0000
commit1a03eccae276227853d693c208ff623b9cf3d902 (patch)
tree5493940fcfd3c48fa370579c587619c46f9904e0 /src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
parente63a0da2d84423f76a1a9b6de56dbf45528ec759 (diff)
Skylark: documentation for targets is added and improved.
-- MOS_MIGRATED_REVID=89032399
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
index d8a7fc8f08..b9c44558ba 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
@@ -323,8 +323,9 @@ public final class SkylarkRuleContext {
@SkylarkCallable(name = "target", structField = true,
doc = "A <code>struct</code> containing prerequisite targets defined in label type "
+ "attributes. The struct fields correspond to the attribute names. The struct value "
- + "is always a <code>target</code> or <code>None</code>. If an optional attribute "
- + "is not specified in the rule, the corresponding struct value is <code>None</code>.")
+ + "is always a <a href=\"#modules.Target\"><code>Target</code></a> or <code>None</code>. "
+ + "If an optional attribute is not specified in the rule, the corresponding struct "
+ + "value is <code>None</code>.")
public SkylarkClassObject getTarget() {
return targetObject;
}
@@ -335,12 +336,12 @@ public final class SkylarkRuleContext {
@SkylarkCallable(name = "targets", structField = true,
doc = "A <code>struct</code> containing prerequisite targets defined in label or label list "
+ "type attributes. The struct fields correspond to the attribute names. The struct "
- + "values are <code>list</code> of <code>target</code>s. If an optional attribute is "
- + "not specified in the rule, an empty list is generated.")
+ + "values are <code>list</code> of <a href=\"#modules.Target\"><code>Target</code></a>s. "
+ + "If an optional attribute is not specified in the rule, an empty list is generated.")
public SkylarkClassObject getTargets() {
return targetsObject;
}
-
+
@SkylarkCallable(name = "workspace_name", structField = true,
doc = "Returns the workspace name as defined in the WORKSPACE file.")
public String getWorkspaceName() {