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

Fix all violations of JavadocParagrath check in checkstyle code base #1038

Open
romani opened this issue Oct 16, 2024 · 2 comments
Open

Fix all violations of JavadocParagrath check in checkstyle code base #1038

romani opened this issue Oct 16, 2024 · 2 comments
Assignees
Labels

Comments

@romani
Copy link
Member

romani commented Oct 16, 2024

copy of checkstyle/checkstyle#15763

Suppression introduced at https://github.com/checkstyle/checkstyle/pull/15686/files#r1785246044

We need to resolve all cases in our code and remove suppression. There are about 250 violations.

[INFO] --- antrun:3.1.0:run (ant-phase-verify) @ sevntu-checks ---00:54
[INFO] Executing tasks00:54
[INFO]      [echo] Checkstyle started (../../../config/checkstyle-checks.xml): 15/10/2024 08:26:45 PM00:54
[INFO] [checkstyle] Running Checkstyle 10.18.3-SNAPSHOT on 141 files00:56
[ERROR] [checkstyle] [ERROR] sevntu/checkstyle/checks/annotation/ForbidAnnotationElementValueCheck.java:34:4:
    Redundant <p> tag. [JavadocParagraph]00:59
[ERROR] [checkstyle] [ERROR] sevntu/checkstyle/checks/annotation/ForbidAnnotationElementValueCheck.java:45:4:
    <p> tag should be preceded with an empty line. [JavadocParagraph]00:59
...

https://checkstyle.semaphoreci.com/jobs/808b67ff-760f-438b-9baf-a11607a38637

removal of P tag from first block of text causes Element 'subsection' cannot have character [children], because the type's content type is element-only., it is limitation of Xdoc files that we are using, workaround is change P to DIV
see details at checkstyle/checkstyle#15764 (comment)

@Zopsss
Copy link
Contributor

Zopsss commented Oct 16, 2024

pls assign this issue to me. I will fix it later.

@romani
Copy link
Member Author

romani commented Oct 17, 2024

@Zopsss , thanks a lot

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

2 participants