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

Boolean flag in Javadoc Checks that shows a current Javadoc comment has unclosed HTML tags #3311

Closed
baratali opened this Issue Jun 25, 2016 · 18 comments

Comments

@baratali
Contributor

baratali commented Jun 25, 2016

Add a boolean flag (hasUnclosedTag) to Javadoc Checks that shows a current Javadoc comment has unclosed HTML tags (and therefore has non-nested AST structure).

Reason:

We expect non XHTML structure(we are not failing) so all Javadoc check have to expect non-nested AST. It will create a lot of problems to write reliable Javadoc Check, as amount of false positives will be huge.
We need somehow to allow Check to decide to skip execution on Javadoc that is not XHTML , to let author of Check decide to support non-nested AST or not.
Can we somehow grab from parser a flag that javadoc is not xhtml ?

Probably that flag should be obtained in the JavadocParser grammar. Have a look at this rule:

htmlElement: htmlTag
            | singletonElement
            | paragraph
            | li
            | tr
            | td
            | th
            | body
            | colgroup
            | dd
            | dt
            | head
            | html
            | option
            | tbody
            | thead
            | tfoot

            | pTagOpen ### Here goes unclosed tags ###
            | liTagOpen
            | trTagOpen
            | tdTagOpen
            | thTagOpen
            | bodyTagOpen
            | colgroupTagOpen
            | ddTagOpen
            | dtTagOpen
            | headTagOpen
            | htmlTagOpen
            | optionTagOpen
            | tbodyTagOpen
            | theadTagOpen
            | tfootTagOpen

            | pTagClose
            | liTagClose
            | trTagClose
            | tdTagClose
            | thTagClose
            | bodyTagClose
            | colgroupTagClose
            | ddTagClose
            | dtTagClose
            | headTagClose
            | htmlTagClose
            | optionTagClose
            | tbodyTagClose
            | theadTagClose
            | tfootTagClose
            ;

Result changes to AbstractJavadocCheck.java:
filed - violateExecutionOnNonTightHtml
method - acceptJavadocWithNonTightHtml()

@unrealwork

This comment has been minimized.

Show comment
Hide comment
@unrealwork

unrealwork Apr 3, 2017

Contributor

I am on it!

Contributor

unrealwork commented Apr 3, 2017

I am on it!

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Jun 24, 2017

Collaborator

@rnveach @romani @Vladlis It looks like this issue can be resolved both ways, by adding code to grammar and by post processing the Parse Tree. Do you think that adding java code to grammar would be a bad desgin which may later create issues while upgrading ANTLR grammar for javadoc as it is creating issues for java right now ?

Collaborator

ps-sp commented Jun 24, 2017

@rnveach @romani @Vladlis It looks like this issue can be resolved both ways, by adding code to grammar and by post processing the Parse Tree. Do you think that adding java code to grammar would be a bad desgin which may later create issues while upgrading ANTLR grammar for javadoc as it is creating issues for java right now ?

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Jun 25, 2017

Member

Just my opinion, but if it makes things faster having Java code inside the grammar, i am fine with it.
We should limit Java code in grammar since grammar is not suppose to rely on external language, but it is our grammar so it shouldn't be a big deal.

@romani why do we need this boolean for unclosed tags? Checking the parent and position will tell anyone if the tag is closed.
Examples:

    |  |  |  |      |--HTML_ELEMENT -> <p>Test</p> [2:4]
    |  |  |  |      |  `--PARAGRAPH -> <p>Test</p> [2:4]
    |  |  |  |      |      |--P_TAG_OPEN -> <p> [2:4] // closed tag
    |  |  |  |      |      |  |--OPEN -> < [2:4]
    |  |  |  |      |      |  |--P_HTML_TAG_NAME -> p [2:5]
    |  |  |  |      |      |  `--CLOSE -> > [2:6]
    |  |  |  |      |      |--TEXT -> Test [2:7]
    |  |  |  |      |      `--P_TAG_CLOSE -> </p> [2:11]
    |  |  |  |      |          |--OPEN -> < [2:11]
    |  |  |  |      |          |--SLASH -> / [2:12]
    |  |  |  |      |          |--P_HTML_TAG_NAME -> p [2:13]
    |  |  |  |      |          `--CLOSE -> > [2:14]
    |  |  |  |      |--HTML_ELEMENT -> <p> [2:15]
    |  |  |  |      |  `--P_TAG_OPEN -> <p> [2:15] // unclosed tag
    |  |  |  |      |      |--OPEN -> < [2:15]
    |  |  |  |      |      |--P_HTML_TAG_NAME -> p [2:16]
    |  |  |  |      |      `--CLOSE -> > [2:17]

