Bug 549855 - [javadoc] Add error checking support for @uses and @provides module-info tags
Summary: [javadoc] Add error checking support for @uses and @provides module-info tags
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 4.13   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: 4.14 M3   Edit
Assignee: Jeff Johnston CLA
QA Contact: Vikas Chandra CLA
URL:
Whiteboard:
Keywords: noteworthy
Depends on:
Blocks: 553111
  Show dependency tree
 
Reported: 2019-08-07 13:48 EDT by Jeff Johnston CLA
Modified: 2020-03-23 07:49 EDT (History)
3 users (show)

See Also:
stephan.herrmann: review+

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Jeff Johnston CLA 2019-08-07 13:48:45 EDT 
Currently not having Javadoc @provides or @uses tags or having duplicate tags or invalid class names is not flagged in Javadoc parsing.
Comment 1 Eclipse Genie CLA 2019-08-08 14:17:43 EDT 
New Gerrit change created: https://git.eclipse.org/r/147299
Comment 2 Stephan Herrmann CLA 2019-08-11 05:47:12 EDT 
Please coordinate with bug 548069
Comment 3 Jeff Johnston CLA 2019-09-18 15:04:03 EDT 
(In reply to Stephan Herrmann from comment #2)
> Please coordinate with bug 548069

Hi Stephan,

I have looked at the other bug and have locally modified my patch so it will use the same logic in CompilationUnitDeclaration.resolve() plus made some other fixes I needed to make.  I have both applied and all test cases run.

IMHO, the two bugs are distinct.  The other bug is adding support for analyzing  annotations in a module-info javadoc comment using the Javadoc.resolve(MethodScope) (e.g. will process an @link) and mine is adding error support for module-info @uses and @provides tags which is new logic.

I believe that the other patch needs to be reviewed first.  If you are ok with that logic, I can create an updated patch that applies on it and adds the @uses/@provides error checking (no quick-fixes yet).  If you don't approve of calling the resolve(MethodScope), then I can modify my patch back to only checking @uses/@provides tags.  If you agree, then this bug can mark a dependency on bug 548069.
Comment 4 Eclipse Genie CLA 2019-10-02 18:29:38 EDT 
New Gerrit change created: https://git.eclipse.org/r/147299
Comment 5 Eclipse Genie CLA 2019-11-13 13:45:47 EST 
New Gerrit change created: https://git.eclipse.org/r/147299
Comment 6 Eclipse Genie CLA 2019-11-14 08:09:19 EST 
New Gerrit change created: https://git.eclipse.org/r/147299
Comment 8 Stephan Herrmann CLA 2019-11-15 17:22:19 EST 
essentially done modulo a little cleanup as requested in gerrit.
Comment 9 Vikas Chandra CLA 2019-11-16 03:55:01 EST 
verified 1 example of invalid, missing and duplicate (@provides or @uses tags) on

Version: 2019-12 (4.14)
Build id: I20191115-1800
Comment 10 Vikas Chandra CLA 2019-11-16 03:56:06 EST 
Jeff, can you please create a news and noteworthy(N&N) item for this before next Wednesday.
Comment 11 Vikas Chandra CLA 2019-11-25 23:03:38 EST 
I have resolved and verified this but N&N is still pending
Comment 12 Vikas Chandra CLA 2019-11-25 23:05:44 EST 
Jeff, can you please create a news and noteworthy(N&N) item for this

ssh://??@git.eclipse.org:29418/www.eclipse.org/eclipse/news.git

File to change git\news\4.14\jdt.html
Comment 13 Eclipse Genie CLA 2019-11-26 18:07:30 EST 
New Gerrit change created: https://git.eclipse.org/r/153452
Comment 15 Jeff Johnston CLA 2019-11-26 18:08:13 EST 
(In reply to Vikas Chandra from comment #12)
> Jeff, can you please create a news and noteworthy(N&N) item for this
> 
> ssh://??@git.eclipse.org:29418/www.eclipse.org/eclipse/news.git
> 
> File to change git\news\4.14\jdt.html

Done.