phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Update release notes, docs

Browse Source
This commit is contained in:
Andreas Dangel
2017-12-15 12:02:24 +01:00
parent 5eb3ecd5ad
commit ca07aa2964
5 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.md
View File

@ -47,6 +47,7 @@ Features:
Supported Languages:
* [Java](pmd_rules_java.html)
* [JSP](pmd_rules_jsp.html)
* [JavaScript](pmd_rules_ecmascript.html)
* [Salesforce.com Apex](pmd_rules_apex.html) and [Visualforce](pmd_rules_vf.html)
* [PLSQL](pmd_rules_plsql.html)

2
docs/pages/pmd/devdocs/releasing.md
View File

@ -17,7 +17,7 @@ through the release process.
Make sure code is up to date and everything is committed and pushed with git:
$ mvn clean
$ ./mvnw clean
$ git pull
$ git status

13
docs/pages/pmd/userdocs/getting_started.md
View File

@ -261,12 +261,13 @@ This behavior has been introduced to ease PMD integration into scripts or hooks,
### Supported Languages
* [apex](/pmd_rules_apex.html)
* [java](/pmd_rules_java.html)
* [ecmascript](/pmd_rules_javascript.html) (JavaScript)
* [jsp](/pmd_rules_jsp.html)
* [plsql](/pmd_rules_plsql.html)
* [vm](/pmd_rules_vm.html) (Apache Velocity)
* [apex](pmd_rules_apex.html) (Salesforce Apex)
* [java](pmd_rules_java.html)
* [ecmascript](pmd_rules_javascript.html) (JavaScript)
* [jsp](pmd_rules_jsp.html)
* [plsql](pmd_rules_plsql.html)
* [vf](pmd_rules_vf.html) (Salesforce VisualForce)
* [vm](pmd_rules_vm.html) (Apache Velocity)
* [xml and xsl](/pmd_rules_xml.html)

8
docs/pages/pmd/userdocs/tools/ant.md
View File

@ -151,8 +151,7 @@ and the associated version (1.5, 1.6,...)
The specific version of a language to be used for parsing is selected via the `sourceLanguage`
nested element. Possible values are:
<sourceLanguage name="cpp" version=""/>
<sourceLanguage name="fortran" version=""/>
<sourceLanguage name="apex" version=""/>
<sourceLanguage name="ecmascript" version="3"/>
<sourceLanguage name="java" version="1.3"/>
<sourceLanguage name="java" version="1.4"/>
@ -160,12 +159,13 @@ nested element. Possible values are:
<sourceLanguage name="java" version="1.6"/>
<sourceLanguage name="java" version="1.7"/>
<sourceLanguage name="java" version="1.8"/>
<sourceLanguage name="java" version="9"/>
<sourceLanguage name="jsp" version=""/>
<sourceLanguage name="php" version=""/>
<sourceLanguage name="ruby" version=""/>
<sourceLanguage name="pom" version=""/>
<sourceLanguage name="plsql" version=""/>
<sourceLanguage name="xsl" version=""/>
<sourceLanguage name="xml" version=""/>
<sourceLanguage name="vf" version=""/>
<sourceLanguage name="vm" version=""/>
### Postprocessing the report file with XSLT

16
docs/pages/release_notes.md
View File

@ -41,7 +41,7 @@ Thanks to [Clément Fournier](https://github.com/oowekyala), we now have a new r
is based on JavaFX. It replaces the old designer and can be started via
* `bin/run.sh designer` (on Unix-like platform such as Linux and Mac OS X)
* `bin\\designer.bat` (on Windows)
* `bin\designer.bat` (on Windows)
Note: At least Java8 is required for the designer. The old designer is still available
as `designerold` but will be removed with the next major release.
@ -70,21 +70,23 @@ CPD will therefore have less false positives and false negatives.
#### Java Type Resolution
As part of Google Summer of Code 2017, [Bendegúz Nagy](https://github.com/WinterGrascph)'s work on type resolution for Java continues.
For this release he has extended support for method calls for both instance and static methods.
As part of Google Summer of Code 2017, [Bendegúz Nagy](https://github.com/WinterGrascph) worked on type resolution
for Java. For this release he has extended support for method calls for both instance and static methods.
Method shadowing and overloading are supported, as are varargs. However, the selection of the target method upon the presence
of generics and type inference is still work in progress. Expect it in forecoming releases.
Method shadowing and overloading are supported, as are varargs. However, the selection of the target method upon
the presence of generics and type inference is still work in progress. Expect it in forecoming releases.
As for fields, the basic support was in place for release 5.8.0, but has now been expanded to support static fields.
#### Metrics Framework
As part of Google Summer of Code 2017, [Clément Fournier](https://github.com/oowekyala) is continuing his work
As part of Google Summer of Code 2017, [Clément Fournier](https://github.com/oowekyala) is worked
on the new metrics framework for object-oriented metrics.
There are already a couple of metrics (e.g. ATFD, WMC, Cyclo, LoC) implemented. More metrics are planned.
Based on those metrics, rules like "GodClass" detection can be implemented more easily.
Based on those metrics, rules like "GodClass" detection could be implemented more easily.
The following rules benefit from the metrics framework: NcssCount (java), NPathComplexity (java),
CyclomaticComplexity (both java and apex).
The Metrics framework has been abstracted and is available in `pmd-core` for other languages. With this
PMD release, the metrics framework is supported for both Java and Apex.