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

Update modules description and properties to NOT have javadoc tags #324

Open
romani opened this issue Aug 30, 2020 · 0 comments
Open

Update modules description and properties to NOT have javadoc tags #324

romani opened this issue Aug 30, 2020 · 0 comments
Labels

Comments

@romani
Copy link
Member

romani commented Aug 30, 2020

Sonar 4.36 (based on checkstyle 8.36)

All descriptions of modules become a bit unpleasant to read due to javadoc tags (example {@code allowedAbbreviationLength}

{@code ignoreFinal}, {@code ignoreStatic}, and {@code ignoreStaticFinal} control whether variables with the respective modifiers are to be ignored. Note that a variable that is both static and final will always be considered under {@code ignoreStaticFinal} only, regardless of the values of {@code ignoreFinal} and {@code ignoreStatic}. So for example if {@code ignoreStatic} is true but {@code ignoreStaticFinal} is false, then static final variables will not be ignored.

Properties also

ignoreOverriddenMethods
Allow to ignore methods tagged with {@code @Override} annotation (that usually mean inherited name).

Image:
image

Expected:
module description content should update test to convert javadoc to html ("pre" or "code" .. .what ever to make it better to look).
module properties content is plain text, javadoc should be just unwrapped from javadoc tag to plain text.

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

No branches or pull requests

1 participant