Merge pull request #4144 from adangel/doc-supported-languages

[doc] Update docs to reflect supported languages
This commit is contained in:
Juan Martín Sotuyo Dodero
2022-10-06 13:04:34 -03:00
committed by GitHub
5 changed files with 13 additions and 9 deletions

View File

@ -7,7 +7,7 @@ summary: >
Welcome to the documentation site for PMD and CPD! <br/><br/> Welcome to the documentation site for PMD and CPD! <br/><br/>
last_updated: August 2017 last_updated: October 2022
author: Jeff Jensen <jjensen@apache.org>, Andreas Dangel <andreas.dangel@adangel.org>, author: Jeff Jensen <jjensen@apache.org>, Andreas Dangel <andreas.dangel@adangel.org>,
Clément Fournier <clement.fournier76@gmail.com> Clément Fournier <clement.fournier76@gmail.com>
--- ---
@ -29,7 +29,7 @@ author: Jeff Jensen <jjensen@apache.org>, Andreas Dangel <andreas.dangel@adangel
**PMD** is a static source code analyzer. It finds common programming flaws like **PMD** is a static source code analyzer. It finds common programming flaws like
unused variables, empty catch blocks, unnecessary object creation, and unused variables, empty catch blocks, unnecessary object creation, and
so forth. It's mainly concerned with **Java and Apex**, but **supports six other so forth. It's mainly concerned with **Java and Apex**, but **supports 12 other
languages**. languages**.
PMD features many **built-in checks** (in PMD lingo, *rules*), which are documented PMD features many **built-in checks** (in PMD lingo, *rules*), which are documented

View File

@ -197,18 +197,20 @@ Example:
``` ```
* [apex](pmd_rules_apex.html) (Salesforce Apex) * [apex](pmd_rules_apex.html) (Salesforce Apex)
* [ecmascript](pmd_rules_ecmascript.html) (JavaScript)
* [html](pmd_rules_html.html)
* [java](pmd_rules_java.html) * [java](pmd_rules_java.html)
* [Supported Versions](pmd_languages_java.html) * [Supported Versions](pmd_languages_java.html)
* [ecmascript](pmd_rules_ecmascript.html) (JavaScript)
* [jsp](pmd_rules_jsp.html) * [jsp](pmd_rules_jsp.html)
* [modelica](pmd_rules_modelica.html) * [modelica](pmd_rules_modelica.html)
* [plsql](pmd_rules_plsql.html) * [plsql](pmd_rules_plsql.html)
* [pom](pmd_rules_pom.html) (Maven POM)
* [scala](pmd_rules_scala.html) * [scala](pmd_rules_scala.html)
* Supported Versions: 2.10, 2.11, 2.12, 2.13 (default) * Supported Versions: 2.10, 2.11, 2.12, 2.13 (default)
* [vf](pmd_rules_vf.html) (Salesforce VisualForce) * [vf](pmd_rules_vf.html) (Salesforce VisualForce)
* [vm](pmd_rules_vm.html) (Apache Velocity) * [vm](pmd_rules_vm.html) (Apache Velocity)
* [xml and xsl](pmd_rules_xml.html) * [xml](pmd_rules_xml.html)
* [xsl](pmd_rules_xsl.html)
## Available Report Formats ## Available Report Formats

View File

@ -15,7 +15,7 @@ sidebar: pmd_sidebar
OpenJDK from [Azul](https://www.azul.com/downloads/zulu-community/) OpenJDK from [Azul](https://www.azul.com/downloads/zulu-community/)
or [AdoptOpenJDK](https://adoptopenjdk.net/) 1.7 or higher. or [AdoptOpenJDK](https://adoptopenjdk.net/) 1.7 or higher.
**Note:** For analyzing Apex, JavaScript, Scala or VisualForce or running the [Designer](pmd_userdocs_extending_designer_reference.html) **Note:** For analyzing Apex, HTML, JavaScript, Scala or VisualForce or running the [Designer](pmd_userdocs_extending_designer_reference.html)
at least Java 8 is required. at least Java 8 is required.
* A zip archiver, e.g.: * A zip archiver, e.g.:
@ -23,7 +23,7 @@ sidebar: pmd_sidebar
* For Windows: [Winzip](http://winzip.com) or the free [7-zip](http://www.7-zip.org/) * For Windows: [Winzip](http://winzip.com) or the free [7-zip](http://www.7-zip.org/)
* For Linux / Unix: [InfoZip](http://infozip.sourceforge.net/) * For Linux / Unix: [InfoZip](http://infozip.sourceforge.net/)
{% include note.html content="For executing the Designer (./run.sh designer) using [OpenJDK](http://jdk.java.net) or Java 11, you need additionally [OpenJFX](http://jdk.java.net). Download it, extract it and set the environment variable JAVAFX_HOME." %} {% include note.html content="For executing the Designer (./run.sh designer) using [OpenJDK](http://jdk.java.net) or Java 11, you need additionally [OpenJFX](https://openjfx.io/). Download it, extract it and set the environment variable JAVAFX_HOME." %}
### Installation ### Installation

View File

@ -15,6 +15,8 @@ This is a {{ site.pmd.release_type }} release.
### New and noteworthy ### New and noteworthy
### Fixed Issues ### Fixed Issues
* doc
* [#4144](https://github.com/pmd/pmd/pull/4144) \[doc] Update docs to reflect supported languages
* java-documentation * java-documentation
* [#4141](https://github.com/pmd/pmd/issues/4141): \[java] UncommentedEmptyConstructor FP when constructor annotated with @<!-- -->Autowired * [#4141](https://github.com/pmd/pmd/issues/4141): \[java] UncommentedEmptyConstructor FP when constructor annotated with @<!-- -->Autowired

View File

@ -10,10 +10,10 @@
<description> <description>
PMD is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks, PMD is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks,
unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce, unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce,
Modelica, PLSQL, Apache Velocity, XML, XSL, Scala. Modelica, PLSQL, Apache Velocity, HTML, XML, XSL, Scala.
Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code in Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code in
C/C++, C#, Dart, Fortran, Go, Groovy, Java, JavaScript, JSP, Kotlin, Lua, Matlab, Modelica, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Kotlin, Lua, Matlab, Modelica,
Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex, Scala, Swift and Visualforce. Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex, Scala, Swift and Visualforce.
</description> </description>