Online help for problem markers #569
Conversation
| group = "misc"; | ||
| } | ||
| var file = moduleName.toLowerCase(); | ||
| return "https://checkstyle.org/checks/" + group + "/" + file + ".html#" + moduleName; |
There was a problem hiding this comment.
I am not seeing this check, so I would recommend ensuring it is a Checkstyle check. You don't want to assume all are as this would cause issues with 3rd parties like sevntu checks.
There was a problem hiding this comment.
AFAIK we will not be asked for a context in line 80 if we returned false from line 70. E.g. first comes the "hasContext", and only then the "getContext" call (if hasContext was true). But I could add a second identical check in getContext to be on the safe side. We will not get into this method (with your comment) if getContext() doesn't return a context.
There was a problem hiding this comment.
I will take your word at this, as I don't know EclipseCS enough on how context connects to if the check is from checkstyle or a 3rd party. I was just raising the concern that the link create will be invalid if you run it for a 3rd party check as it's documentation will not be on Checkstyle's website.
net.sf.eclipsecs.ui/src/net/sf/eclipsecs/ui/quickfixes/MarkerHelpContextProvider.java
Show resolved
Hide resolved
* Register a problem marker help provider. * Calculate a context help topic for each marker and dynamically forward it to the original online help of the related check. For the end user, pressing F1 on a marker has the result of opening the integrated Eclipse help and showing the checkstyle problem description online. Fixes checkstyle#568.
For the end user, pressing F1 on a marker has the result of opening the integrated Eclipse help and showing the checkstyle problem description online.
Fixes #568.
See the modifier order problem marker selected and its help shown:
