Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TokenTypes documentation contains double encoded symbols #5423

Closed
pbludov opened this issue Jan 4, 2018 · 2 comments
Closed

TokenTypes documentation contains double encoded symbols #5423

pbludov opened this issue Jan 4, 2018 · 2 comments

Comments

@pbludov
Copy link
Member

pbludov commented Jan 4, 2018

This file
http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html
http://checkstyle.sourceforge.net/apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html
is hard to read. Many symbols are displayed in encoded form.

Some examples:

Modifier and Type Field and Description
static int LNOT The ! (logical complement) operator.
static int LE The <= (less than or equal) operator.
static int BSR The >>> (unsigned shift right) operator.
static int BSR_ASSIGN The >>>= (unsigned right shift assignment) operator.

It looks like encoded symbols were not decoded when <code> </ code> was replaced with {@ code}. It's a bug in the Idea actually. But the docs need to be fixed anyway.

regression caused by 7078670 in scope of #4805

see limitations of @code tag at - #5425

@rnveach
Copy link
Member

rnveach commented Jan 4, 2018

I agree with this. Users shouldn't need to know HTML encoding to understand the document.
Nothing matching regular expression \&\w\w; should be displayed.
I can't imagine we would display something like this to user on purpose.

romani pushed a commit that referenced this issue Jan 5, 2018
@romani romani added this to the 8.8 milestone Jan 5, 2018
@romani
Copy link
Member

romani commented Jan 5, 2018

fix is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants