[ checkstyle-Bugs-2716908 ] JavadocStyle: Pbl. with "unclosed" tags (5.0-beta2)

[SourceForge.net]

Bugs item #2716908, was opened at 2009-03-27 14:23
Message generated for change (Comment added) made by rakus
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=397078&aid=2716908&group_id=29721

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: release 5.0
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Ralf (rakus)
Assigned to: Nobody/Anonymous (nobody)
Summary: JavadocStyle: Pbl. with "unclosed" tags (5.0-beta2)

Initial Comment:
Something is wrong with the JavadocStyleCheck regarding unclosed HTML-tags.

  /**
   * Test.
   *
   * <p>
   * FALSE POSITIVE: {@code List<b>}. {@literal List<pre>}
   * </p>
   * <p>
   * MISSED: List<Long>
   * </p>
   * <p>
   * OK: {@code List<String>}.
   * </p>
   * <p>
   * UNCLOSED: <b>bold
   * </p>
   */

FALSE POSITIVE: Text inside {@code } and {@literal } must not be treated as HTML. (also see bug 1524767)

MISSED: If you generate Javadoc from the comment, <Long> will be copied verbatim to the output html file.
In Firefox, IE or the Javadoc-Preview of Eclipse the unknown Tag <Long> will not be displayed.
So this should be reported by checkstyle.

OK: I guess this is only accepted, as "String" is not a valid HTML tag.

UNCLOSED: correctly detected

It looks like JavadocStyle only reports tags as unclosed, if they are known HTML tags.



----------------------------------------------------------------------

>Comment By: Ralf (rakus)
Date: 2009-10-21 17:12

Message:
Well, here is another false positive:
/*
 * <u>Unterlined</u>
 * <font size="18">font</font>
 * <var>variable</var>
 */

----------------------------------------------------------------------

Comment By: Ralf (rakus)
Date: 2009-04-06 11:52

Message:
Here is another false positive:

/*
 * Test.
 * <dl>
 * <dt>Key</dt>
 * <dd>Description</dd>
 * <dt>Msg</dt>
 * <dd>Description</dd>
 * </dl>
 */

For every </dt> and </dd> the JavadocStyleCheck reports "Extra HTML tag
found".

Also no closing tag for <dt> and <dd> is required, it is no error to
provide one. I even think it is good practice to provide closing tags in
such situations.


----------------------------------------------------------------------

You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=397078&aid=2716908&group_id=29721

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Checkstyle-devel mailing list
Checkstyle-devel@...
https://lists.sourceforge.net/lists/listinfo/checkstyle-devel