diff options
author | 2016-06-28 16:13:35 +0000 | |
---|---|---|
committer | 2016-06-29 08:53:49 +0000 | |
commit | 34cdae35dba538a5d834b9ae18c4e493bbad878c (patch) | |
tree | fdfe717f6033aaf26144bd320fff0da0d6a6bc48 /src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java | |
parent | 116c2f6724718fc408e0c73c9026d89281c75e87 (diff) |
Reorganize Skylark Reference documentation.
--
MOS_MIGRATED_REVID=126081020
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java')
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/packages/SkylarkNativeModule.java | 16 |
1 files changed, 10 insertions, 6 deletions
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", |