-
Type:
Improvement
-
Resolution: Unresolved
-
Priority:
Minor
-
Component/s: analysis-model, warnings-ng-plugin
If you want to access the documentation for a category, you have to copy the category (being careful not to accidentally click on it) and then enter it in the search engine.
Many linters should have corresponding documentation for each category. For Clang-Tidy, this would be, for example:
https://clang.llvm.org/extra/clang-tidy/checks/<category>/<check>.html, where, e.g., category is bugprone and check is forward-declaration-namespace
Therefore, it would be beneficial if the plugin could provide a link to the documentation for the categories. I believe it would be sufficient if this were done via JavaScript and the checker only provided the regex.
To avoid overloading the UI, it would probably be sufficient to display it in the hover event (which is disadvantageous for mobile users, but I assume most Jenkins users use Jenkins from a PC).
 So it could look like this:
