diff options
| author |  David Chen <dzc@google.com> | 2016-01-28 12:31:29 +0000 |
|---|---|---|
| committer |  Kristina Chodorow <kchodorow@google.com> | 2016-01-28 15:30:27 +0000 |
| commit | c63b90f8828cf5c5c17d028d2e1a41371bf11c24 (patch) | |
| tree | 5e846bc6a1725d87ff55ad9ae06f8a49395b0612 /src | |
| parent | 844312c4fb5ac85592b9525f4efd2577103f0b1a (diff) | |
Remove unused ${SYNOPSIS} variable from Bazel native rule inline documentation.
This variable is no longer used because the docgen template directly calls
RuleDocumentationAttribte.getSynopsis() instead of using the SYNOPSIS variable,
and RuleDocumentationAttribute.getHtmlDocumentation() resolves the SYNOPSIS
variable to the empty string.
--
MOS_MIGRATED_REVID=113249993
Diffstat (limited to 'src')
51 files changed, 0 insertions, 215 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/config/ConfigRuleClasses.java b/src/main/java/com/google/devtools/build/lib/analysis/config/ConfigRuleClasses.java index cab80a37e0..47e1d64c41 100644 --- a/src/main/java/com/google/devtools/build/lib/analysis/config/ConfigRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/analysis/config/ConfigRuleClasses.java @@ -112,7 +112,6 @@ public class ConfigRuleClasses { return builder /* <!-- #BLAZE_RULE(config_setting).ATTRIBUTE(values) --> The set of configuration values that match this rule (expressed as Blaze flags) - ${SYNOPSIS} <i>(Dictionary mapping flags to expected values, both expressed as strings; mandatory)</i> diff --git a/src/main/java/com/google/devtools/build/lib/analysis/constraints/EnvironmentRule.java b/src/main/java/com/google/devtools/build/lib/analysis/constraints/EnvironmentRule.java index 3bd6f42274..48a0182a25 100644 --- a/src/main/java/com/google/devtools/build/lib/analysis/constraints/EnvironmentRule.java +++ b/src/main/java/com/google/devtools/build/lib/analysis/constraints/EnvironmentRule.java @@ -42,7 +42,6 @@ public class EnvironmentRule implements RuleDefinition { .nonconfigurable("low-level attribute, used in TargetUtils without configurations")) /* <!-- #BLAZE_RULE(environment).ATTRIBUTE(fulfills) --> The set of environments this one is considered a valid "standin" for. - ${SYNOPSIS} <p> If rule A depends on rule B, A declares compatibility with environment <code>:foo</code>, and B declares compatibility with environment <code>:bar</code>, this is normally not diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelActionListenerRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelActionListenerRule.java index 2b198f5385..a7c9fa69b3 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelActionListenerRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelActionListenerRule.java @@ -34,7 +34,6 @@ public final class BazelActionListenerRule implements RuleDefinition { /*<!-- #BLAZE_RULE(action_listener).ATTRIBUTE(mnemonics) --> A list of action mnemonics this <code>action_listener</code> should listen for, e.g. <code>[ "Javac" ]</code>. - ${SYNOPSIS} <p> Mnemonics are not a public interface. There's no guarantee that the mnemonics and their actions don't change. @@ -44,7 +43,6 @@ public final class BazelActionListenerRule implements RuleDefinition { /*<!-- #BLAZE_RULE(action_listener).ATTRIBUTE(extra_actions) --> A list of <code><a href="#extra_action">extra_action</a></code> targets this <code>action_listener</code> should add to the build graph. - ${SYNOPSIS} E.g. <code>[ "//my/tools:analyzer" ]</code>. <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("extra_actions", LABEL_LIST).mandatory() diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelExtraActionRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelExtraActionRule.java index d4fc70b149..ea3ce53fa2 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelExtraActionRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelExtraActionRule.java @@ -40,7 +40,6 @@ public final class BazelExtraActionRule implements RuleDefinition { return builder /*<!-- #BLAZE_RULE(extra_action).ATTRIBUTE(tools) --> A list of <code>tool</code> dependencies for this rule. - ${SYNOPSIS} <p> See the definition of <a href="../build-ref.html#deps">dependencies</a> for more information. @@ -62,7 +61,6 @@ public final class BazelExtraActionRule implements RuleDefinition { .add(attr("tools", LABEL_LIST).cfg(HOST).allowedFileTypes().exec()) /*<!-- #BLAZE_RULE(extra_action).ATTRIBUTE(out_templates) --> A list of templates for files generated by the <code>extra_action</code> command. - ${SYNOPSIS} <p> The template can use the following variables: <ul> @@ -76,7 +74,6 @@ public final class BazelExtraActionRule implements RuleDefinition { .add(attr("out_templates", STRING_LIST)) /*<!-- #BLAZE_RULE(extra_action).ATTRIBUTE(cmd) --> The command to run. - ${SYNOPSIS} <p> Like <a href="general.html#genrule.cmd">genrule cmd attribute</a> with the following differences: @@ -109,7 +106,6 @@ public final class BazelExtraActionRule implements RuleDefinition { /*<!-- #BLAZE_RULE(extra_action).ATTRIBUTE(requires_action_output) --> Indicates this <code>extra_action</code> requires the output of the original action to be present as input to this <code>extra_action</code>. - ${SYNOPSIS} <p> When true (default false), the extra_action can assume that the original action outputs are available as part of its inputs. diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelFilegroupRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelFilegroupRule.java index d5d26dfa0d..f0cbe8dfb3 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelFilegroupRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelFilegroupRule.java @@ -37,7 +37,6 @@ public final class BazelFilegroupRule implements RuleDefinition { return builder /*<!-- #BLAZE_RULE(filegroup).ATTRIBUTE(srcs) --> The list of targets that are members of the file group. - ${SYNOPSIS} <p> It is common to use the result of a <a href="functions.html#glob">glob</a> expression for the value @@ -49,7 +48,6 @@ public final class BazelFilegroupRule implements RuleDefinition { .add(attr("srcs", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)) /*<!-- #BLAZE_RULE(filegroup).ATTRIBUTE(data) --> The list of files needed by this rule at runtime. - ${SYNOPSIS} <p> Targets named in the <code>data</code> attribute will be added to the <code>runfiles</code> of this <code>filegroup</code> rule. When the @@ -64,7 +62,6 @@ public final class BazelFilegroupRule implements RuleDefinition { .add(attr("output_licenses", LICENSE)) /*<!-- #BLAZE_RULE(filegroup).ATTRIBUTE(path) --> An optional string to set a path to the files in the group, relative to the package path. - ${SYNOPSIS} <p> This attribute can be used internally by other rules depending on this <code>filegroup</code> to find the name of the directory holding the files. diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelTestSuiteRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelTestSuiteRule.java index 57fe10b6ae..8e244f584b 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelTestSuiteRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/common/BazelTestSuiteRule.java @@ -35,7 +35,6 @@ public final class BazelTestSuiteRule implements RuleDefinition { .nonconfigurable("policy decision: should be consistent across configurations")) /* <!-- #BLAZE_RULE(test_suite).ATTRIBUTE(tags) --> List of text tags such as "small" or "database" or "-flaky". Tags may be any valid string. - ${SYNOPSIS} <p> Tags which begin with a "-" character are considered negative tags. The preceding "-" character is not considered part of the tag, so a suite tag @@ -75,7 +74,6 @@ public final class BazelTestSuiteRule implements RuleDefinition { /* <!-- #BLAZE_RULE(test_suite).ATTRIBUTE(tests) --> A list of test suites and test targets of any language. - ${SYNOPSIS} <p> Any <code>*_test</code> is accepted here, independent of the language. No <code>*_binary</code> targets are accepted however, even if they happen to run a test. diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/cpp/BazelCppRuleClasses.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/cpp/BazelCppRuleClasses.java index 4a91260cae..c94b48160b 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/cpp/BazelCppRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/cpp/BazelCppRuleClasses.java @@ -251,7 +251,6 @@ public class BazelCppRuleClasses { return builder /*<!-- #BLAZE_RULE($cc_base_rule).ATTRIBUTE(copts) --> Add these options to the C++ compilation command. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization"> Bourne shell tokenization</a>. @@ -288,7 +287,6 @@ public class BazelCppRuleClasses { /*<!-- #BLAZE_RULE($cc_decl_rule).ATTRIBUTE(abi)[DEPRECATED] --> Platform-specific information string which is used in combination with <code>abi_deps</code>. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make" variable</a> substitution. <p> This string typically includes references to one or more "Make" variables of the form @@ -355,7 +353,6 @@ public class BazelCppRuleClasses { .add(attr("abi_deps", LABEL_LIST_DICT)) /*<!-- #BLAZE_RULE($cc_decl_rule).ATTRIBUTE(defines) --> List of defines to add to the compile line. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make" variable</a> substitution and <a href="common-definitions.html#sh-tokenization"> Bourne shell tokenization</a>. @@ -370,7 +367,6 @@ public class BazelCppRuleClasses { .add(attr("defines", STRING_LIST)) /*<!-- #BLAZE_RULE($cc_decl_rule).ATTRIBUTE(includes) --> List of include dirs to be added to the compile line. - ${SYNOPSIS} <p>Subject to <a href="make-variables.html">"Make variable"</a> substitution. Each string is prepended with <code>-isystem</code> and added to <code>COPTS</code>. Unlike <a href="#cc_binary.copts">COPTS</a>, these flags are added for this rule @@ -410,7 +406,6 @@ public class BazelCppRuleClasses { return builder /*<!-- #BLAZE_RULE($cc_rule).ATTRIBUTE(srcs) --> The list of C and C++ files that are processed to create the target. - ${SYNOPSIS} These are C/C++ source and header files, either non-generated (normal source code) or generated. <p>All <code>.cc</code>, <code>.c</code>, and <code>.cpp</code> files will @@ -466,7 +461,6 @@ public class BazelCppRuleClasses { .allowedFileTypes(ALLOWED_SRC_FILES)) /*<!-- #BLAZE_RULE($cc_rule).ATTRIBUTE(deps) --> The list of other libraries to be linked in to the binary target. - ${SYNOPSIS} <p>These are always <code>cc_library</code> rules.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .override( @@ -476,7 +470,6 @@ public class BazelCppRuleClasses { .skipAnalysisTimeFileTypeCheck()) /*<!-- #BLAZE_RULE($cc_rule).ATTRIBUTE(linkopts) --> Add these flags to the C++ linker command. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make" variable</a> substitution, <a href="common-definitions.html#sh-tokenization"> Bourne shell tokenization</a> and @@ -494,7 +487,6 @@ public class BazelCppRuleClasses { .add(attr("linkopts", STRING_LIST)) /*<!-- #BLAZE_RULE($cc_rule).ATTRIBUTE(nocopts) --> Remove matching options from the C++ compilation command. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make" variable</a> substitution. The value of this attribute is interpreted as a regular expression. Any preexisting <code>COPTS</code> that match this regular expression @@ -506,7 +498,6 @@ public class BazelCppRuleClasses { .add(attr("nocopts", STRING)) /*<!-- #BLAZE_RULE($cc_rule).ATTRIBUTE(linkstatic) --> Link the binary in mostly-static mode. - ${SYNOPSIS} By default this option is on for <code>cc_binary</code> and off for <code>cc_test</code>. <p> If enabled, this tells the build tool to link in <code>.a</code>'s instead of @@ -575,7 +566,6 @@ public class BazelCppRuleClasses { return builder /*<!-- #BLAZE_RULE($cc_binary_base).ATTRIBUTE(malloc) --> Override the default dependency on malloc. - ${SYNOPSIS} <p> By default, Linux C++ binaries are linked against <code>//tools/cpp:malloc</code>, which is an empty library so the binary ends up using libc malloc. This label must @@ -591,7 +581,6 @@ public class BazelCppRuleClasses { .add(attr(":default_malloc", LABEL).value(DEFAULT_MALLOC)) /*<!-- #BLAZE_RULE($cc_binary_base).ATTRIBUTE(stamp) --> Enable link stamping. - ${SYNOPSIS} Whether to encode build information into the binary. Possible values: <ul> <li><code>stamp = 1</code>: Stamp the build information into the @@ -642,7 +631,6 @@ public class BazelCppRuleClasses { .setImplicitOutputsFunction(CC_BINARY_IMPLICIT_OUTPUTS) /*<!-- #BLAZE_RULE(cc_binary).ATTRIBUTE(linkshared) --> Create a shared library. - ${SYNOPSIS} To enable this attribute, include <code>linkshared=1</code> in your rule. By default this option is off. If you enable it, you must name your binary <code>lib<i>foo</i>.so</code> (or whatever is the naming convention of libraries on the @@ -727,7 +715,6 @@ public class BazelCppRuleClasses { /*<!-- #BLAZE_RULE($cc_library).ATTRIBUTE(hdrs) --> The list of header files published by this library to be directly included by sources in dependent rules. - ${SYNOPSIS} <p>This is the strongly preferred location for declaring header files that describe the interface for the library. These headers will be made available for inclusion by sources in this rule or in dependent rules. @@ -741,7 +728,6 @@ public class BazelCppRuleClasses { /* <!-- #BLAZE_RULE($cc_library).ATTRIBUTE(textual_hdrs) --> The list of header files published by this library to be textually included by sources in dependent rules. - ${SYNOPSIS} <p>This is the location for declaring header files that cannot be compiled on their own; that is, they always need to be textually included by other source files to build valid code.</p> @@ -777,7 +763,6 @@ public class BazelCppRuleClasses { If 1, any binary that depends (directly or indirectly) on this C++ library will link in all the object files for the files listed in <code>srcs</code>, even if some contain no symbols referenced by the binary. - ${SYNOPSIS} This is useful if your code isn't explicitly called by code in the binary, e.g., if your code registers to receive some callback provided by some service. diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/genrule/BazelGenRuleRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/genrule/BazelGenRuleRule.java index f1682dd16c..6c63c3eeec 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/genrule/BazelGenRuleRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/genrule/BazelGenRuleRule.java @@ -50,7 +50,6 @@ public final class BazelGenRuleRule implements RuleDefinition { .setOutputToGenfiles() /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(srcs) --> A list of inputs for this rule, such as source files to process. - ${SYNOPSIS} <p> <em>This attributes is not suitable to list tools executed by the <code>cmd</code>; use the <a href="#genrule.tools"><code>tools</code></a> attribute for them instead.</em> @@ -71,7 +70,6 @@ public final class BazelGenRuleRule implements RuleDefinition { /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(tools) --> A list of <i>tool</i> dependencies for this rule. - ${SYNOPSIS} <p> The build system ensures these prerequisites are built before running the genrule command; they are built using the <a href='../blaze-user-manual.html#configurations'><i>host</i> @@ -89,7 +87,6 @@ public final class BazelGenRuleRule implements RuleDefinition { /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(outs) --> A list of files generated by this rule. - ${SYNOPSIS} <p> Output files must not cross package boundaries. Output filenames are interpreted as relative to the package. @@ -103,7 +100,6 @@ public final class BazelGenRuleRule implements RuleDefinition { /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(cmd) --> The command to run. - ${SYNOPSIS} Subject to <a href="#location">$(location)</a> and <a href="make-variables.html">"Make" variable</a> substitution. <ol> @@ -145,7 +141,6 @@ public final class BazelGenRuleRule implements RuleDefinition { .add(attr("cmd", STRING).mandatory()) /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(output_to_bindir) --> - ${SYNOPSIS} <p> If set to 1, this option causes output files to be written into the <code>bin</code> directory instead of the <code>genfiles</code> directory. @@ -156,7 +151,6 @@ public final class BazelGenRuleRule implements RuleDefinition { .nonconfigurable("policy decision: no reason for this to depend on the configuration")) /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(local) --> - ${SYNOPSIS} <p> If set to 1, this option force this <code>genrule</code> to run with the <code>standalone</code> strategy, without sandboxing. @@ -166,7 +160,6 @@ public final class BazelGenRuleRule implements RuleDefinition { /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(message) --> A progress message. - ${SYNOPSIS} <p> A progress message that will be printed as this build step is executed. By default, the message is "Generating <i>output</i>" (or something equally bland) but you may provide a @@ -180,7 +173,6 @@ public final class BazelGenRuleRule implements RuleDefinition { /* <!-- #BLAZE_RULE(genrule).ATTRIBUTE(executable) --> Declare output to be executable. - ${SYNOPSIS} <p> Setting this flag to 1 means the output is an executable file and can be run using the <code>bazel run</code> command. The genrule must produce exactly one output in this case. diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaImportRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaImportRule.java index f6d920a89f..a67b98a834 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaImportRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaImportRule.java @@ -43,7 +43,6 @@ public final class BazelJavaImportRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(deps) --> The list of other libraries to be linked in to the target. - ${SYNOPSIS} See <a href="#java_library.deps">java_library.deps</a>. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("deps", LABEL_LIST) @@ -52,7 +51,6 @@ public final class BazelJavaImportRule implements RuleDefinition { .validityPredicate(ANY_EDGE)) /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(exports) --> Targets to make available to users of this rule. - ${SYNOPSIS} See <a href="#java_library.exports">java_library.exports</a>. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("exports", LABEL_LIST) @@ -61,7 +59,6 @@ public final class BazelJavaImportRule implements RuleDefinition { .validityPredicate(ANY_EDGE)) /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(runtime_deps) --> Libraries to make available to the final binary or test at runtime only. - ${SYNOPSIS} See <a href="#java_library.runtime_deps">java_library.runtime_deps</a>. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("runtime_deps", LABEL_LIST) diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaLibraryRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaLibraryRule.java index 91ec90d5b1..454201f73c 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaLibraryRule.java @@ -55,7 +55,6 @@ public final class BazelJavaLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(java_library).ATTRIBUTE(data) --> The list of files needed by this library at runtime. - ${SYNOPSIS} See general comments about <code>data</code> at <a href="common-definitions.html#common-attributes">Attributes common to all build rules </a>. @@ -69,7 +68,6 @@ public final class BazelJavaLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(java_library).ATTRIBUTE(deps) --> The list of libraries to link into this library. - ${SYNOPSIS} See general comments about <code>deps</code> at <a href="common-definitions.html#common-attributes">Attributes common to all build rules </a>. @@ -87,7 +85,6 @@ public final class BazelJavaLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(java_library).ATTRIBUTE(exports) --> Exported libraries. - ${SYNOPSIS} <p> Listing rules here will make them available to parent rules, as if the parents explicitly depended on these rules. This is not true for regular (non-exported) <code>deps</code>. @@ -123,7 +120,6 @@ public final class BazelJavaLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(java_library).ATTRIBUTE(neverlink) --> Whether this library should only be used for compilation and not at runtime. - ${SYNOPSIS} Useful if the library will be provided by the runtime environment during execution. Examples of such libraries are the IDE APIs for IDE plug-ins or <code>tools.jar</code> for anything running on a standard JDK. @@ -145,7 +141,6 @@ public final class BazelJavaLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(java_library).ATTRIBUTE(exported_plugins) --> The list of <code><a href="#java_plugin">java_plugin</a></code>s (e.g. annotation processors) to export to libraries that directly depend on this library. - ${SYNOPSIS} <p> The specified list of <code>java_plugin</code>s will be applied to any library which directly depends on this library, just as if that library had explicitly declared these diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaPluginRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaPluginRule.java index a02b578ef1..766e936b96 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaPluginRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaPluginRule.java @@ -39,7 +39,6 @@ public final class BazelJavaPluginRule implements RuleDefinition { .override(builder.copy("deps").validityPredicate(Attribute.ANY_EDGE)) .override(builder.copy("srcs").validityPredicate(Attribute.ANY_EDGE)) /* <!-- #BLAZE_RULE(java_plugin).ATTRIBUTE(processor_class) --> - ${SYNOPSIS} The processor class is the fully qualified type of the class that the Java compiler should use as entry point to the annotation processor. If not specified, this rule will not contribute an annotation processor to the Java compiler's annotation processing, but its diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaRuleClasses.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaRuleClasses.java index b065913bcb..0d8ea541cc 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaRuleClasses.java @@ -147,7 +147,6 @@ public class BazelJavaRuleClasses { return builder /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(deps) --> The list of other libraries to be linked in to the target. - ${SYNOPSIS} See general comments about <code>deps</code> at <a href="common-definitions.html#common-attributes">Attributes common to all build rules </a>. @@ -158,7 +157,6 @@ public class BazelJavaRuleClasses { .skipAnalysisTimeFileTypeCheck()) /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(runtime_deps) --> Libraries to make available to the final binary or test at runtime only. - ${SYNOPSIS} Like ordinary <code>deps</code>, these will appear on the runtime classpath, but unlike them, not on the compile-time classpath. Dependencies needed only at runtime should be listed here. Dependency-analysis tools should ignore targets that appear in both @@ -171,7 +169,6 @@ public class BazelJavaRuleClasses { /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(srcs) --> The list of source files that are processed to create the target. - ${SYNOPSIS} This attribute is almost always required; see exceptions below. <p> Source files of type <code>.java</code> are compiled. In case of generated @@ -205,7 +202,6 @@ public class BazelJavaRuleClasses { JavaSemantics.SOURCE_JAR, JavaSemantics.PROPERTIES)) /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(resources) --> A list of data files to include in a Java jar. - ${SYNOPSIS} <p> If resources are specified, they will be bundled in the jar along with the usual <code>.class</code> files produced by compilation. The location of the resources inside @@ -225,7 +221,6 @@ public class BazelJavaRuleClasses { .allowedFileTypes(FileTypeSet.ANY_FILE)) /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(resource_strip_prefix) --> The path prefix to strip from Java resources. - ${SYNOPSIS} <p> If specified, this path prefix is stripped from every file in the <code>resources</code> attribute. It is an error for a resource file not to be under this directory. If not @@ -237,7 +232,6 @@ public class BazelJavaRuleClasses { .add(attr("resource_strip_prefix", STRING)) /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(plugins) --> Java compiler plugins to run at compile-time. - ${SYNOPSIS} Every <code>java_plugin</code> specified in this attribute will be run whenever this rule is built. A library may also inherit plugins from dependencies that use <code><a href="#java_library.exported_plugins">exported_plugins</a></code>. Resources @@ -252,7 +246,6 @@ public class BazelJavaRuleClasses { .value(JavaSemantics.JAVA_PLUGINS)) /* <!-- #BLAZE_RULE($java_rule).ATTRIBUTE(javacopts) --> Extra compiler options for this library. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a>. <p>These compiler options are passed to javac after the global compiler options.</p> @@ -280,7 +273,6 @@ public class BazelJavaRuleClasses { public RuleClass build(Builder builder, final RuleDefinitionEnvironment env) { return builder /* <!-- #BLAZE_RULE($base_java_binary).ATTRIBUTE(classpath_resources) --> - ${SYNOPSIS} <em class="harmful">DO NOT USE THIS OPTION UNLESS THERE IS NO OTHER WAY)</em> <p> A list of resources that must be located at the root of the java tree. This attribute's @@ -292,7 +284,6 @@ public class BazelJavaRuleClasses { .add(attr("classpath_resources", LABEL_LIST).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($base_java_binary).ATTRIBUTE(jvm_flags) --> A list of flags to embed in the wrapper script generated for running this binary. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a>. <p> @@ -310,7 +301,6 @@ public class BazelJavaRuleClasses { Use the <code>com.google.testing.junit.runner.GoogleTestRunner</code> class as the main entry point for a Java program. - ${SYNOPSIS} You can use this to override the default behavior, which is to use <code>BazelTestRunner</code> for @@ -325,7 +315,6 @@ public class BazelJavaRuleClasses { .add(attr("use_testrunner", BOOLEAN).value(false)) /* <!-- #BLAZE_RULE($base_java_binary).ATTRIBUTE(main_class) --> Name of class with <code>main()</code> method to use as entry point. - ${SYNOPSIS} If a rule uses this option, it does not need a <code>srcs=[...]</code> list. Thus, with this attribute one can make an executable from a Java library that already contains one or more <code>main()</code> methods. @@ -340,7 +329,6 @@ public class BazelJavaRuleClasses { .add(attr("main_class", STRING)) /* <!-- #BLAZE_RULE($base_java_binary).ATTRIBUTE(create_executable) --> Whether to build the executable wrapper script or not. - ${SYNOPSIS} If this option is present, no executable wrapper script is built around the <code>.jar</code> file. Incompatible with <code>main_class</code> attribute. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ @@ -357,7 +345,6 @@ public class BazelJavaRuleClasses { } })) /* <!-- #BLAZE_RULE($base_java_binary).ATTRIBUTE(deploy_manifest_lines) --> - ${SYNOPSIS} A list of lines to add to the <code>META-INF/manifest.mf</code> file generated for the <code>*_deploy.jar</code> target. The contents of this attribute are <em>not</em> subject to <a href="make-variables.html">"Make variable"</a> substitution. @@ -365,7 +352,6 @@ public class BazelJavaRuleClasses { .add(attr("deploy_manifest_lines", STRING_LIST)) /* <!-- #BLAZE_RULE($base_java_binary).ATTRIBUTE(stamp) --> Enable link stamping. - ${SYNOPSIS} Whether to encode build information into the binary. Possible values: <ul> <li><code>stamp = 1</code>: Stamp the build information into the binary. Stamped diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaTestRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaTestRule.java index 01de2aef95..07035d7380 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaTestRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/java/BazelJavaTestRule.java @@ -64,7 +64,6 @@ public final class BazelJavaTestRule implements RuleDefinition { .override(attr("main_class", STRING).value(JUNIT4_RUNNER)) /* <!-- #BLAZE_RULE(java_test).ATTRIBUTE(test_class) --> The Java class to be loaded by the test runner.<br/> - ${SYNOPSIS} <p> By default, if this argument is not defined then the legacy mode is used and the test arguments are used instead. Set the <code>--nolegacy_bazel_java_test</code> flag diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/objc/BazelJ2ObjcLibraryRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/objc/BazelJ2ObjcLibraryRule.java index f4e83b2d65..4815526585 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/objc/BazelJ2ObjcLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/objc/BazelJ2ObjcLibraryRule.java @@ -42,7 +42,6 @@ public class BazelJ2ObjcLibraryRule implements RuleDefinition { A list of <code>j2objc_library</code>, <code>java_library</code> and <code>java_import</code> targets that contain Java files to be transpiled to Objective-C. - ${SYNOPSIS} <p>All <code>java_library</code> and <code>java_import</code> targets that can be reached transitively through <code>exports</code>, <code>deps</code> and <code>runtime_deps</code> will be translated and compiled. Currently there is no support for files generated by Java diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyLibraryRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyLibraryRule.java index f10e472e2c..52e6211286 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyLibraryRule.java @@ -33,7 +33,6 @@ public final class BazelPyLibraryRule implements RuleDefinition { .requiresConfigurationFragments(PythonConfiguration.class) /* <!-- #BLAZE_RULE(py_library).ATTRIBUTE(deps) --> The list of other libraries to be linked in to the library target. - ${SYNOPSIS} See general comments about <code>deps</code> at <a href="common-definitions.html#common-attributes"> Attributes common to all build rules</a>. @@ -44,7 +43,6 @@ public final class BazelPyLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(py_library).ATTRIBUTE(data) --> The list of files needed by this library at runtime. - ${SYNOPSIS} See general comments about <code>data</code> at <a href="common-definitions.html#common-attributes"> Attributes common to all build rules</a>. @@ -52,7 +50,6 @@ public final class BazelPyLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(py_library).ATTRIBUTE(srcs) --> The list of source files that are processed to create the target. - ${SYNOPSIS} This includes all your checked-in code and any generated source files. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("srcs", LABEL_LIST) diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyRuleClasses.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyRuleClasses.java index db2268854b..dc6c2b8b3b 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyRuleClasses.java @@ -53,7 +53,6 @@ public final class BazelPyRuleClasses { return builder /* <!-- #BLAZE_RULE($base_py).ATTRIBUTE(deps) --> The list of other libraries to be linked in to the binary target. - ${SYNOPSIS} See general comments about <code>deps</code> at <a href="common-definitions.html#common-attributes"> Attributes common to all build rules</a>. @@ -68,7 +67,6 @@ public final class BazelPyRuleClasses { /* <!-- #BLAZE_RULE($base_py).ATTRIBUTE(srcs_version) --> A string specifying the Python major version(s) that the <code>.py</code> source files listed in the <code>srcs</code> of this rule are compatible with. - ${SYNOPSIS} Valid values are:<br/> <code>"PY2ONLY"</code> - Python 2 code that is <b>not</b> suitable for <code>2to3</code> conversion.<br/> @@ -110,7 +108,6 @@ public final class BazelPyRuleClasses { return builder /* <!-- #BLAZE_RULE($base_py_binary).ATTRIBUTE(data) --> The list of files needed by this binary at runtime. - ${SYNOPSIS} See general comments about <code>data</code> at <a href="common-definitions.html#common-attributes"> Attributes common to all build rules</a>. @@ -120,7 +117,6 @@ public final class BazelPyRuleClasses { /* <!-- #BLAZE_RULE($base_py_binary).ATTRIBUTE(main) --> The name of the source file that is the main entry point of the application. - ${SYNOPSIS} This file must also be listed in <code>srcs</code>. If left unspecified, <code>name</code> is used instead (see above). If <code>name</code> does not match any filename in <code>srcs</code>, <code>main</code> must be specified. @@ -129,7 +125,6 @@ public final class BazelPyRuleClasses { /* <!-- #BLAZE_RULE($base_py_binary).ATTRIBUTE(default_python_version) --> A string specifying the default Python major version to use when building this binary and all of its <code>deps</code>. - ${SYNOPSIS} Valid values are <code>"PY2"</code> (default) or <code>"PY3"</code>. Python 3 support is experimental. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ @@ -139,7 +134,6 @@ public final class BazelPyRuleClasses { + " to configuration keys")) /* <!-- #BLAZE_RULE($base_py_binary).ATTRIBUTE(srcs) --> The list of source files that are processed to create the target. - ${SYNOPSIS} This includes all your checked-in code and any generated source files. The line between <code>srcs</code> and <code>deps</code> is loose. The <code>.py</code> files @@ -153,7 +147,6 @@ public final class BazelPyRuleClasses { .allowedFileTypes(BazelPyRuleClasses.PYTHON_SOURCE)) /* <!-- #BLAZE_RULE($base_py_binary).ATTRIBUTE(stamp) --> Enable link stamping. - ${SYNOPSIS} Whether to encode build information into the binary. Possible values: <ul> <li><code>stamp = 1</code>: Stamp the build information into the diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyTestRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyTestRule.java index 5e651a1da4..2c800d0f86 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyTestRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/python/BazelPyTestRule.java @@ -38,7 +38,6 @@ public final class BazelPyTestRule implements RuleDefinition { .override(attr("testonly", BOOLEAN).value(true) .nonconfigurable("policy decision: should be consistent across configurations")) /* <!-- #BLAZE_RULE(py_test).ATTRIBUTE(stamp) --> - ${SYNOPSIS} See the section on <a href="#py_binary_args">py_binary()</a> arguments, except that the stamp argument is set to 0 by default for tests. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShLibraryRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShLibraryRule.java index f108953134..a303691d71 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShLibraryRule.java @@ -31,7 +31,6 @@ public final class BazelShLibraryRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(sh_library).ATTRIBUTE(srcs) --> The list of input files. - ${SYNOPSIS} <p> This attribute should be used to list shell script source files that belong to this library. Scripts can load other scripts using the shell's <code>source</code> diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShRuleClasses.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShRuleClasses.java index 1422fa7fec..9ec2814d94 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/sh/BazelShRuleClasses.java @@ -54,7 +54,6 @@ public final class BazelShRuleClasses { return builder /* <!-- #BLAZE_RULE($sh_target).ATTRIBUTE(srcs) --> The file containing the shell script. - ${SYNOPSIS} <p> This attribute must be a singleton list, whose element is the shell script. This script must be executable, and may be a source file or a generated file. @@ -67,7 +66,6 @@ public final class BazelShRuleClasses { .allowedFileTypes(SH_FILES)) /* <!-- #BLAZE_RULE($sh_target).ATTRIBUTE(deps) --> The list of "library" targets to be aggregated into this target. - ${SYNOPSIS} See general comments about <code>deps</code> at <a href="common-definitions.html#common.deps">Attributes common to all build rules</a>. <p> diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/GitRepositoryRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/GitRepositoryRule.java index d0e4371b1e..242eca0b5e 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/GitRepositoryRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/GitRepositoryRule.java @@ -35,28 +35,24 @@ public class GitRepositoryRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(remote) --> The URI of the remote Git repository. - ${SYNOPSIS} <p>This must be a HTTP URL. There is currently no support for authentication.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("remote", STRING).mandatory()) /* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(commit) --> The commit hash to check out in the repository. - ${SYNOPSIS} <p>Note that one of either <code>commit</code> or <code>tag</code> must be defined.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("commit", STRING)) /* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(tag) --> The Git tag to check out in the repository. - ${SYNOPSIS} <p>Note that one of either <code>commit</code> or <code>tag</code> must be defined.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("tag", STRING)) /* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(init_submodules) --> Whether to clone submodules in the repository. - ${SYNOPSIS} <p>Currently, only cloning the top-level submodules is supported</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpArchiveRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpArchiveRule.java index ea28220db3..cdcb866299 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpArchiveRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpArchiveRule.java @@ -37,7 +37,6 @@ public class HttpArchiveRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(http_archive).ATTRIBUTE(url) --> A URL referencing an archive file containing a Bazel repository. - ${SYNOPSIS} <p>Archives of type .zip, .jar, .war, .tar.gz or .tgz are supported. There is no support for authentication. Redirections are followed.</p> @@ -45,14 +44,12 @@ public class HttpArchiveRule implements RuleDefinition { .add(attr("url", STRING).mandatory()) /* <!-- #BLAZE_RULE(http_archive).ATTRIBUTE(sha256) --> The expected SHA-256 hash of the file downloaded. - ${SYNOPSIS} <p>This must match the SHA-256 hash of the file downloaded.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("sha256", STRING).mandatory()) /* <!-- #BLAZE_RULE(http_archive).ATTRIBUTE(type) --> The archive type of the downloaded file. - ${SYNOPSIS} <p>By default, the archive type is determined from the file extension of the URL. If the file has no extension, you can explicitly specify either "zip", "jar", "tar.gz", or @@ -61,7 +58,6 @@ public class HttpArchiveRule implements RuleDefinition { .add(attr("type", STRING)) /* <!-- #BLAZE_RULE(http_archive).ATTRIBUTE(strip_prefix) --> A directory prefix to strip from the extracted files. - ${SYNOPSIS} <p>Many archives contain a top-level directory that contains all of the useful files in archive. Instead of needing to specify this prefix over and over in the diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpFileRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpFileRule.java index f64429f264..d85ac4b0bd 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpFileRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpFileRule.java @@ -38,7 +38,6 @@ public class HttpFileRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(url) --> A URL to a file that will be made available to Bazel. - ${SYNOPSIS} <p>This must be an http or https URL. Authentication is not support. Redirections are followed.</p> @@ -46,14 +45,12 @@ public class HttpFileRule implements RuleDefinition { .add(attr("url", STRING).mandatory()) /* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(sha256) --> The expected SHA-256 of the file downloaded. - ${SYNOPSIS} <p>This must match the SHA-256 of the file downloaded.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("sha256", STRING).mandatory()) /* <!-- #BLAZE_RULE(http_file).ATTRIBUTE(executable) --> If the downloaded file should be made executable. Defaults to False. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("executable", BOOLEAN)) diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpJarRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpJarRule.java index e072848f02..51d189a34c 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpJarRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/HttpJarRule.java @@ -37,14 +37,12 @@ public class HttpJarRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(http_jar).ATTRIBUTE(url) --> A URL to an archive file containing a Bazel repository. - ${SYNOPSIS} <p>This must be an http or https URL that ends with .jar. Redirections are followed.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("url", STRING).mandatory()) /* <!-- #BLAZE_RULE(http_jar).ATTRIBUTE(sha256) --> The expected SHA-256 of the file downloaded. - ${SYNOPSIS} <p>This must match the SHA-256 of the file downloaded.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java index 70cfa33e0b..6936a54019 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java @@ -37,7 +37,6 @@ public class MavenJarRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(artifact) --> A description of a Maven artifact. - ${SYNOPSIS} <p>These descriptions are of the form <groupId>:<artifactId>:<version>, see <a href="#maven_jar_examples">the documentation below</a> for an example. @@ -48,7 +47,6 @@ public class MavenJarRule implements RuleDefinition { .add(attr("version", Type.STRING).undocumented("deprecated")) /* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(repository) --> A URL for a Maven repository to fetch the jar from. - ${SYNOPSIS} <p>Either this or <code>server</code> can be specified. Defaults to Maven Central ("central.maven.org").</p> @@ -56,14 +54,12 @@ public class MavenJarRule implements RuleDefinition { .add(attr("repository", Type.STRING)) /* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(server) --> A maven_server to use for this artifact. - ${SYNOPSIS} <p>Either this or <code>repository</code> can be specified.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("server", Type.STRING)) /* <!-- #BLAZE_RULE(maven_jar).ATTRIBUTE(sha1) --> A SHA-1 hash of the desired jar. - ${SYNOPSIS} <p>If the downloaded jar does not match this hash, Bazel will error out.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenServerRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenServerRule.java index ee3352bc91..04434a19c9 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenServerRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenServerRule.java @@ -37,7 +37,6 @@ public class MavenServerRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(maven_server).ATTRIBUTE(url) --> A URL for accessing the server. - ${SYNOPSIS} <p>For example, Maven Central (which is the default and does not need to be defined) would be specified as <code>url = "http://central.maven.org/maven2/"</code>.</p> @@ -47,7 +46,6 @@ public class MavenServerRule implements RuleDefinition { A path to a settings.xml file. Used for testing. If unspecified, this defaults to using <code>$M2_HOME/conf/settings.xml</code> for the global settings and <code>$HOME/.m2/settings.xml</code> for the user settings. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("settings_file", Type.STRING)) .setWorkspaceOnly() diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewGitRepositoryRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewGitRepositoryRule.java index 675091d5ae..d75d533946 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewGitRepositoryRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewGitRepositoryRule.java @@ -35,28 +35,24 @@ public class NewGitRepositoryRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(new_git_repository).ATTRIBUTE(remote) --> The URI of the remote Git repository. - ${SYNOPSIS} <p>This must be a HTTP URL. There is currently no support for authentication.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("remote", STRING).mandatory()) /* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(commit) --> The commit hash to check out in the repository. - ${SYNOPSIS} <p>Note that one of either <code>commit</code> or <code>tag</code> must be defined.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("commit", STRING)) /* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(tag) --> The Git tag to check out in the repository. - ${SYNOPSIS} <p>Note that one of either <code>commit</code> or <code>tag</code> must be defined.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("tag", STRING)) /* <!-- #BLAZE_RULE(new_git_repository).ATTRIBUTE(build_file) --> The file to use as the BUILD file for this repository. - ${SYNOPSIS} <p>This path is relative to the build's workspace. The file does not need to be named BUILD, but can be something like BUILD.new-repo-name to distinguish it @@ -65,7 +61,6 @@ public class NewGitRepositoryRule implements RuleDefinition { .add(attr("build_file", STRING).mandatory()) /* <!-- #BLAZE_RULE(new_git_repository).ATTRIBUTE(init_submodules) --> Whether to clone submodules in the repository. - ${SYNOPSIS} <p>Currently, only cloning the top-level submodules is supported</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewHttpArchiveRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewHttpArchiveRule.java index dd3003cb3d..8f610ce449 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewHttpArchiveRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/NewHttpArchiveRule.java @@ -34,7 +34,6 @@ public class NewHttpArchiveRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(url) --> A URL referencing an archive file containing a Bazel repository. - ${SYNOPSIS} <p>Archives of type .zip, .jar, .war, .tar.gz or .tgz are supported. There is no support for authentication. Redirections are followed.</p> @@ -42,14 +41,12 @@ public class NewHttpArchiveRule implements RuleDefinition { .add(attr("url", STRING).mandatory()) /* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(sha256) --> The expected SHA-256 hash of the file downloaded. - ${SYNOPSIS} <p>This must match the SHA-256 hash of the file downloaded.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("sha256", STRING).mandatory()) /* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(build_file) --> The file to use as the BUILD file for this repository. - ${SYNOPSIS} <p>This path is relative to the build's workspace. The file does not need to be named BUILD, but can be something like BUILD.new-repo-name to distinguish it @@ -58,7 +55,6 @@ public class NewHttpArchiveRule implements RuleDefinition { .add(attr("build_file", STRING).mandatory()) /* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(type) --> The archive type of the downloaded file. - ${SYNOPSIS} <p>By default, the archive type is determined from the file extension of the URL. If the file has no extension, you can explicitly specify either "zip", "jar", "tar.gz", or @@ -67,7 +63,6 @@ public class NewHttpArchiveRule implements RuleDefinition { .add(attr("type", STRING)) /* <!-- #BLAZE_RULE(new_http_archive).ATTRIBUTE(strip_prefix) --> A directory prefix to strip from the extracted files. - ${SYNOPSIS} <p>Many archives contain a top-level directory that contains all of the useful files in archive. Instead of needing to specify this prefix over and over in the diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidBinaryOnlyRule.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidBinaryOnlyRule.java index c7e2b7035e..8556879f0f 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidBinaryOnlyRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidBinaryOnlyRule.java @@ -42,7 +42,6 @@ public final class AndroidBinaryOnlyRule implements RuleDefinition { // and the default task affinity of an activity. // // This overrides the value declared in the manifest. -// ${SYNOPSIS} // <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("application_id", STRING).undocumented("not ready for production use")) // /* <!-- #BLAZE_RULE(android_binary).ATTRIBUTE(version_code) --> @@ -54,7 +53,6 @@ public final class AndroidBinaryOnlyRule implements RuleDefinition { // This overrides the value declared in the manifest. // // Subject to <a href="make-variables.html">"Make" variable</a> substitution. -// ${SYNOPSIS} // Suggested practice is to declare a varrdef and reference it here so that a particular build // invocation will be used to generate apks for release. // <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ @@ -65,25 +63,21 @@ public final class AndroidBinaryOnlyRule implements RuleDefinition { // This overrides the value declared in the manifest. // // Subject to <a href="make-variables.html">"Make" variable</a> substitution. -// ${SYNOPSIS} // Suggested practice is to declare a varrdef and reference it here so that a particular build // invocation will be used to generate apks for release. // <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("version_name", STRING).undocumented("not ready for production use")) /* <!-- #BLAZE_RULE(android_binary).ATTRIBUTE(nocompress_extensions) --> A list of file extension to leave uncompressed in apk. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("nocompress_extensions", STRING_LIST)) /* <!-- #BLAZE_RULE(android_binary).ATTRIBUTE(resource_configuration_filters) --> A list of resource configuration filters, such 'en' that will limit the resources in the apk to only the ones in the 'en' configuration. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("resource_configuration_filters", STRING_LIST)) /* <!-- #BLAZE_RULE(android_binary).ATTRIBUTE(densities) --> Densities to filter for when building the apk. - ${SYNOPSIS} This will strip out raster drawable resources that would not be loaded by a device with the specified screen densities, to reduce APK size. A corresponding compatible-screens section will also be added to the manifest if it does not already contain a superset @@ -97,7 +91,6 @@ public final class AndroidBinaryOnlyRule implements RuleDefinition { /* <!-- #BLAZE_RULE(android_binary).ATTRIBUTE(multidex) --> Whether to split code into multiple dex files. - ${SYNOPSIS} Possible values: <ul> <li><code>native</code>: Split code into multiple dex files when the diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidLibraryBaseRule.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidLibraryBaseRule.java index 1d4ac6db81..ab6f02b830 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidLibraryBaseRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidLibraryBaseRule.java @@ -40,7 +40,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(android_library).ATTRIBUTE(srcs) --> The list of source files that are processed to create the target. - ${SYNOPSIS} <p><code>srcs</code> files of type <code>.java</code> are compiled. <em>For readability's sake</em>, it is not good to put the name of a generated <code>.java</code> source file into the <code>srcs</code>. @@ -66,7 +65,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { .allowedFileTypes(JavaSemantics.JAVA_SOURCE, JavaSemantics.SOURCE_JAR)) /* <!-- #BLAZE_RULE(android_library).ATTRIBUTE(deps) --> The list of other libraries to link against. - ${SYNOPSIS} Permitted library types are: <code>android_library</code>, <code>java_library</code> with <code>android</code> constraint and <code>cc_library</code> wrapping or producing <code>.so</code> native libraries @@ -81,7 +79,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { The transitive closure of all rules reached via <code>exports</code> attributes are considered direct dependencies of any rule that directly depends on the target with <code>exports</code>. - ${SYNOPSIS} <p>The <code>exports</code> are not direct deps of the rule they belong to.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("exports", LABEL_LIST) @@ -92,7 +89,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { .add(attr("alwayslink", BOOLEAN).undocumented("purely informational for now")) /* <!-- #BLAZE_RULE(android_library).ATTRIBUTE(neverlink) --> Only use this library for compilation and not at runtime. - ${SYNOPSIS} The outputs of a rule marked as <code>neverlink</code> will not be used in <code>.apk</code> creation. Useful if the library will be provided by the runtime environment during execution. @@ -101,7 +97,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { /* <!-- #BLAZE_RULE(android_library).ATTRIBUTE(idl_import_root) --> Package-relative path to the root of the java package tree containing idl sources included in this library. - ${SYNOPSIS} This path will be used as the import root when processing idl sources that depend on this library. (See <a href="#android_library_examples.idl_import_root">examples</a>.) @@ -109,7 +104,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { .add(attr("idl_import_root", STRING)) /* <!-- #BLAZE_RULE(android_library).ATTRIBUTE(idl_srcs) --> List of Android IDL definitions to translate to Java interfaces. - ${SYNOPSIS} After the Java interfaces are generated, they will be compiled together with the contents of <code>srcs</code>. <p>These files will be made available as imports for any @@ -120,7 +114,6 @@ public final class AndroidLibraryBaseRule implements RuleDefinition { .allowedFileTypes(AndroidRuleClasses.ANDROID_IDL)) /* <!-- #BLAZE_RULE(android_library).ATTRIBUTE(idl_parcelables) --> List of Android IDL definitions to supply as imports. - ${SYNOPSIS} These files will be made available as imports for any <code>android_library</code> target that depends on this library, directly or via its transitive closure, but will not be translated to Java diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java index 56ea050514..f9bf55dd9b 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java @@ -400,18 +400,15 @@ public final class AndroidRuleClasses { /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(manifest) --> The name of the Android manifest file, normally <code>AndroidManifest.xml</code>. Must be defined if resource_files or assets are defined. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("manifest", LABEL).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(exports_manifest) --> Whether to export manifest entries to <code>android_binary</code> targets that depend on this target. <code>uses-permissions</code> attributes are never exported. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("exports_manifest", BOOLEAN).value(false)) /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(resource_files) --> The list of resources to be packaged. - ${SYNOPSIS} This is typically a <code>glob</code> of all files under the <code>res</code> directory. <br/> @@ -423,14 +420,12 @@ public final class AndroidRuleClasses { .add(attr("resource_files", LABEL_LIST).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(assets_dir) --> The string giving the path to the files in <code>assets</code>. - ${SYNOPSIS} The pair <code>assets</code> and <code>assets_dir</code> describe packaged assets and either both attributes should be provided or none of them. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("assets_dir", STRING)) /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(assets) --> The list of assets to be packaged. - ${SYNOPSIS} This is typically a <code>glob</code> of all files under the <code>assets</code> directory. You can also reference other rules (any rule that produces files) or exported files in the other packages, as long as all those files are under the @@ -439,7 +434,6 @@ public final class AndroidRuleClasses { .add(attr("assets", LABEL_LIST).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(inline_constants) --> Let the compiler inline the constants defined in the generated java sources. - ${SYNOPSIS} This attribute must be set to 0 for all <code>android_library</code> rules used directly by an <code>android_binary</code>, and for any <code>android_binary</code> that has an <code>android_library</code> @@ -448,7 +442,6 @@ public final class AndroidRuleClasses { .add(attr("inline_constants", BOOLEAN).value(false)) /* <!-- #BLAZE_RULE($android_resource_support).ATTRIBUTE(custom_package) --> Java package for which java sources will be generated. - ${SYNOPSIS} By default the package is inferred from the directory where the BUILD file containing the rule is. You can specify a different package but this is highly discouraged since it can introduce classpath conflicts with other @@ -480,7 +473,6 @@ public final class AndroidRuleClasses { .value(ANDROID_SDK)) /* <!-- #BLAZE_RULE($android_base).ATTRIBUTE(plugins) --> Java compiler plugins to run at compile-time. - ${SYNOPSIS} Every <code>java_plugin</code> specified in the plugins attribute will be run whenever this target is built. Resources generated by @@ -496,7 +488,6 @@ public final class AndroidRuleClasses { .value(JavaSemantics.JAVA_PLUGINS)) /* <!-- #BLAZE_RULE($android_base).ATTRIBUTE(javacopts) --> Extra compiler options for this target. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a>. <p> @@ -532,7 +523,6 @@ public final class AndroidRuleClasses { return builder /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(srcs) --> The list of source files that are processed to create the target. - ${SYNOPSIS} <p><code>srcs</code> files of type <code>.java</code> are compiled. <em>For readability's sake</em>, it is not good to put the name of a generated <code>.java</code> source file into the <code>srcs</code>. @@ -551,7 +541,6 @@ public final class AndroidRuleClasses { .allowedFileTypes(JavaSemantics.JAVA_SOURCE, JavaSemantics.SOURCE_JAR)) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(deps) --> The list of other libraries to be linked in to the binary target. - ${SYNOPSIS} Permitted library types are: <code>android_library</code>, <code>java_library</code> with <code>android</code> constraint and <code>cc_library</code> wrapping or producing <code>.so</code> native libraries for the @@ -584,14 +573,12 @@ public final class AndroidRuleClasses { .value(DEFAULT_INCREMENTAL_SPLIT_STUB_APPLICATION)) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(dexopts) --> Additional command-line flags for the dx tool when generating classes.dex. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a>. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("dexopts", STRING_LIST)) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(dex_shards) --> Number of shards dexing should be decomposed into. - ${SYNOPSIS} This is makes dexing much faster at the expense of app installation and startup time. The larger the binary, the more shards should be used. 25 is a good value to start experimenting with. @@ -602,7 +589,6 @@ public final class AndroidRuleClasses { .add(attr("dex_shards", INTEGER).value(1)) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(main_dex_list_opts) --> Command line options to pass to the main dex list builder. - ${SYNOPSIS} Use this option to affect the classes included in the main dex list. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("main_dex_list_opts", STRING_LIST)) @@ -615,26 +601,22 @@ android/support/multidex/MultiDex.class android/support/multidex/MultiDexApplication.class com/google/common/base/Objects.class </pre> - ${SYNOPSIS} Must be used with <code>multidex="manual_main_dex"</code>. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("main_dex_list", LABEL).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(main_dex_proguard_specs) --> Files to be used as the Proguard specifications to determine classes that must be kept in the main dex. - ${SYNOPSIS} Only allowed if the <code>multidex</code> attribute is set to <code>legacy</code>. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("main_dex_proguard_specs", LABEL_LIST).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(proguard_specs) --> Files to be used as Proguard specification. - ${SYNOPSIS} This file will describe the set of specifications to be used by Proguard. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("proguard_specs", LABEL_LIST).legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(proguard_generate_mapping) --> Whether to generate Proguard mapping file. - ${SYNOPSIS} The mapping file will be generated only if <code>proguard_specs</code> is specified. This file will list the mapping between the original and obfuscated class, method, and field names. @@ -646,7 +628,6 @@ com/google/common/base/Objects.class .nonconfigurable("value is referenced in an ImplicitOutputsFunction")) /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(proguard_apply_mapping) --> File to be used as a mapping for proguard. - ${SYNOPSIS} A mapping file generated by <code>proguard_generate_mapping</code> to be re-used to apply the same mapping to a new build. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ @@ -654,7 +635,6 @@ com/google/common/base/Objects.class /* <!-- #BLAZE_RULE($android_binary_base).ATTRIBUTE(legacy_native_support) --> Enables legacy native support, where pre-compiled native libraries are copied directly into the APK. - ${SYNOPSIS} Possible values: <ul> <li><code>legacy_native_support = 1</code>: Pre-built .so files found in the diff --git a/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeConfigRule.java b/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeConfigRule.java index 3036d9fe81..58275f034f 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeConfigRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeConfigRule.java @@ -42,7 +42,6 @@ public class XcodeConfigRule implements RuleDefinition { "this rule refines configuration variables and does not build actual content") /* <!-- #BLAZE_RULE(proto_library).ATTRIBUTE(version) --> The default official version of xcode to use. - ${SYNOPSIS} The version specified by the provided <code>xcode_version</code> target is to be used if no <code>xcode_version</code> build flag is specified. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ @@ -51,7 +50,6 @@ public class XcodeConfigRule implements RuleDefinition { .allowedFileTypes()) /* <!-- #BLAZE_RULE(proto_library).ATTRIBUTE(version) --> Accepted <code>xcode_version<code> targets that may be used. - ${SYNOPSIS} If the value of the <code>xcode_version</code> build flag matches one of the aliases or version number of any of the given <code>xcode_version</code> targets, the matching target will be used. @@ -61,7 +59,6 @@ public class XcodeConfigRule implements RuleDefinition { .allowedFileTypes()) /* <!-- #BLAZE_RULE(proto_library).ATTRIBUTE(version) --> Whether to require the build's xcode version match one of the declared targets. - ${SYNOPSIS} If true, this will raise an error if either the <code>xcode_version</code> flag value or <code>default</code> attribute value do not match one of the versions declared among <code>xcode_verison</code> targets. diff --git a/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeVersionRule.java b/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeVersionRule.java index 7a9a23361a..d78337bcdf 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeVersionRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/apple/XcodeVersionRule.java @@ -44,7 +44,6 @@ public class XcodeVersionRule implements RuleDefinition { .add(attr(VERSION_ATTR_NAME, STRING).mandatory()) /* <!-- #BLAZE_RULE(proto_library).ATTRIBUTE(version) --> Accepted aliases for this version of Xcode. - ${SYNOPSIS} If the value of the <code>xcode_version</code> build flag matches any of the given alias strings, this xcode version will be used. <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ diff --git a/src/main/java/com/google/devtools/build/lib/rules/genquery/GenQueryRule.java b/src/main/java/com/google/devtools/build/lib/rules/genquery/GenQueryRule.java index 56c608fa1e..bbcfbe8e5d 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/genquery/GenQueryRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/genquery/GenQueryRule.java @@ -36,7 +36,6 @@ public final class GenQueryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(genquery).ATTRIBUTE(scope) --> The scope of the query. The query is not allowed to touch targets outside the transitive closure of these targets. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("scope", LABEL_LIST).mandatory().legacyAllowAnyFileType()) /* <!-- #BLAZE_RULE(genquery).ATTRIBUTE(strict) --> @@ -44,12 +43,10 @@ public final class GenQueryRule implements RuleDefinition { scopes will fail to build. If false, Blaze will print a warning and skip whatever query path led it outside of the scope, while completing the rest of the query. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("strict", BOOLEAN).value(true)) /* <!-- #BLAZE_RULE(genquery).ATTRIBUTE(expression) --> The query to be executed. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("expression", STRING).mandatory()) /* <!-- #BLAZE_RULE(genquery).ATTRIBUTE(opts) --> @@ -57,7 +54,6 @@ public final class GenQueryRule implements RuleDefinition { These correspond to the command line options that can be passed to <code>blaze query</code>. The only query options that are not allowed here are <code>--keep_going</code> and <code>--order_output</code>. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("opts", STRING_LIST)) .build(); diff --git a/src/main/java/com/google/devtools/build/lib/rules/java/JavaImportBaseRule.java b/src/main/java/com/google/devtools/build/lib/rules/java/JavaImportBaseRule.java index a3b306bb6c..200a39eb5f 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/java/JavaImportBaseRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/java/JavaImportBaseRule.java @@ -44,7 +44,6 @@ public class JavaImportBaseRule implements RuleDefinition { .value(JavaSemantics.HOST_JDK)) /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(jars) --> The list of JAR files provided to Java targets that depend on this target. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("jars", LABEL_LIST) .mandatory() @@ -52,7 +51,6 @@ public class JavaImportBaseRule implements RuleDefinition { .allowedFileTypes(JavaSemantics.JAR)) /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(srcjar) --> A JAR file that contains source code for the compiled JAR files. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("srcjar", LABEL) .allowedFileTypes(JavaSemantics.SOURCE_JAR, JavaSemantics.JAR) @@ -60,7 +58,6 @@ public class JavaImportBaseRule implements RuleDefinition { .removeAttribute("deps") // only exports are allowed; nothing is compiled /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(neverlink) --> Only use this library for compilation and not at runtime. - ${SYNOPSIS} Useful if the library will be provided by the runtime environment during execution. Examples of libraries like this are IDE APIs for IDE plug-ins or <code>tools.jar</code> for anything running on @@ -69,7 +66,6 @@ public class JavaImportBaseRule implements RuleDefinition { .add(attr("neverlink", BOOLEAN).value(false)) /* <!-- #BLAZE_RULE(java_import).ATTRIBUTE(constraints) --> Extra constraints imposed on this rule as a Java library. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("constraints", STRING_LIST) .orderIndependent() diff --git a/src/main/java/com/google/devtools/build/lib/rules/java/ProguardLibraryRule.java b/src/main/java/com/google/devtools/build/lib/rules/java/ProguardLibraryRule.java index e3d37e3fd6..84efb12468 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/java/ProguardLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/java/ProguardLibraryRule.java @@ -38,7 +38,6 @@ public final class ProguardLibraryRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE($proguard_library).ATTRIBUTE(proguard_specs) --> Files to be used as Proguard specification. - ${SYNOPSIS} These will describe the set of specifications to be used by Proguard. If specified, they will be added to any <code>android_binary</code> target depending on this library. diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/IosApplicationRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/IosApplicationRule.java index bead926ac6..ce4cbf2a01 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/IosApplicationRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/IosApplicationRule.java @@ -50,7 +50,6 @@ public class IosApplicationRule implements RuleDefinition { ImplicitOutputsFunction.fromFunctions(ReleaseBundlingSupport.IPA, XcodeSupport.PBXPROJ)) /* <!-- #BLAZE_RULE(ios_application).ATTRIBUTE(binary) --> The binary target included in the final bundle. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("binary", LABEL) .allowedRuleClasses("objc_binary") @@ -60,7 +59,6 @@ public class IosApplicationRule implements RuleDefinition { .cfg(IosApplication.SPLIT_ARCH_TRANSITION)) /* <!-- #BLAZE_RULE(ios_application).ATTRIBUTE(extensions) --> Any extensions to include in the final application. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("extensions", LABEL_LIST) .allowedRuleClasses("ios_extension") diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/IosDeviceRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/IosDeviceRule.java index 2e73cf139e..44de5695f4 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/IosDeviceRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/IosDeviceRule.java @@ -33,14 +33,12 @@ public final class IosDeviceRule implements RuleDefinition { /* <!-- #BLAZE_RULE(ios_device).ATTRIBUTE(ios_version) --> The operating system version of the device. This corresponds to the <code>simctl</code> runtime. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("ios_version", STRING) .mandatory()) /* <!-- #BLAZE_RULE(ios_device).ATTRIBUTE(type) --> The hardware type. This corresponds to the <code>simctl</code> device type. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("type", STRING) .mandatory()) diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/IosExtensionRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/IosExtensionRule.java index fbf6b523ff..624cb996a2 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/IosExtensionRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/IosExtensionRule.java @@ -45,7 +45,6 @@ public class IosExtensionRule implements RuleDefinition { ImplicitOutputsFunction.fromFunctions(ReleaseBundlingSupport.IPA, XcodeSupport.PBXPROJ)) /* <!-- #BLAZE_RULE(ios_extension).ATTRIBUTE(binary) --> The binary target containing the logic for the extension. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("binary", LABEL) .allowedRuleClasses("ios_extension_binary") diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java index 17dfddee1c..11d75c7b2b 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java @@ -40,7 +40,6 @@ public class IosFrameworkRule implements RuleDefinition { ImplicitOutputsFunction.fromFunctions(ReleaseBundlingSupport.IPA, XcodeSupport.PBXPROJ)) /* <!-- #BLAZE_RULE(ios_framework).ATTRIBUTE(binary) --> The binary target included in the framework bundle. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("binary", LABEL) .allowedRuleClasses("ios_framework_binary") @@ -50,7 +49,6 @@ public class IosFrameworkRule implements RuleDefinition { .cfg(IosExtension.MINIMUM_OS_AND_SPLIT_ARCH_TRANSITION)) /* <!-- #BLAZE_RULE(ios_framework).ATTRIBUTE(hdrs) --> Public headers to include in the framework bundle. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("hdrs", LABEL_LIST) .direct_compile_time_input() diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/IosTestRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/IosTestRule.java index 191d91883e..b22c9f0a91 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/IosTestRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/IosTestRule.java @@ -68,7 +68,6 @@ public class IosTestRule implements RuleDefinition { ImplicitOutputsFunction.fromFunctions(ReleaseBundlingSupport.IPA, XcodeSupport.PBXPROJ)) /* <!-- #BLAZE_RULE(ios_test ).ATTRIBUTE(target_device) --> The device against which to run the test. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add( attr(IosTest.TARGET_DEVICE, LABEL) @@ -78,14 +77,12 @@ public class IosTestRule implements RuleDefinition { env.getLabel(Constants.TOOLS_REPOSITORY + "//tools/objc/sim_devices:default"))) /* <!-- #BLAZE_RULE(ios_test ).ATTRIBUTE(xctest) --> Whether this target contains tests using the XCTest testing framework. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr(IosTest.IS_XCTEST, BOOLEAN).value(true)) /* <!-- #BLAZE_RULE(ios_test ).ATTRIBUTE(xctest_app) --> A <code>objc_binary</code> or <code>ios_application</code> target that contains the app bundle to test against in XCTest. This attribute is only valid if <code>xctest</code> is true. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add( attr(IosTest.XCTEST_APP, LABEL) @@ -122,7 +119,6 @@ public class IosTestRule implements RuleDefinition { /* <!-- #BLAZE_RULE(ios_test).ATTRIBUTE(ios_test_target_device) --> The device against how to run the test. If this attribute is defined, the test will run on the lab device. Otherwise, the test will run on simulator. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add( attr("ios_test_target_device", LABEL) @@ -132,12 +128,10 @@ public class IosTestRule implements RuleDefinition { Extra arguments to pass to the <code>ios_test_target_device</code>'s binary. They should be in the form KEY=VALUE or simply KEY (check your device's documentation for allowed parameters). - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("ios_device_arg", STRING_LIST)) /* <!-- #BLAZE_RULE(ios_test).ATTRIBUTE(plugins) --> Plugins to pass to the test runner. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("plugins", LABEL_LIST).allowedFileTypes(FileType.of("_deploy.jar"))) .add( diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/J2ObjcLibraryBaseRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/J2ObjcLibraryBaseRule.java index 23a82646e7..d5941d583d 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/J2ObjcLibraryBaseRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/J2ObjcLibraryBaseRule.java @@ -39,7 +39,6 @@ public class J2ObjcLibraryBaseRule implements RuleDefinition { </code> is on. The Java classes should be specified in their canonical names as defined by <a href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#jls-6.7">the Java Language Specification.</a> - ${SYNOPSIS} When flag <code>--j2objc_dead_code_removal</code> is specified, the list of entry classes will be collected transitively and used as entry points to perform dead code analysis. Unused classes will then be removed from the final ObjC app bundle. diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcBundleRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcBundleRule.java index 451f9f7451..da0ee9a03c 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcBundleRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcBundleRule.java @@ -34,7 +34,6 @@ public class ObjcBundleRule implements RuleDefinition { /* <!-- #BLAZE_RULE(objc_bundle).ATTRIBUTE(bundle_imports) --> The list of files under a <code>.bundle</code> directory which are provided to Objective-C targets that depend on this target. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("bundle_imports", LABEL_LIST) .allowedFileTypes(FileTypeSet.ANY_FILE) diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcFrameworkRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcFrameworkRule.java index 80b63a07ac..a4c68ac4c6 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcFrameworkRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcFrameworkRule.java @@ -35,7 +35,6 @@ public class ObjcFrameworkRule implements RuleDefinition { /* <!-- #BLAZE_RULE(objc_framework).ATTRIBUTE(framework_imports) --> The list of files under a <code>.framework</code> directory which are provided to Objective-C targets that depend on this target. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("framework_imports", LABEL_LIST) .allowedFileTypes(FileTypeSet.ANY_FILE) diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcImportRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcImportRule.java index f59bbe3a22..38d3a13b62 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcImportRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcImportRule.java @@ -44,7 +44,6 @@ public class ObjcImportRule implements RuleDefinition { /* <!-- #BLAZE_RULE(objc_import).ATTRIBUTE(archives) --> The list of <code>.a</code> files provided to Objective-C targets that depend on this target. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("archives", LABEL_LIST) .mandatory() diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcProtoLibraryRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcProtoLibraryRule.java index 24ba5a4beb..cb4a1ba59a 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcProtoLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcProtoLibraryRule.java @@ -52,7 +52,6 @@ public class ObjcProtoLibraryRule implements RuleDefinition { .requiresConfigurationFragments(ObjcConfiguration.class, AppleConfiguration.class) /* <!-- #BLAZE_RULE(objc_proto_library).ATTRIBUTE(deps) --> The directly depended upon proto_library rules. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .override(attr("deps", LABEL_LIST) // Support for files in deps is for backwards compatibility. @@ -61,22 +60,18 @@ public class ObjcProtoLibraryRule implements RuleDefinition { /* <!-- #BLAZE_RULE(objc_proto_library).ATTRIBUTE(options_file) --> Optional options file to apply to protos which affects compilation (e.g. class whitelist/blacklist settings). - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr(OPTIONS_FILE_ATTR, LABEL).legacyAllowAnyFileType().singleArtifact().cfg(HOST)) /* <!-- #BLAZE_RULE(objc_proto_library).ATTRIBUTE(output_cpp) --> If true, output C++ rather than ObjC. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr(OUTPUT_CPP_ATTR, BOOLEAN).value(false)) /* <!-- #BLAZE_RULE(objc_proto_library).ATTRIBUTE(use_objc_header_names) --> If true, output headers with .pbobjc.h, rather than .pb.h. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr(PER_PROTO_INCLUDES, BOOLEAN).value(false)) /* <!-- #BLAZE_RULE(objc_proto_library).ATTRIBUTE(per_proto_includes) --> If true, always add all directories to objc_library includes, - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr(COMPILE_PROTOS_ATTR, LABEL) .allowedFileTypes(FileType.of(".py")) diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcRuleClasses.java b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcRuleClasses.java index a18b46bd52..df30abcb5d 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcRuleClasses.java @@ -240,7 +240,6 @@ public class ObjcRuleClasses { return builder /* <!-- #BLAZE_RULE($objc_opts_rule).ATTRIBUTE(copts) --> Extra flags to pass to the compiler. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a>. These flags will only apply to this target, and not those upon which @@ -303,7 +302,6 @@ public class ObjcRuleClasses { return builder /* <!-- #BLAZE_RULE($objc_sdk_frameworks_depender_rule).ATTRIBUTE(sdk_frameworks) --> Names of SDK frameworks to link with. - ${SYNOPSIS} For instance, "XCTest" or "Cocoa". "UIKit" and "Foundation" are always included and do not mean anything if you include them. @@ -316,7 +314,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_sdk_frameworks_depender_rule).ATTRIBUTE(weak_sdk_frameworks) --> Names of SDK frameworks to weakly link with. For instance, "MediaAccessibility". - ${SYNOPSIS} In difference to regularly linked SDK frameworks, symbols from weakly linked frameworks do not cause an error if they @@ -326,7 +323,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_sdk_frameworks_depender_rule).ATTRIBUTE(sdk_dylibs) --> Names of SDK .dylib libraries to link with. For instance, "libz" or "libarchive". - ${SYNOPSIS} "libc++" is included automatically if the binary has any C++ or Objective-C++ sources in its dependency tree. When linking a binary, @@ -402,7 +398,6 @@ public class ObjcRuleClasses { return builder /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(strings) --> Files which are plists of strings, often localizable. - ${SYNOPSIS} These files are converted to binary plists (if they are not already) and placed in the bundle root of the final package. If this file's @@ -414,7 +409,6 @@ public class ObjcRuleClasses { .direct_compile_time_input()) /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(xibs) --> Files which are .xib resources, possibly localizable. - ${SYNOPSIS} These files are compiled to .nib files and placed the bundle root of the final package. If this file's immediate containing directory is @@ -427,7 +421,6 @@ public class ObjcRuleClasses { .allowedFileTypes(XIB_TYPE)) /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(storyboards) --> Files which are .storyboard resources, possibly localizable. - ${SYNOPSIS} These files are compiled to .storyboardc directories, which are placed in the bundle root of the final package. If the storyboards's @@ -439,7 +432,6 @@ public class ObjcRuleClasses { .allowedFileTypes(STORYBOARD_TYPE)) /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(resources) --> Files to include in the final application bundle. - ${SYNOPSIS} They are not processed or compiled in any way besides the processing done by the rules that actually generate them. These files are placed @@ -451,7 +443,6 @@ public class ObjcRuleClasses { .add(attr("resources", LABEL_LIST).legacyAllowAnyFileType().direct_compile_time_input()) /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(structured_resources) --> Files to include in the final application bundle. - ${SYNOPSIS} They are not processed or compiled in any way besides the processing done by the rules that actually generate them. In differences to @@ -469,7 +460,6 @@ public class ObjcRuleClasses { .direct_compile_time_input()) /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(datamodels) --> Files that comprise the data models of the final linked binary. - ${SYNOPSIS} Each file must have a containing directory named *.xcdatamodel, which is usually contained by another *.xcdatamodeld (note the added d) @@ -479,7 +469,6 @@ public class ObjcRuleClasses { .direct_compile_time_input()) /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(asset_catalogs) --> Files that comprise the asset catalogs of the final linked binary. - ${SYNOPSIS} Each file must have a containing directory named *.xcassets. This containing directory becomes the root of one of the asset catalogs @@ -491,7 +480,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_resources_rule).ATTRIBUTE(bundles) --> The list of bundle targets that this target requires to be included in the final bundle. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("bundles", LABEL_LIST) .direct_compile_time_input() @@ -573,7 +561,6 @@ public class ObjcRuleClasses { included as headers by source files in this rule or by users of this library. These will be compiled separately from the source if modules are enabled. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("hdrs", LABEL_LIST) .direct_compile_time_input() @@ -583,14 +570,12 @@ public class ObjcRuleClasses { included as headers by source files in this rule or by users of this library. Unlike hdrs, these will not be compiled separately from the sources. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("textual_hdrs", LABEL_LIST) .direct_compile_time_input() .allowedFileTypes(HDRS_TYPE)) /* <!-- #BLAZE_RULE($objc_compile_dependency_rule).ATTRIBUTE(bridging_header) --> A header defining the Objective-C interfaces to be exposed in Swift. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("bridging_header", BuildType.LABEL) .direct_compile_time_input() @@ -598,7 +583,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_compile_dependency_rule).ATTRIBUTE(includes) --> List of <code>#include/#import</code> search paths to add to this target and all depending targets. - ${SYNOPSIS} This is to support third party and open-sourced libraries that do not specify the entire workspace path in their @@ -619,7 +603,6 @@ public class ObjcRuleClasses { List of <code>#include/#import</code> search paths to add to this target and all depending targets, where each path is relative to <code>$(SDKROOT)/usr/include</code>. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("sdk_includes", Type.STRING_LIST)) .build(); @@ -655,7 +638,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_compiling_rule).ATTRIBUTE(srcs) --> The list of C, C++, Objective-C, and Objective-C++ source and header files that are processed to create the library target. - ${SYNOPSIS} These are your checked-in files, plus any generated files. Source files are compiled into .o files with Clang. Header files may be included/imported by any source or header in the srcs attribute @@ -666,7 +648,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_compiling_rule).ATTRIBUTE(non_arc_srcs) --> The list of Objective-C files that are processed to create the library target that DO NOT use ARC. - ${SYNOPSIS} The files in this attribute are treated very similar to those in the srcs attribute, but are compiled without ARC enabled. <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ @@ -677,14 +658,12 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_compiling_rule).ATTRIBUTE(pch) --> Header file to prepend to every source file being compiled (both arc and non-arc). - ${SYNOPSIS} Note that the file will not be precompiled - this is simply a convenience, not a build-speed enhancement. <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("pch", LABEL).direct_compile_time_input().allowedFileTypes(FileType.of(".pch"))) /* <!-- #BLAZE_RULE($objc_compiling_rule).ATTRIBUTE(deps) --> The list of targets that are linked together to form the final bundle. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .override( attr("deps", LABEL_LIST) @@ -694,10 +673,8 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_compiling_rule).ATTRIBUTE(non_propagated_deps) --> The list of targets that are required in order to build this target, but which are not included in the final bundle. - ${SYNOPSIS} This attribute should only rarely be used, and probably only for proto dependencies. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add( attr("non_propagated_deps", LABEL_LIST) @@ -709,14 +686,12 @@ public class ObjcRuleClasses { the form <code>KEY=VALUE</code> or simply <code>KEY</code> and are passed not only the compiler for this target (as <code>copts</code> are) but also to all <code>objc_</code> dependers of this target. - ${SYNOPSIS} Subject to <a href="make-variables.html">"Make variable"</a> substitution and <a href="common-definitions.html#sh-tokenization">Bourne shell tokenization</a>. <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("defines", STRING_LIST)) /* <!-- #BLAZE_RULE($objc_compiling_rule).ATTRIBUTE(enable_modules) --> Enables clang module support (via -fmodules). - ${SYNOPSIS} Setting this to 1 will allow you to @import system headers and other targets: @import UIKit; @import path_to_package_target; @@ -751,7 +726,6 @@ public class ObjcRuleClasses { library will link in all the object files for the files listed in <code>srcs</code> and <code>non_arc_srcs</code>, even if some contain no symbols referenced by the binary. - ${SYNOPSIS} This is useful if your code isn't explicitly called by code in the binary, e.g., if your code registers to receive some callback provided by some service. @@ -808,7 +782,6 @@ public class ObjcRuleClasses { return builder /* <!-- #BLAZE_RULE($objc_bundling_rule).ATTRIBUTE(infoplist)[DEPRECATED] --> The infoplist file. This corresponds to <i>appname</i>-Info.plist in Xcode projects. - ${SYNOPSIS} Blaze will perform variable substitution on the plist file for the following values: <ul> <li><code>${EXECUTABLE_NAME}</code>: The name of the executable generated and included @@ -825,7 +798,6 @@ public class ObjcRuleClasses { in Xcode projects. Duplicate keys between infoplist files will cause an error if and only if the values conflict. If both <code>infoplist</code> and <code>infoplists</code> are specified, the files defined in both attributes will be used. - ${SYNOPSIS} Blaze will perform variable substitution on the plist files for the following values: <ul> <li><code>${EXECUTABLE_NAME}</code>: The name of the executable generated and included @@ -839,7 +811,6 @@ public class ObjcRuleClasses { .add(attr("infoplists", BuildType.LABEL_LIST).allowedFileTypes(PLIST_TYPE)) /* <!-- #BLAZE_RULE($objc_bundling_rule).ATTRIBUTE(families) --> The device families to which this bundle or binary is targeted. - ${SYNOPSIS} This is known as the <code>TARGETED_DEVICE_FAMILY</code> build setting in Xcode project files. It is a list of one or more of the strings @@ -887,7 +858,6 @@ public class ObjcRuleClasses { return builder /* <!-- #BLAZE_RULE($objc_release_bundling_rule).ATTRIBUTE(entitlements) --> The entitlements file required for device builds of this application. - ${SYNOPSIS} See <a href="https://developer.apple.com/library/mac/documentation/Miscellaneous/Reference/EntitlementKeyReference/Chapters/AboutEntitlements.html">the apple documentation</a> @@ -902,7 +872,6 @@ public class ObjcRuleClasses { /* <!-- #BLAZE_RULE($objc_release_bundling_rule).ATTRIBUTE(provisioning_profile) --> The provisioning profile (.mobileprovision file) to use when bundling the application. - ${SYNOPSIS} This is only used for non-simulator builds. <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ @@ -932,7 +901,6 @@ public class ObjcRuleClasses { })) /* <!-- #BLAZE_RULE($objc_release_bundling_rule).ATTRIBUTE(app_icon) --> The name of the application icon. - ${SYNOPSIS} The icon should be in one of the asset catalogs of this target or a (transitive) dependency. In a new project, this is initialized @@ -944,7 +912,6 @@ public class ObjcRuleClasses { .add(attr("app_icon", STRING)) /* <!-- #BLAZE_RULE($objc_release_bundling_rule).ATTRIBUTE(launch_image) --> The name of the launch image. - ${SYNOPSIS} The icon should be in one of the asset catalogs of this target or a (transitive) dependency. In a new project, this is initialized @@ -962,7 +929,6 @@ public class ObjcRuleClasses { .add(attr("launch_image", STRING)) /* <!-- #BLAZE_RULE($objc_release_bundling_rule).ATTRIBUTE(launch_storyboard) --> The location of the launch storyboard (.xib or .storyboard). - ${SYNOPSIS} The provided storyboard will be compiled to the appropriate format (.nib or .storyboardc respectively) and placed in the root of the @@ -985,7 +951,6 @@ public class ObjcRuleClasses { .allowedFileTypes(FileTypeSet.of(XIB_TYPE, STORYBOARD_TYPE))) /* <!-- #BLAZE_RULE($objc_release_bundling_rule).ATTRIBUTE(bundle_id) --> The bundle ID (reverse-DNS path followed by app name) of the binary. - ${SYNOPSIS} If specified, it will override the bundle ID specified in the associated plist file. If no bundle ID is specified on either this attribute or in the plist file, a junk value diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcXcodeprojRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcXcodeprojRule.java index 56c6083bf3..4b6f29cf00 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcXcodeprojRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/objc/ObjcXcodeprojRule.java @@ -42,7 +42,6 @@ public class ObjcXcodeprojRule implements RuleDefinition { .setImplicitOutputsFunction(XcodeSupport.PBXPROJ) /* <!-- #BLAZE_RULE(objc_xcodeproj).ATTRIBUTE(deps) --> The list of targets to include in the combined Xcode project file. - ${SYNOPSIS} <!-- #END_BLAZE_RULE.ATTRIBUTE -->*/ .add(attr("deps", LABEL_LIST) .nonEmpty() diff --git a/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java b/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java index f591296277..3dfafb2ced 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java @@ -40,7 +40,6 @@ public final class BazelProtoLibraryRule implements RuleDefinition { .setOutputToGenfiles() /* <!-- #BLAZE_RULE(proto_library).ATTRIBUTE(deps) --> The list of other <code>proto_library</code> rules that the target depends upon. - ${SYNOPSIS} A <code>proto_library</code> may only depend on other <code>proto_library</code> targets. It may not depend on language-specific libraries. @@ -50,7 +49,6 @@ public final class BazelProtoLibraryRule implements RuleDefinition { .allowedFileTypes()) /* <!-- #BLAZE_RULE(proto_library).ATTRIBUTE(srcs) --> The list of <code>.proto</code> files that are processed to create the target. - ${SYNOPSIS} This is usually a non empty list. One usecase where <code>srcs</code> can be empty is an <i>alias-library</i>. This is a proto_library rule having one or more other proto_library in <code>deps</code>. This pattern can be used to diff --git a/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java b/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java index 2c01fafc2f..9457d3b351 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java @@ -34,7 +34,6 @@ public final class BindRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(bind).ATTRIBUTE(actual) --> The target to be aliased. - ${SYNOPSIS} <p>This target must exist, but can be any type of rule (including bind).</p> diff --git a/src/main/java/com/google/devtools/build/lib/rules/repository/LocalRepositoryRule.java b/src/main/java/com/google/devtools/build/lib/rules/repository/LocalRepositoryRule.java index fbeb36f179..5e1c595553 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/repository/LocalRepositoryRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/repository/LocalRepositoryRule.java @@ -35,7 +35,6 @@ public class LocalRepositoryRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(local_repository).ATTRIBUTE(path) --> The path to the local repository's directory. - ${SYNOPSIS} <p>This must be an absolute path to the directory containing the repository's <i>WORKSPACE</i> file.</p> diff --git a/src/main/java/com/google/devtools/build/lib/rules/repository/NewLocalRepositoryRule.java b/src/main/java/com/google/devtools/build/lib/rules/repository/NewLocalRepositoryRule.java index 8dfa9fa214..f68b506ed9 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/repository/NewLocalRepositoryRule.java +++ b/src/main/java/com/google/devtools/build/lib/rules/repository/NewLocalRepositoryRule.java @@ -34,14 +34,12 @@ public class NewLocalRepositoryRule implements RuleDefinition { return builder /* <!-- #BLAZE_RULE(new_local_repository).ATTRIBUTE(path) --> A path on the local filesystem. - ${SYNOPSIS} <p>This must be an absolute path to an existing file or a directory.</p> <!-- #END_BLAZE_RULE.ATTRIBUTE --> */ .add(attr("path", STRING).mandatory()) /* <!-- #BLAZE_RULE(new_local_repository).ATTRIBUTE(build_file) --> A file to use as a BUILD file for this directory. - ${SYNOPSIS} <p>This path is relative to the build's workspace. The file does not need to be named BUILD, but can be (something like BUILD.new-repo-name may work well for distinguishing it |