Skip to content

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

Open
@romani

Description

@romani

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions