aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/packages
diff options
context:
space:
mode:
authorGravatar Dmitry Lomov <dslomov@google.com>2016-06-28 16:13:35 +0000
committerGravatar Dmitry Lomov <dslomov@google.com>2016-06-29 08:53:49 +0000
commit34cdae35dba538a5d834b9ae18c4e493bbad878c (patch)
treefdfe717f6033aaf26144bd320fff0da0d6a6bc48 /src/main/java/com/google/devtools/build/lib/packages
parent116c2f6724718fc408e0c73c9026d89281c75e87 (diff)
Reorganize Skylark Reference documentation.
-- MOS_MIGRATED_REVID=126081020
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/packages')
-rw-r--r--src/main/java/com/google/devtools/build/lib/packages/Attribute.java8
-rw-r--r--src/main/java/com/google/devtools/build/lib/packages/SkylarkAspect.java9
-rw-r--r--src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java16
3 files changed, 20 insertions, 13 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/packages/Attribute.java b/src/main/java/com/google/devtools/build/lib/packages/Attribute.java
index 7e8cfffec5..5d4fe22386 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/Attribute.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/Attribute.java
@@ -26,6 +26,7 @@ import com.google.common.collect.Sets;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.syntax.ClassObject;
import com.google.devtools.build.lib.syntax.ClassObject.SkylarkClassObject;
import com.google.devtools.build.lib.syntax.EvalException;
@@ -163,10 +164,11 @@ public final class Attribute implements Comparable<Attribute> {
}
/**
- * Declaration how the configuration should change when following a label or
- * label list attribute.
+ * Declaration how the configuration should change when following a label or label list attribute.
*/
- @SkylarkModule(name = "ConfigurationTransition", doc =
+ @SkylarkModule(name = "ConfigurationTransition",
+ category = SkylarkModuleCategory.NONE,
+ doc =
"Declares how the configuration should change when following a dependency. "
+ "It can be either <a href=\"globals.html#DATA_CFG\">DATA_CFG</a> or "
+ "<a href=\"globals.html#HOST_CFG\">HOST_CFG</a>.")
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 625785de59..1a785092b4 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
@@ -19,6 +19,7 @@ import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.skylarkinterface.SkylarkValue;
import com.google.devtools.build.lib.syntax.BaseFunction;
import com.google.devtools.build.lib.syntax.Environment;
@@ -29,15 +30,15 @@ import com.google.devtools.build.lib.util.Preconditions;
import javax.annotation.Nullable;
-/**
- * A Skylark value that is a result of an 'aspect(..)' function call.
- */
+/** A Skylark value that is a result of an 'aspect(..)' function call. */
@SkylarkModule(
name = "Aspect",
+ category = SkylarkModuleCategory.NONE,
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>.")
+ + "<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/packages/SkylarkNativeModule.java b/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java
index 31208ba212..190a46b327 100644
--- a/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java
+++ b/src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java
@@ -16,6 +16,7 @@ package com.google.devtools.build.lib.packages;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.skylarkinterface.SkylarkSignature;
import com.google.devtools.build.lib.syntax.BuiltinFunction;
import com.google.devtools.build.lib.syntax.Environment;
@@ -30,7 +31,10 @@ import com.google.devtools.build.lib.syntax.Type.ConversionException;
/**
* A class for the Skylark native module.
*/
-@SkylarkModule(name = "native", namespace = true, doc =
+@SkylarkModule(name = "native", namespace = true,
+ title = "Native Module",
+ category = SkylarkModuleCategory.TOP_LEVEL_TYPE,
+ doc =
"A built-in module to support native rules and other package helper functions. "
+ "All native rules appear as functions in this module, e.g. <code>native.cc_library</code>. "
+ "Note that the native module is only available in the loading phase "
@@ -46,11 +50,11 @@ public class SkylarkNativeModule {
returnType = SkylarkList.class,
doc =
"Glob returns a list of every file in the current package that:<ul>\n"
- + "<li>Matches at least one pattern in <code>include</code>.</li>\n"
- + "<li>Does not match any of the patterns in <code>exclude</code> "
- + "(default <code>[]</code>).</li></ul>\n"
- + "If the <code>exclude_directories</code> argument is enabled (set to <code>1</code>),"
- + " files of type directory will be omitted from the results (default <code>1</code>).",
+ + "<li>Matches at least one pattern in <code>include</code>.</li>\n"
+ + "<li>Does not match any of the patterns in <code>exclude</code> "
+ + "(default <code>[]</code>).</li></ul>\n"
+ + "If the <code>exclude_directories</code> argument is enabled (set to <code>1</code>),"
+ + " files of type directory will be omitted from the results (default <code>1</code>).",
parameters = {
@Param(
name = "include",