From e7d08a58809af72589b110d81725afebf15553c4 Mon Sep 17 00:00:00 2001 From: "PMD CI (pmd-bot)" Date: Fri, 30 Sep 2022 14:44:26 +0000 Subject: [PATCH] Update documentation https://github.com/pmd/pmd/actions/runs/3159454869 https://github.com/pmd/pmd/compare/d69a292d16d5...905f1432f4de --- 404.html | 4 +- feed.xml | 4 +- index.html | 4 +- js/mydoc_scroll.html | 4 +- license.html | 4 +- news.html | 4 +- news_archive.html | 4 +- pmd_about_help.html | 4 +- pmd_apex_metrics_index.html | 4 +- pmd_devdocs_building.html | 18 +- pmd_devdocs_development.html | 4 +- pmd_devdocs_experimental_ast_dump.html | 4 +- pmd_devdocs_how_pmd_works.html | 4 +- ...devdocs_major_adding_new_cpd_language.html | 4 +- pmd_devdocs_major_adding_new_language.html | 4 +- ...cs_major_adding_new_metrics_framework.html | 10 +- pmd_devdocs_major_rule_guidelines.html | 4 +- pmd_devdocs_pmdtester.html | 4 +- pmd_devdocs_roadmap.html | 4 +- pmd_devdocs_rule_deprecation_policy.html | 4 +- pmd_devdocs_writing_documentation.html | 26 +- pmd_java_metrics_index.html | 4 +- pmd_languages_gherkin.html | 4 +- pmd_languages_html.html | 4 +- pmd_languages_java.html | 4 +- pmd_languages_jsp.html | 4 +- pmd_languages_plsql.html | 4 +- pmd_languages_visualforce.html | 4 +- pmd_languages_xml.html | 10 +- pmd_next_major_development.html | 960 +++++++++--------- ...projectdocs_committers_infrastructure.html | 4 +- ...jectdocs_committers_main_landing_page.html | 4 +- ...docs_committers_merging_pull_requests.html | 4 +- pmd_projectdocs_committers_releasing.html | 4 +- pmd_projectdocs_credits.html | 4 +- pmd_projectdocs_decisions.html | 4 +- pmd_projectdocs_decisions_adr_1.html | 4 +- pmd_projectdocs_decisions_adr_2.html | 4 +- pmd_projectdocs_decisions_adr_NNN.html | 4 +- pmd_projectdocs_faq.html | 4 +- pmd_projectdocs_trivia_meaning.html | 4 +- pmd_projectdocs_trivia_news.html | 4 +- pmd_projectdocs_trivia_products.html | 4 +- pmd_projectdocs_trivia_similarprojects.html | 4 +- pmd_release_notes.html | 112 +- pmd_release_notes_old.html | 830 ++++++++------- pmd_rules_apex.html | 4 +- pmd_rules_apex_bestpractices.html | 4 +- pmd_rules_apex_codestyle.html | 4 +- pmd_rules_apex_design.html | 4 +- pmd_rules_apex_documentation.html | 4 +- pmd_rules_apex_errorprone.html | 4 +- pmd_rules_apex_performance.html | 4 +- pmd_rules_apex_security.html | 4 +- pmd_rules_ecmascript.html | 4 +- pmd_rules_ecmascript_bestpractices.html | 4 +- pmd_rules_ecmascript_codestyle.html | 4 +- pmd_rules_ecmascript_errorprone.html | 4 +- pmd_rules_html.html | 4 +- pmd_rules_html_bestpractices.html | 4 +- pmd_rules_java.html | 4 +- pmd_rules_java_bestpractices.html | 4 +- pmd_rules_java_codestyle.html | 4 +- pmd_rules_java_design.html | 4 +- pmd_rules_java_documentation.html | 4 +- pmd_rules_java_errorprone.html | 4 +- pmd_rules_java_multithreading.html | 4 +- pmd_rules_java_performance.html | 4 +- pmd_rules_java_security.html | 4 +- pmd_rules_jsp.html | 4 +- pmd_rules_jsp_bestpractices.html | 4 +- pmd_rules_jsp_codestyle.html | 4 +- pmd_rules_jsp_design.html | 4 +- pmd_rules_jsp_errorprone.html | 4 +- pmd_rules_jsp_security.html | 4 +- pmd_rules_modelica.html | 4 +- pmd_rules_modelica_bestpractices.html | 4 +- pmd_rules_plsql.html | 4 +- pmd_rules_plsql_bestpractices.html | 4 +- pmd_rules_plsql_codestyle.html | 4 +- pmd_rules_plsql_design.html | 4 +- pmd_rules_plsql_errorprone.html | 4 +- pmd_rules_pom.html | 4 +- pmd_rules_pom_errorprone.html | 4 +- pmd_rules_scala.html | 4 +- pmd_rules_vf.html | 4 +- pmd_rules_vf_security.html | 4 +- pmd_rules_vm.html | 4 +- pmd_rules_vm_bestpractices.html | 4 +- pmd_rules_vm_design.html | 4 +- pmd_rules_vm_errorprone.html | 4 +- pmd_rules_xml.html | 4 +- pmd_rules_xml_errorprone.html | 4 +- pmd_rules_xsl.html | 4 +- pmd_rules_xsl_codestyle.html | 4 +- pmd_rules_xsl_performance.html | 4 +- pmd_userdocs_3rdpartyrulesets.html | 4 +- pmd_userdocs_best_practices.html | 4 +- pmd_userdocs_cli_reference.html | 4 +- pmd_userdocs_configuring_rules.html | 4 +- pmd_userdocs_cpd.html | 6 +- pmd_userdocs_cpd_report_formats.html | 4 +- ...serdocs_extending_defining_properties.html | 18 +- ...userdocs_extending_designer_reference.html | 4 +- pmd_userdocs_extending_metrics_howto.html | 20 +- pmd_userdocs_extending_rule_guidelines.html | 4 +- pmd_userdocs_extending_testing.html | 6 +- ...userdocs_extending_writing_java_rules.html | 20 +- pmd_userdocs_extending_writing_pmd_rules.html | 4 +- ...serdocs_extending_writing_rules_intro.html | 8 +- ...serdocs_extending_writing_xpath_rules.html | 16 +- pmd_userdocs_extending_your_first_rule.html | 4 +- pmd_userdocs_incremental_analysis.html | 6 +- pmd_userdocs_installation.html | 12 +- pmd_userdocs_making_rulesets.html | 4 +- pmd_userdocs_report_formats.html | 4 +- pmd_userdocs_suppressing_warnings.html | 4 +- pmd_userdocs_tools.html | 4 +- pmd_userdocs_tools_ant.html | 14 +- pmd_userdocs_tools_ci.html | 4 +- pmd_userdocs_tools_gradle.html | 4 +- pmd_userdocs_tools_java_api.html | 4 +- pmd_userdocs_tools_maven.html | 4 +- tag_devdocs.html | 4 +- tag_extending.html | 4 +- tag_getting_started.html | 4 +- tag_languages.html | 4 +- tag_metrics.html | 4 +- tag_release_notes.html | 4 +- tag_rule_references.html | 4 +- tag_tools.html | 4 +- tag_troubleshooting.html | 4 +- tag_userdocs.html | 4 +- 133 files changed, 1295 insertions(+), 1261 deletions(-) diff --git a/404.html b/404.html index 6e952b6de4..fc22d846cc 100644 --- a/404.html +++ b/404.html @@ -174,8 +174,8 @@ @@ -2663,25 +2663,25 @@ The following usages are now deprecated in the JSP AST (with ot
  • Manual instantiation of nodes. Constructors of node classes are deprecated and -marked InternalApi. Nodes should only be obtained from the parser, +marked InternalApi. Nodes should only be obtained from the parser, which for rules, means that they never need to instantiate node themselves. Those constructors will be made package private with 7.0.0.
  • Subclassing of abstract node classes, or usage of their type. The base classes are internal API and will be hidden in version 7.0.0. You should not couple your code to them.
      -
    • In the meantime you should use interfaces like JspNode or -Node, or the other published interfaces in this package, +
    • In the meantime you should use interfaces like JspNode or +Node, or the other published interfaces in this package, to refer to nodes generically.
    • Concrete node classes will be made final with 7.0.0.
  • Setters found in any node class or interface. Rules should consider the AST immutable. We will make those setters package private with 7.0.0.
    • -
  • The class JspParser is deprecated and should not be used directly. -Use LanguageVersionHandler#getParser instead.
    • +
  • The class JspParser is deprecated and should not be used directly. +Use LanguageVersionHandler#getParser instead.
