Update docs

This commit is contained in:
Clément Fournier 2021-05-14 17:45:09 +02:00
parent e54c4dc366
commit 23e101f62a
No known key found for this signature in database
GPG Key ID: 4D8D42402E4F47E2
2 changed files with 5 additions and 2 deletions

View File

@ -111,7 +111,7 @@ The tool comes with a rather extensive help text, simply running with `-help`!
%}
{% include custom/cli_option_row.html options="-reportfile,-r"
option_arg="path"
description="Path to a file in which the report output will be sent. By default the report is printed on standard output."
description="Path to a file to which report output is written. The file is created if it does not exist. If this option is not specified, the report is rendered to standard output."
%}
{% include custom/cli_option_row.html options="-shortnames"
description="Prints shortened filenames in the report."

View File

@ -89,7 +89,10 @@ public class PMDParameters {
converter = PropertyConverter.class)
private List<Properties> properties = new ArrayList<>();
@Parameter(names = { "-reportfile", "-r" }, description = "Sends report output to a file; default to System.out.")
@Parameter(names = { "-reportfile", "-r" },
description = "Path to a file to which report output is written. "
+ "The file is created if it does not exist. "
+ "If this option is not specified, the report is rendered to standard output.")
private String reportfile = null;
@Parameter(names = { "-version", "-v" }, description = "Specify version of a language PMD should use.")