This could be a lazy populated field instead like DetailAST.getBranchTokenTypes

Member

rnveach commented Jun 25, 2017

Just my opinion, but if it makes things faster having Java code inside the grammar, i am fine with it.
We should limit Java code in grammar since grammar is not suppose to rely on external language, but it is our grammar so it shouldn't be a big deal.

@romani why do we need this boolean for unclosed tags? Checking the parent and position will tell anyone if the tag is closed.
Examples:

    |  |  |  |      |--HTML_ELEMENT -> <p>Test</p> [2:4]
    |  |  |  |      |  `--PARAGRAPH -> <p>Test</p> [2:4]
    |  |  |  |      |      |--P_TAG_OPEN -> <p> [2:4] // closed tag
    |  |  |  |      |      |  |--OPEN -> < [2:4]
    |  |  |  |      |      |  |--P_HTML_TAG_NAME -> p [2:5]
    |  |  |  |      |      |  `--CLOSE -> > [2:6]
    |  |  |  |      |      |--TEXT -> Test [2:7]
    |  |  |  |      |      `--P_TAG_CLOSE -> </p> [2:11]
    |  |  |  |      |          |--OPEN -> < [2:11]
    |  |  |  |      |          |--SLASH -> / [2:12]
    |  |  |  |      |          |--P_HTML_TAG_NAME -> p [2:13]
    |  |  |  |      |          `--CLOSE -> > [2:14]
    |  |  |  |      |--HTML_ELEMENT -> <p> [2:15]
    |  |  |  |      |  `--P_TAG_OPEN -> <p> [2:15] // unclosed tag
    |  |  |  |      |      |--OPEN -> < [2:15]
    |  |  |  |      |      |--P_HTML_TAG_NAME -> p [2:16]
    |  |  |  |      |      `--CLOSE -> > [2:17]

This could be a lazy populated field instead like DetailAST.getBranchTokenTypes

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Jun 25, 2017

Collaborator

@rnveach Please have a look at #4390 comment

Collaborator

ps-sp commented Jun 25, 2017

@rnveach Please have a look at #4390 comment

@Vladlis Vladlis moved this from To Do to In Progress in Javadoc style coverage and parser optimization Jun 27, 2017

@Vladlis

This comment has been minimized.

Show comment
Hide comment
@Vladlis

Vladlis Jun 29, 2017

Member

I've tried a few times, but could not understand the problem raised in this issue. And what exactly new flag would mean? That we have <foo> without </foo>?
@romani @baratali please explain with examples

Member

Vladlis commented Jun 29, 2017

I've tried a few times, but could not understand the problem raised in this issue. And what exactly new flag would mean? That we have <foo> without </foo>?
@romani @baratali please explain with examples

@baratali

This comment has been minimized.

Show comment
Hide comment
@baratali

baratali Jun 29, 2017

Contributor

@Vladlis
Unclosed HTML tag can change Parse tree's structure. If a tag is an unclosed, its child content won't be parsed as child nodes in the AST. It will be tricky to figure out what nodes are actually children, looking at AST. So, if there is a Check which has to verify, for example, presence of one specific tag inside another tag, it will probably need to skip Javadoc comments with unclosed tags, because it will be complicated to find out what nodes can be children of another nodes.

For example, how AST can change:

  1. Closed paragraph (XHTML-style):