-

Please look at net.sourceforge.pmd.lang.jsp.ast to find out the full list of deprecations.

+

Please look at net.sourceforge.pmd.lang.jsp.ast to find out the full list of deprecations.

In ASTs (Velocity)
@@ -2691,28 +2691,28 @@ The following usages are now deprecated in the VM AST (with oth
  • Manual instantiation of nodes. Constructors of node classes are deprecated and -marked InternalApi. Nodes should only be obtained from the parser, +marked InternalApi. Nodes should only be obtained from the parser, which for rules, means that they never need to instantiate node themselves. Those constructors will be made package private with 7.0.0.
  • Subclassing of abstract node classes, or usage of their type. The base classes are internal API and will be hidden in version 7.0.0. You should not couple your code to them.
      -
    • In the meantime you should use interfaces like VmNode or -Node, or the other published interfaces in this package, +
    • In the meantime you should use interfaces like VmNode or +Node, or the other published interfaces in this package, to refer to nodes generically.
    • Concrete node classes will be made final with 7.0.0.
  • Setters found in any node class or interface. Rules should consider the AST immutable. We will make those setters package private with 7.0.0.
    • -
  • The package net.sourceforge.pmd.lang.vm.directive as well as the classes -DirectiveMapper and LogUtil are deprecated +
  • The package net.sourceforge.pmd.lang.vm.directive as well as the classes +DirectiveMapper and LogUtil are deprecated for removal. They were only used internally during parsing.
    • -
  • The class VmParser is deprecated and should not be used directly. -Use LanguageVersionHandler#getParser instead.
    • +
  • The class VmParser is deprecated and should not be used directly. +Use LanguageVersionHandler#getParser instead.
-

Please look at net.sourceforge.pmd.lang.vm.ast to find out the full list of deprecations.

+

Please look at net.sourceforge.pmd.lang.vm.ast to find out the full list of deprecations.

PLSQL AST
@@ -2729,36 +2729,36 @@ parsed as ASTCursorSpecificat You can identify them with the @InternalApi annotation. You’ll also get a deprecation warning.

@@ -2767,44 +2767,44 @@ by just that superclass.

6.14.0

@@ -3005,7 +3005,7 @@ or enable preview language features (e.g. CodeClimateRule is deprecated in 7.0.0 because it was unused for 2 years and +

CodeClimateRule is deprecated in 7.0.0 because it was unused for 2 years and created an unwanted dependency. Properties “cc_categories”, “cc_remediation_points_multiplier”, “cc_block_highlighting” will also be removed. See #1702 for more.

@@ -3023,13 +3023,13 @@ quickstart ruleset rulesets/a

6.11.0

6.10.0

@@ -3044,59 +3044,59 @@ to remove them in 7.0.0. The proposed changes to the API are described net.sourceforge.pmd.properties.builders, -is being replaced by the simpler PropertyBuilder. Their APIs enjoy a high degree of source compatibility.

+construction through builders. The builder hierarchy, currently found in the package net.sourceforge.pmd.properties.builders, +is being replaced by the simpler PropertyBuilder. Their APIs enjoy a high degree of source compatibility.

  • -

    Concrete property classes like IntegerProperty and StringMultiProperty will gradually -all be deprecated until 7.0.0. Their usages should be replaced by direct usage of the PropertyDescriptor +

    Concrete property classes like IntegerProperty and StringMultiProperty will gradually +all be deprecated until 7.0.0. Their usages should be replaced by direct usage of the PropertyDescriptor interface, e.g. PropertyDescriptor<Integer> or PropertyDescriptor<List<String>>.

  • -

    Instead of spreading properties across countless classes, the utility class PropertyFactory will become +

    Instead of spreading properties across countless classes, the utility class PropertyFactory will become from 7.0.0 on the only provider for property descriptor builders. Each current property type will be replaced by a corresponding method on PropertyFactory:

    @@ -3118,19 +3118,19 @@ are discontinued for lack of a use-case, and have no planned replacement in 7.0. @@ -3138,21 +3138,21 @@ accordingly.

    Changes to the PropertyDescriptor interface
      -
    • preferredRowCount is deprecated with no intended replacement. It was never implemented, and does not belong -in this interface. The methods uiOrder and compareTo(PropertyDescriptor) are deprecated for the +
    • preferredRowCount is deprecated with no intended replacement. It was never implemented, and does not belong +in this interface. The methods uiOrder and compareTo(PropertyDescriptor) are deprecated for the same reason. These methods mix presentation logic with business logic and are not necessary for PropertyDescriptors to work. PropertyDescriptor will not extend Comparable<PropertyDescriptor> anymore come 7.0.0.
      • -
    • The method propertyErrorFor is deprecated and will be removed with no intended +
    • The method propertyErrorFor is deprecated and will be removed with no intended replacement. It’s really just a shortcut for prop.errorFor(rule.getProperty(prop)).
      • -
    • T valueFrom(String) and String asDelimitedString(T) are deprecated and will be removed. These were +
    • T valueFrom(String) and String asDelimitedString(T) are deprecated and will be removed. These were used to serialize and deserialize properties to/from a string, but 7.0.0 will introduce a more flexible XML syntax which will make them obsolete.
      • -
    • isMultiValue and type are deprecated and won’t be replaced. The new XML syntax will remove the need +
    • isMultiValue and type are deprecated and won’t be replaced. The new XML syntax will remove the need for a divide between multi- and single-value properties, and will allow arbitrary types to be represented. Since arbitrary types may be represented, type will become obsolete as it can’t represent generic types, which will nevertheless be representable with the XML syntax. It was only used for documentation, but a new way to document these properties exhaustively will be added with 7.0.0.
      • -
    • errorFor is deprecated as its return type will be changed to Optional<String> with the shift to Java 8.
      • +
    • errorFor is deprecated as its return type will be changed to Optional<String> with the shift to Java 8.
    Deprecated APIs
    @@ -3161,27 +3161,27 @@ new way to document these properties exhaustively will be added with 7.0.0.
    • @@ -3189,21 +3189,21 @@ and will be moved into an internal package with 7.0.0. To implement your own met
  • @@ -3229,25 +3229,25 @@ are not fully supported by PMD, so having a language module does not make sense. not affected by this change. The following classes have been deprecated and will be removed with PMD 7.0.0:

  • @@ -3256,12 +3256,12 @@ in 7.0.0 to factorise common logic and make them extensible. Further explanation found on #1426. Consequently, the following APIs are deprecated for removal:

    • diff --git a/pmd_projectdocs_committers_infrastructure.html b/pmd_projectdocs_committers_infrastructure.html index ebc7e8659f..2b887b5a1e 100644 --- a/pmd_projectdocs_committers_infrastructure.html +++ b/pmd_projectdocs_committers_infrastructure.html @@ -174,8 +174,8 @@