Bug 176705 - [javadoc] Empty javadoc comments should be treated as Malformed
Summary: [javadoc] Empty javadoc comments should be treated as Malformed
Status: VERIFIED INVALID
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 RC2   Edit
Assignee: Eric Jodet CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-03-08 07:58 EST by Rob Oxspring CLA
Modified: 2008-05-23 07:57 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Rob Oxspring CLA 2007-03-08 07:58:45 EST
Build ID: M20070212-1330

Steps To Reproduce:
1. Switch malformed javadoc settings to Error
2. Enter an empty javadoc comment, e.g.
 /**
  *
  */
3. See it not complaining.


More information:
Comment 1 Jason Bennett CLA 2007-03-15 21:32:19 EDT
Note that this also includes @param tags. As long as the @param exists, Eclipse won't complain about having no description.
Comment 2 Eric Jodet CLA 2007-03-16 04:55:26 EDT
(In reply to comment #1)
> Note that this also includes @param tags. As long as the @param exists, Eclipse
> won't complain about having no description.

The missing description issue will be addressed by bug 73352.

Comment 3 Jason Bennett CLA 2007-03-16 13:24:44 EDT
Thanks. This bug should probably be marked as a dup then.
Comment 4 Eric Jodet CLA 2007-03-19 05:04:35 EDT
(In reply to comment #3)
Jason, I think this bug can not be considered as a dup of bug 73352.
This one is about not complaining when dealing with empty javadoc,
whereas bug 73352 is about missing description in non empty javadoc (the tag is present, but there is no description).
Comment 5 Eric Jodet CLA 2008-04-30 03:07:07 EDT
> 2. Enter an empty javadoc comment, e.g.
>  /**
>   *
>   */
> 3. See it not complaining.

May be be it's worth wondering whether an empty javadoc should be considered as invalid or not:

1 - did not find anything in the javadoc spec saying that empty javadocs are not allowed or invalid
2 - the javadoc tool won't complain either when encountering empty javadocs

tag validation was addressed with bug 73352.

This makes me think we could close this bug as invalid.
Comment 6 Eric Jodet CLA 2008-05-21 04:11:51 EDT
(In reply to comment #5)
performed additional tests / javadoc tool reference search:
1 - still nothing found in the javadoc spec saying that empty javadocs are
not allowed or invalid
2 - did not find a test case where the javadoc tool would complain when encountering empty javadocs

closing as INVALID.

Feel free to reopen in case you find something in the javadoc spec or a test case that causes the javadoc tool to raise an error.
Comment 7 Eric Jodet CLA 2008-05-21 04:14:15 EDT
closing as INVALID
Comment 8 Frederic Fusier CLA 2008-05-23 05:33:21 EDT
Verified for 3.4RC2. The JDT compiler behaves like javadoc tool and it seemed that the real need was more about missing description on @param tag addressed by bug 73352.
Comment 9 Eric Jodet CLA 2008-05-23 07:57:19 EDT
*** Bug 201599 has been marked as a duplicate of this bug. ***