aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/analysis
diff options
context:
space:
mode:
authorGravatar Dave MacLachlan <dmaclach@google.com>2016-03-02 04:15:09 +0000
committerGravatar Kristina Chodorow <kchodorow@google.com>2016-03-02 17:55:06 +0000
commitfc8c58a137229200cb03cb70169fa013d5680e82 (patch)
tree354f9bc3804da4af8f155ff6e473a8ccbc0e18f2 /src/main/java/com/google/devtools/build/lib/analysis
parent8091b2b42bfd9113513aa68294ddc6160cb6500f (diff)
Add documentation for fragments type, and add the four fragments (apple, cpp, java, jvm) to the documentation.
-- MOS_MIGRATED_REVID=116092594
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/analysis')
-rw-r--r--src/main/java/com/google/devtools/build/lib/analysis/config/FragmentCollection.java7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/config/FragmentCollection.java b/src/main/java/com/google/devtools/build/lib/analysis/config/FragmentCollection.java
index acc930afef..f1ff98f83b 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/config/FragmentCollection.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/config/FragmentCollection.java
@@ -28,7 +28,12 @@ import javax.annotation.Nullable;
*/
// Documentation can be found at ctx.fragments
@Immutable
-@SkylarkModule(name = "fragments", documented = false, doc = "")
+@SkylarkModule(name = "fragments", doc = "Possible fields are "
+ + "<a href=\"apple.html\">apple</a>, <a href=\"cpp.html\">cpp</a>, "
+ + "<a href=\"java.html\">java</a> and <a href=\"jvm.html\">jvm</a>. "
+ + "Access a specific fragment by its field name ex:</p><code>ctx.fragments.apple</code></p>"
+ + "Note that rules have to declare their required fragments in order to access them "
+ + "(see <a href=\"../rules.html#fragments\">here</a>).")
public class FragmentCollection implements ClassObject {
private final RuleContext ruleContext;
private final ConfigurationTransition config;