Skip to content

Commit f2acdb5

Browse files
committed
README.md: documented Show Cppcheck XML Output action and its limitations
1 parent fdf161f commit f2acdb5

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See
1414

1515
- [`cppcheck` in JetBrains Plugin Repository][cppcheck_plugin]
1616

17-
## Usage
17+
### Initial Configuration
1818

1919
1. Install the [`cppcheck`](http://cppcheck.sourceforge.net/) tool using the instructions on its homepage. This plugin
2020
does **not** bundle the `cppcheck` tool itself, which must be installed separately.
@@ -34,6 +34,12 @@ See
3434

3535
[cppcheck_plugin]: https://plugins.jetbrains.com/plugin/8143
3636

37+
## Usage
38+
39+
### Provided Actions
40+
41+
The plugin provides the `Show Cppcheck XML Output` action which will show the raw XML output of the latest finished analysis.
42+
3743
## Known Issues
3844

3945
`cppcheck` is not designed to be run on header files (`.h`) directly, as must be done for this
@@ -43,6 +49,9 @@ When run on header files directly, `cppcheck` defaults to C as the language, whi
4349
false positives for C++ projects. C++ projects should append `--language=c++` to the
4450
`cppcheck` options.
4551

52+
`Show Cppcheck XML Output` only shows the XML result of the latest analysis. If you need to view the results for a
53+
specific file make sure it was the last one analyzed.
54+
4655
## Development
4756

4857
To run the plugin from source, open this project in IntelliJ and create a new "Plugin" run configuration. Running or

0 commit comments

Comments
 (0)