* <p>
* text <a>link</a>
* </p>
$ java -jar checkstyle-7.8.2-all.jar -j test.javadoc
JAVADOC -> * <p>\n* text <a>link</a>\n* </p>\n<EOF> [0:0]
|--LEADING_ASTERISK -> * [0:0]
|--TEXT ->   [0:1]
|--HTML_ELEMENT -> <p>\n* text <a>link</a>\n* </p> [0:2]
|   `--PARAGRAPH -> <p>\n* text <a>link</a>\n* </p> [0:2]
|       |--P_TAG_OPEN -> <p> [0:2]
|       |   |--OPEN -> < [0:2]
|       |   |--P_HTML_TAG_NAME -> p [0:3]
|       |   `--CLOSE -> > [0:4]
|       |--NEWLINE -> \n [0:5]
|       |--LEADING_ASTERISK -> * [1:0]
|       |--TEXT ->  text  [1:1]
|       |--HTML_TAG -> <a>link</a> [1:7]
|       |   |--HTML_ELEMENT_OPEN -> <a> [1:7]
|       |   |   |--OPEN -> < [1:7]
|       |   |   |--HTML_TAG_NAME -> a [1:8]
|       |   |   `--CLOSE -> > [1:9]
|       |   |--TEXT -> link [1:10]
|       |   `--HTML_ELEMENT_CLOSE -> </a> [1:14]
|       |       |--OPEN -> < [1:14]
|       |       |--SLASH -> / [1:15]
|       |       |--HTML_TAG_NAME -> a [1:16]
|       |       `--CLOSE -> > [1:17]
|       |--NEWLINE -> \n [1:18]
|       |--LEADING_ASTERISK -> * [2:0]
|       |--TEXT ->   [2:1]
|       `--P_TAG_CLOSE -> </p> [2:2]
|           |--OPEN -> < [2:2]
|           |--SLASH -> / [2:3]
|           |--P_HTML_TAG_NAME -> p [2:4]
|           `--CLOSE -> > [2:5]
|--NEWLINE -> \n [2:6]
`--EOF -> <EOF> [3:0]
  1. Unclosed paragraph:
* <p>
* text <a>link</a>
$ java -jar checkstyle-7.8.2-all.jar -j test.javadoc
JAVADOC -> * <p>\n* text <a>link</a>\n<EOF> [0:0]
|--LEADING_ASTERISK -> * [0:0]
|--TEXT ->   [0:1]
|--HTML_ELEMENT -> <p> [0:2]
|   `--P_TAG_OPEN -> <p> [0:2]
|       |--OPEN -> < [0:2]
|       |--P_HTML_TAG_NAME -> p [0:3]
|       `--CLOSE -> > [0:4]
|--NEWLINE -> \n [0:5]
|--LEADING_ASTERISK -> * [1:0]
|--TEXT ->  text  [1:1]
|--HTML_ELEMENT -> <a>link</a> [1:7]
|   `--HTML_TAG -> <a>link</a> [1:7]
|       |--HTML_ELEMENT_OPEN -> <a> [1:7]
|       |   |--OPEN -> < [1:7]
|       |   |--HTML_TAG_NAME -> a [1:8]
|       |   `--CLOSE -> > [1:9]
|       |--TEXT -> link [1:10]
|       `--HTML_ELEMENT_CLOSE -> </a> [1:14]
|           |--OPEN -> < [1:14]
|           |--SLASH -> / [1:15]
|           |--HTML_TAG_NAME -> a [1:16]
|           `--CLOSE -> > [1:17]
|--NEWLINE -> \n [1:18]
`--EOF -> <EOF> [2:0]

text and <a> are still under paragraph, however, they are parsed as sibling nodes, not children nodes to <p>.

Contributor

baratali commented Jun 29, 2017

@Vladlis
Unclosed HTML tag can change Parse tree's structure. If a tag is an unclosed, its child content won't be parsed as child nodes in the AST. It will be tricky to figure out what nodes are actually children, looking at AST. So, if there is a Check which has to verify, for example, presence of one specific tag inside another tag, it will probably need to skip Javadoc comments with unclosed tags, because it will be complicated to find out what nodes can be children of another nodes.

For example, how AST can change:

  1. Closed paragraph (XHTML-style):
* <p>
* text <a>link</a>
* </p>
$ java -jar checkstyle-7.8.2-all.jar -j test.javadoc
JAVADOC -> * <p>\n* text <a>link</a>\n* </p>\n<EOF> [0:0]
|--LEADING_ASTERISK -> * [0:0]
|--TEXT ->   [0:1]
|--HTML_ELEMENT -> <p>\n* text <a>link</a>\n* </p> [0:2]
|   `--PARAGRAPH -> <p>\n* text <a>link</a>\n* </p> [0:2]
|       |--P_TAG_OPEN -> <p> [0:2]
|       |   |--OPEN -> < [0:2]
|       |   |--P_HTML_TAG_NAME -> p [0:3]
|       |   `--CLOSE -> > [0:4]
|       |--NEWLINE -> \n [0:5]
|       |--LEADING_ASTERISK -> * [1:0]
|       |--TEXT ->  text  [1:1]
|       |--HTML_TAG -> <a>link</a> [1:7]
|       |   |--HTML_ELEMENT_OPEN -> <a> [1:7]
|       |   |   |--OPEN -> < [1:7]
|       |   |   |--HTML_TAG_NAME -> a [1:8]
|       |   |   `--CLOSE -> > [1:9]
|       |   |--TEXT -> link [1:10]
|       |   `--HTML_ELEMENT_CLOSE -> </a> [1:14]
|       |       |--OPEN -> < [1:14]
|       |       |--SLASH -> / [1:15]
|       |       |--HTML_TAG_NAME -> a [1:16]
|       |       `--CLOSE -> > [1:17]
|       |--NEWLINE -> \n [1:18]
|       |--LEADING_ASTERISK -> * [2:0]
|       |--TEXT ->   [2:1]
|       `--P_TAG_CLOSE -> </p> [2:2]
|           |--OPEN -> < [2:2]
|           |--SLASH -> / [2:3]
|           |--P_HTML_TAG_NAME -> p [2:4]
|           `--CLOSE -> > [2:5]
|--NEWLINE -> \n [2:6]
`--EOF -> <EOF> [3:0]
  1. Unclosed paragraph:
* <p>
* text <a>link</a>
$ java -jar checkstyle-7.8.2-all.jar -j test.javadoc
JAVADOC -> * <p>\n* text <a>link</a>\n<EOF> [0:0]
|--LEADING_ASTERISK -> * [0:0]
|--TEXT ->   [0:1]
|--HTML_ELEMENT -> <p> [0:2]
|   `--P_TAG_OPEN -> <p> [0:2]
|       |--OPEN -> < [0:2]
|       |--P_HTML_TAG_NAME -> p [0:3]
|       `--CLOSE -> > [0:4]
|--NEWLINE -> \n [0:5]
|--LEADING_ASTERISK -> * [1:0]
|--TEXT ->  text  [1:1]
|--HTML_ELEMENT -> <a>link</a> [1:7]
|   `--HTML_TAG -> <a>link</a> [1:7]
|       |--HTML_ELEMENT_OPEN -> <a> [1:7]
|       |   |--OPEN -> < [1:7]
|       |   |--HTML_TAG_NAME -> a [1:8]
|       |   `--CLOSE -> > [1:9]
|       |--TEXT -> link [1:10]
|       `--HTML_ELEMENT_CLOSE -> </a> [1:14]
|           |--OPEN -> < [1:14]
|           |--SLASH -> / [1:15]
|           |--HTML_TAG_NAME -> a [1:16]
|           `--CLOSE -> > [1:17]
|--NEWLINE -> \n [1:18]
`--EOF -> <EOF> [2:0]

