Improve documentation and describe the ID of the native format parser.
@@ -170,11 +170,16 @@ A simple way to get the analysis results of your tool into the Warnings plugin i
of the already supported formats. E.g., several tools export their issues into the CheckStyle or PMD format. If you
want to use all features of the Warnings Plugin it would be even better if you would export the information into the
*native* [XML](../src/test/resources/io/jenkins/plugins/analysis/warnings/warnings-issues.xml) or
-[JSON](../src/test/resources/io/jenkins/plugins/analysis/warnings/issues.json) format.
+[JSON](../src/test/resources/io/jenkins/plugins/analysis/warnings/issues.json) format (this parser uses the ID `issues`).
These formats are already registered in the user interface and you can use them out-of-the-box. You can even provide
issues in a simple log file that contains single lines of JSON issues, see
[example](../src/test/resources/io/jenkins/plugins/analysis/warnings/json-issues.log).
+Here is an example step that can be used to parse the native JSON (or XML) format:
+
+```groovy
+recordIssues(tool: issues())
+```
#### Deploying a new tool using a custom plugin
The most flexible way is to define a new tool by writing a Java class that will be deployed in your own small
