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

JavadocParagraph allows new line before the next paragraph #1332

Closed
pbaranchikov opened this issue Jul 9, 2015 · 2 comments
Closed

JavadocParagraph allows new line before the next paragraph #1332

pbaranchikov opened this issue Jul 9, 2015 · 2 comments
Assignees
Milestone

Comments

@pbaranchikov
Copy link
Contributor

http://checkstyle.sourceforge.net/config_javadoc.html#JavadocParagraph
created base on requirements of http://google.github.io/styleguide/javaguide.html#s7.1.2-javadoc-paragraphs

According to documentation:

Each paragraph but the first has <p> immediately before the first word, with no space after.

I could have <p> tag, followed by new line. Text is continued from the next line, so the tag is not "immediately before the first word"

/**
 * First paragraph.
 * 
 * <p>
 * Second paragraph.
 */

Also, even spaces are not violated:

/**
 * First paragraph.
 * 
 * <p> Second paragraph.
 */
@romani
Copy link
Member

romani commented Jul 10, 2015

good point, I do not see any reference in code that it do validation for that, completely missed functionality.

@romani
Copy link
Member

romani commented Jul 19, 2015

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