forked from phoedos/pmd
fixed documentation links
This commit is contained in:
@ -428,7 +428,7 @@ author: Tom Copeland <tom@infoether.org>
|
||||
* Mat Booth - #1109 Patch to build with Javacc 5.0
|
||||
* Stuart Turton - for PLSQL support. See also [pldoc](http://pldoc.sourceforge.net/)
|
||||
* Andrey Utis - for adding Apache Velocity as a new language and writing up a
|
||||
[howto for adding new languages](../customizing/new-language.html).
|
||||
[howto for adding new languages](pmd_devdocs_major_adding_new_language.html).
|
||||
* Alan Hohn - for adding Standard and modified cyclomatic complexity rules
|
||||
* Jan van Nunen - for adding CPD support for Matlab, Objective-C, Python, Scala and various bug fixes
|
||||
* Juan Martín Sotuyo Dodero - for many bugfixes/pull requests improving Java grammar and performance
|
||||
|
@ -25,7 +25,7 @@ Use the rules you like [via a custom ruleset](pmd_userdocs_making_rulesets.html)
|
||||
|
||||
## PMD rules are not set in stone
|
||||
|
||||
Generally, pick the ones you like, and ignore or [suppress](pmd_userdocs_suppressing.html)
|
||||
Generally, pick the ones you like, and ignore or [suppress](pmd_userdocs_suppressing_warnings.html)
|
||||
the warnings you don't like. It's just a tool.
|
||||
|
||||
## PMD IDE plugins are nice
|
||||
|
@ -166,7 +166,7 @@ This behavior has been introduced to ease PMD integration into scripts or hooks,
|
||||
|
||||
* [apex](pmd_rules_apex.html) (Salesforce Apex)
|
||||
* [java](pmd_rules_java.html)
|
||||
* [ecmascript](pmd_rules_javascript.html) (JavaScript)
|
||||
* [ecmascript](pmd_rules_ecmascript.html) (JavaScript)
|
||||
* [jsp](pmd_rules_jsp.html)
|
||||
* [plsql](pmd_rules_plsql.html)
|
||||
* [vf](pmd_rules_vf.html) (Salesforce VisualForce)
|
||||
|
@ -17,7 +17,7 @@ It can also be run with Maven by using the `cpd-check` goal on the [Maven PMD Pl
|
||||
|
||||
|
||||
Your own language is missing?
|
||||
See how to add it [here](/pmd_devdocs_adding_new_cpd_language.html).
|
||||
See how to add it [here](/pmd_devdocs_major_adding_new_cpd_language.html).
|
||||
|
||||
|
||||
### Why should you care about duplicates?
|
||||
|
@ -50,7 +50,7 @@ Rules which use the RuleChain to visit the AST are faster than rules which perfo
|
||||
|
||||
## Adding test cases
|
||||
|
||||
See [Test Framework](pmd_devdocs_testing.html) for the general documentation
|
||||
See [Testing your rules](pmd_userdocs_extending_testing.html) for the general documentation
|
||||
|
||||
### … for a rule I want to submit (in a patch)
|
||||
|
||||
@ -59,7 +59,7 @@ the category and add the XML test data in the correct xml subpackage.
|
||||
|
||||
### … for something too specific, that I won’t be able to submit
|
||||
|
||||
See [Using the test framework externally](pmd_devdocs_testing.html#using-the-test-framework-externally)
|
||||
See [Using the test framework externally](pmd_userdocs_extending_testing.html#using-the-test-framework-externally)
|
||||
|
||||
## Code quality
|
||||
|
||||
|
@ -248,7 +248,7 @@ Note that access modifiers are held as attributes, so, for example,
|
||||
|
||||
`//FieldDeclaration[@Private='true']`
|
||||
|
||||
finds all private fields. You can see the code that determines all the attributes [here](pmd-core/xref/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.html)
|
||||
finds all private fields. You can see the code that determines all the attributes [here](https://github.com/pmd/pmd/blob/master/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.java)
|
||||
|
||||
More information about writing XPath rules is [available here](pmd_userdocs_extending_writing_xpath_rules.html).
|
||||
|
||||
|
@ -16,7 +16,7 @@ Writing PMD rules with XPath can be a bit easier than writing rules with Java co
|
||||
|
||||
## Introduction
|
||||
|
||||
PMD provides a very handy method for writing rules by writing an XPath query. When the XPath query finds a match, a violation is added to the report. This document focuses on XPath rules. You can go [here](howtowritearule.html) for more information about writing a rule.
|
||||
PMD provides a very handy method for writing rules by writing an XPath query. When the XPath query finds a match, a violation is added to the report. This document focuses on XPath rules. You can go [here](pmd_userdocs_extending_writing_pmd_rules.html) for more information about writing a rule.
|
||||
|
||||
## What is the Abstract Syntax Tree (AST)?
|
||||
|
||||
|
@ -105,7 +105,7 @@ Additionally, the following options, are specified most of the time even though
|
||||
|
||||
{% include note.html
|
||||
content="CPD supports Java, JSP, C, C++, C#, Fortran and PHP source code, among other languages.
|
||||
For the full list, see [Supported Languages](pmd_userdocs_cpd#supported-languages)." %}
|
||||
For the full list, see [Supported Languages](pmd_userdocs_cpd.html#supported-languages)." %}
|
||||
|
||||
Like for PMD, CPD is started on Unix by `run.sh cpd` and on Windows by `cpd.bat`.
|
||||
|
||||
|
@ -32,7 +32,7 @@ for you:
|
||||
changing the Rule, but you do not need to submit a patch back to the
|
||||
PMD project.
|
||||
|
||||
If you need to modify the Rule, see [How to write a rule](pmd_devdocs_writing_pmd_rules.html).
|
||||
If you need to modify the Rule, see [How to write a rule](pmd_userdocs_extending_writing_pmd_rules.html).
|
||||
Otherwise, the other suppression methods are explained in the following sections.
|
||||
|
||||
## Annotations
|
||||
|
@ -669,8 +669,8 @@ extended for lambda parameters with Java 11 via
|
||||
|
||||
#### Modified Rules
|
||||
|
||||
* The Java rules [`AccessorClassGeneration`](pmd_rules_java_bestpracices.html#accessorclassgeneration) and
|
||||
[`AccessorMethodGeneration`](pmd_rules_java_bestpracices.html#accessormethodgeneration) (both in category
|
||||
* The Java rules [`AccessorClassGeneration`](pmd_rules_java_bestpractices.html#accessorclassgeneration) and
|
||||
[`AccessorMethodGeneration`](pmd_rules_java_bestpractices.html#accessormethodgeneration) (both in category
|
||||
`java-bestpractices`) have been modified to be only valid up until Java 10. Java 11 adds support for
|
||||
[JEP 181: Nest-Based Access Control](http://openjdk.java.net/jeps/181) which avoids the generation of
|
||||
accessor classes / methods altogether.
|
||||
@ -1143,7 +1143,7 @@ Both are bugfixing releases.
|
||||
|
||||
#### Disable Incremental Analysis
|
||||
|
||||
Some time ago, we added support for [Incremental Analysis](pmd_userdocs_getting_started.html). On PMD 6.0.0, we
|
||||
Some time ago, we added support for [Incremental Analysis](pmd_userdocs_incremental_analysis.html). On PMD 6.0.0, we
|
||||
started to add warns when not using it, as we strongly believe it's a great improvement to our user's experience as
|
||||
analysis time is greatly reduced; and in the future we plan to have it enabled by default. However, we realize some
|
||||
scenarios don't benefit from it (ie: CI jobs), and having the warning logged can be noisy and cause confusion.
|
||||
@ -1767,7 +1767,7 @@ when using/setting values for rules, there are adjustments necessary when declar
|
||||
rules.
|
||||
|
||||
Rule properties can be declared both for Java based rules and XPath rules.
|
||||
This is now very well documented in [Working with properties](pmd_devdocs_working_with_properties.html).
|
||||
This is now very well documented in [Working with properties](pmd_userdocs_extending_defining_properties.html).
|
||||
|
||||
With PMD 6.0.0, multivalued properties are now also possible with XPath rules.
|
||||
|
||||
|
Reference in New Issue
Block a user