text and <a> are still under paragraph, however, they are parsed as sibling nodes, not children nodes to <p>.

@Vladlis

This comment has been minimized.

Show comment
Hide comment
@Vladlis

Vladlis Jun 30, 2017

Member

@baratali thanks, now I see the meaning of this statement

to let author of Check decide to support non-nested AST or not.

@ps-sp
Performance is in priority. But supposing there is no difference in what way to solve this issue, I'd prefer modifying post-processing rather than grammar to keep the latter clearer.

Member

Vladlis commented Jun 30, 2017

@baratali thanks, now I see the meaning of this statement

to let author of Check decide to support non-nested AST or not.

@ps-sp
Performance is in priority. But supposing there is no difference in what way to solve this issue, I'd prefer modifying post-processing rather than grammar to keep the latter clearer.

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Jul 13, 2017

Collaborator

@baratali
Do you know if there is specific reason for which inside all the nested elements htmlElement rule hasn't been utilized and htmlElements have been listed separately like this - JavadocParser.g4 L137-L166. Also, ...TagClose rules haven't been included in nested elements, but ...TagOpen rules have been, why so (certain HTML elements, like <tbody> and <colgroup> can rightfully have their start tag omitted if certain conditions are met) ?

Collaborator

ps-sp commented Jul 13, 2017

@baratali
Do you know if there is specific reason for which inside all the nested elements htmlElement rule hasn't been utilized and htmlElements have been listed separately like this - JavadocParser.g4 L137-L166. Also, ...TagClose rules haven't been included in nested elements, but ...TagOpen rules have been, why so (certain HTML elements, like <tbody> and <colgroup> can rightfully have their start tag omitted if certain conditions are met) ?

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 18, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 18, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 18, 2017

@Vladlis Vladlis moved this from In Progress to Review in Javadoc style coverage and parser optimization Jul 19, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 20, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 20, 2017

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 21, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 22, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 22, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 26, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jul 26, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithUnclosedHtmlTag i…
…n AbstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithNonTightHtml in A…
…bstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithNonTightHtml in A…
…bstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithNonTightHtml in A…
…bstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithNonTightHtml in A…
…bstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 5, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithNonTightHtml in A…
…bstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 6, 2017

