diff options
author | Florian Weikert <fwe@google.com> | 2016-06-21 08:58:08 +0000 |
---|---|---|
committer | Philipp Wollermann <philwo@google.com> | 2016-06-21 09:59:35 +0000 |
commit | e57eb2a89ac7bacdfe1d1834fbcf68d201cc06a4 (patch) | |
tree | 966f532330cffdb2eda5fb2aae9525be5a5b3573 /src/main/java/com/google | |
parent | cd211eebe4a2eb776ecf7ee65cc5954aa1110e48 (diff) |
Added more pointers to Aspect-related documentation.
--
MOS_MIGRATED_REVID=125428066
Diffstat (limited to 'src/main/java/com/google')
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/packages/SkylarkAspect.java | 7 | ||||
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleClassFunctions.java | 3 |
2 files changed, 8 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/packages/SkylarkAspect.java b/src/main/java/com/google/devtools/build/lib/packages/SkylarkAspect.java index d679273a56..625785de59 100644 --- a/src/main/java/com/google/devtools/build/lib/packages/SkylarkAspect.java +++ b/src/main/java/com/google/devtools/build/lib/packages/SkylarkAspect.java @@ -32,7 +32,12 @@ import javax.annotation.Nullable; /** * A Skylark value that is a result of an 'aspect(..)' function call. */ -@SkylarkModule(name = "aspect", doc = "", documented = false) +@SkylarkModule( + name = "Aspect", + doc = + "For more information about Aspects, please consult the <a href=\"globals.html#aspect\">" + + "documentation of the aspect function</a> or the " + + "<a href=\"../aspects.md\">introduction to Aspects</a>.") public class SkylarkAspect implements SkylarkValue { private final BaseFunction implementation; private final ImmutableList<String> attributeAspects; diff --git a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleClassFunctions.java b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleClassFunctions.java index 60483dafe1..e2d0a15b99 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleClassFunctions.java +++ b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleClassFunctions.java @@ -365,7 +365,8 @@ public class SkylarkRuleClassFunctions { @SkylarkSignature(name = "aspect", doc = - "Creates a new aspect. The result of this function must be stored in a global value.", + "Creates a new aspect. The result of this function must be stored in a global value. " + + "Please see the <a href=\"../aspects.md\">introduction to Aspects</a> for more details.", returnType = SkylarkAspect.class, parameters = { @Param(name = "implementation", type = BaseFunction.class, |