Issue #3311: Added method doesCheckAcceptJavadocWithNonTightHtml in A…
…bstractJavadocCheck which can be overridden in extending checks which are not to process javadoc with unclosed HTML tags

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 24, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 25, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 25, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 25, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 25, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 26, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 27, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Aug 30, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 1, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 1, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 1, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 7, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 7, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Sep 7, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

romani added a commit that referenced this issue Sep 8, 2017

Issue #3311: Modified javadoc grammar, JavadocDetailNodeParser, Abstr…
…actJavadocCheck to enable selective processing of javadoc with non tight HTML

@romani romani added the new feature label Sep 8, 2017

@romani romani added this to the 8.3 milestone Sep 8, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
Member

romani commented Sep 8, 2017

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Sep 8, 2017

Collaborator

@romani
ok. will do.

Collaborator

ps-sp commented Sep 8, 2017

@romani
ok. will do.

@Vladlis Vladlis moved this from Review to In Progress in Javadoc style coverage and parser optimization Sep 19, 2017

@pbludov

This comment has been minimized.

Show comment
Hide comment
@pbludov

pbludov Nov 14, 2017

Collaborator

#1112 is still broken. Tested with config

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE module PUBLIC
  "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
  "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
  <module name="TreeWalker">
    <module name="SummaryJavadoc">
      <property name="violateExecutionOnNonTightHtml" value="true" />
    </module>
  </module>
</module>
Collaborator

pbludov commented Nov 14, 2017

#1112 is still broken. Tested with config

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE module PUBLIC
  "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
  "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
  <module name="TreeWalker">
    <module name="SummaryJavadoc">
      <property name="violateExecutionOnNonTightHtml" value="true" />
    </module>
  </module>
</module>
@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Nov 15, 2017

Member

@ps-sp , please provide update to documentation , to let us close this issue.


@pbludov ,

is still broken. Tested with config

please open new issue.

Member

romani commented Nov 15, 2017

@ps-sp , please provide update to documentation , to let us close this issue.


@pbludov ,

is still broken. Tested with config

please open new issue.

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Dec 28, 2017

Member

@ps-sp , please update documentation, all related checks at http://checkstyle.sourceforge.net/config_javadoc.html should have new properties.

Member

romani commented Dec 28, 2017

@ps-sp , please update documentation, all related checks at http://checkstyle.sourceforge.net/config_javadoc.html should have new properties.

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Jan 4, 2018

Collaborator

@romani
on it.

Collaborator

ps-sp commented Jan 4, 2018

@romani
on it.

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jan 7, 2018

@ps-sp

This comment has been minimized.

Show comment
Hide comment
@ps-sp

ps-sp Jan 7, 2018

Collaborator

@romani

all related checks at http://checkstyle.sourceforge.net/config_javadoc.html should have new properties

All related checks already seem to be having the property violateExecutionOnNonTightHtml.

Collaborator

ps-sp commented Jan 7, 2018

@romani

all related checks at http://checkstyle.sourceforge.net/config_javadoc.html should have new properties

All related checks already seem to be having the property violateExecutionOnNonTightHtml.

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jan 7, 2018

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jan 7, 2018

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jan 7, 2018

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jan 10, 2018

Member

Confirmed, thanks a lot.
Not sure what Check forced me to write such message, might be some old one, my bad.

Member

romani commented Jan 10, 2018

Confirmed, thanks a lot.
Not sure what Check forced me to write such message, might be some old one, my bad.

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jan 13, 2018

ps-sp added a commit to ps-sp/checkstyle that referenced this issue Jan 13, 2018

romani added a commit that referenced this issue Jan 28, 2018

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jan 28, 2018

Member

documentation is added to 8.8 version.

Member

romani commented Jan 28, 2018

documentation is added to 8.8 version.

@romani romani closed this Jan 28, 2018

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Apr 5, 2018

Member

Related checks are currently: AtclauseOrder, JavadocParagraph, JavadocTagContinuationIndentation, NonEmptyAtclauseDescription, SingleLineJavadoc, SummaryJavadoc

Member

rnveach commented Apr 5, 2018

Related checks are currently: AtclauseOrder, JavadocParagraph, JavadocTagContinuationIndentation, NonEmptyAtclauseDescription, SingleLineJavadoc, SummaryJavadoc

@romani romani moved this from In Progress to Done in Javadoc style coverage and parser optimization Jun 1, 2018

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