Bug 551667 - Fix Javadoc errors in EclipseUI
Summary: Fix Javadoc errors in EclipseUI
Status: NEW
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.13   Edit
Hardware: PC Windows 10
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Platform-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-10-01 08:07 EDT by Wim Jongman CLA
Modified: 2019-12-11 07:38 EST (History)
2 users (show)

See Also:

Attachments
jdt core prefs with the strict javadoc rules (34.74 KB, application/octet-stream)
2019-10-01 12:32 EDT, Wim Jongman CLA 		no flags Details
View All 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 Wim Jongman CLA 2019-10-01 08:07:32 EDT 
We would like to catch javadoc errors early by setting the malformed javadoc severity to error instead of warning. To do this, we need to make sure the current javadoc's are ok. They are not at the moment.
Comment 1 Lars Vogel CLA 2019-10-01 08:08:49 EDT 
+1
Comment 2 Eclipse Genie CLA 2019-10-01 10:05:28 EDT 
New Gerrit change created: https://git.eclipse.org/r/150438
Comment 3 Wim Jongman CLA 2019-10-01 10:11:13 EDT 
I did the first package of project org.eclipse.ui.workbench.

This would go a lot faster if we all did a couple of packages. Post on the bug which ones you want to take.

Packages with Javadoc errors:

I'm working on:
-----------------------------
org.eclipse.ui.actions
org.eclipse.ui.activities
org.eclipse.ui.application
org.eclipse.ui.commands
org.eclipse.ui.dialogs

To grab if you want to jump in:
-------------------------------
org.eclipse.ui.handlers
org.eclipse.ui.internal
org.eclipse.ui.internal.about
org.eclipse.ui.internal.actions
org.eclipse.ui.internal.activities
org.eclipse.ui.internal.activities.ws
org.eclipse.ui.internal.application
org.eclipse.ui.internal.browser
org.eclipse.ui.internal.commands
org.eclipse.ui.internal.contexts
org.eclipse.ui.internal.decorators
org.eclipse.ui.internal.dialogs
org.eclipse.ui.internal.dialogs.cpd
org.eclipse.ui.internal.e4.compatibility
org.eclipse.ui.internal.e4.migration
org.eclipse.ui.internal.expressions
org.eclipse.ui.internal.handlers
org.eclipse.ui.internal.help
org.eclipse.ui.internal.intro
org.eclipse.ui.internal.keys
org.eclipse.ui.internal.keys.model
org.eclipse.ui.internal.keys.show
org.eclipse.ui.internal.layout
org.eclipse.ui.internal.menus
org.eclipse.ui.internal.misc
org.eclipse.ui.internal.model
org.eclipse.ui.internal.part
org.eclipse.ui.internal.preferences
org.eclipse.ui.internal.progress
org.eclipse.ui.internal.quickaccess
org.eclipse.ui.internal.quickaccess.providers
org.eclipse.ui.internal.registry
org.eclipse.ui.internal.services
org.eclipse.ui.internal.statushandlers
org.eclipse.ui.internal.testing
org.eclipse.ui.internal.themes
org.eclipse.ui.internal.tweaklets
org.eclipse.ui.internal.util
org.eclipse.ui.internal.wizards.preferences
org.eclipse.ui.model
org.eclipse.ui.part
org.eclipse.ui.preferences
org.eclipse.ui.progress
org.eclipse.ui.quickaccess
Comment 4 Lars Vogel CLA 2019-10-01 10:19:26 EDT 
Currently working on a huge customer build, so I can only help during build run. I take org.eclipse.ui.internal.about
Comment 5 Eclipse Genie CLA 2019-10-01 10:34:33 EDT 
New Gerrit change created: https://git.eclipse.org/r/150441
Comment 6 Paul Pazderski CLA 2019-10-01 10:37:14 EDT 
Progress for me.
Comment 7 Eclipse Genie CLA 2019-10-01 10:45:49 EDT 
New Gerrit change created: https://git.eclipse.org/r/150443
Comment 8 Eclipse Genie CLA 2019-10-01 10:49:04 EDT 
New Gerrit change created: https://git.eclipse.org/r/150444
Comment 9 Wim Jongman CLA 2019-10-01 11:13:20 EDT 
Wim:
-----------------------------
x org.eclipse.ui.actions
x org.eclipse.ui.activities
x org.eclipse.ui.application
x org.eclipse.ui.commands
x org.eclipse.ui.dialogs
org.eclipse.ui.handlers
org.eclipse.ui.internal

Lars:
-------------------------------
org.eclipse.ui.internal.about

Paul:
-------------------------------
org.eclipse.ui.internal.progress



To grab if you want to jump in:
-------------------------------
org.eclipse.ui.internal.actions
org.eclipse.ui.internal.activities
org.eclipse.ui.internal.activities.ws
org.eclipse.ui.internal.application
org.eclipse.ui.internal.browser
org.eclipse.ui.internal.commands
org.eclipse.ui.internal.contexts
org.eclipse.ui.internal.decorators
org.eclipse.ui.internal.dialogs
org.eclipse.ui.internal.dialogs.cpd
org.eclipse.ui.internal.e4.compatibility
org.eclipse.ui.internal.e4.migration
org.eclipse.ui.internal.expressions
org.eclipse.ui.internal.handlers
org.eclipse.ui.internal.help
org.eclipse.ui.internal.intro
org.eclipse.ui.internal.keys
org.eclipse.ui.internal.keys.model
org.eclipse.ui.internal.keys.show
org.eclipse.ui.internal.layout
org.eclipse.ui.internal.menus
org.eclipse.ui.internal.misc
org.eclipse.ui.internal.model
org.eclipse.ui.internal.part
org.eclipse.ui.internal.preferences
org.eclipse.ui.internal.quickaccess
org.eclipse.ui.internal.quickaccess.providers
org.eclipse.ui.internal.registry
org.eclipse.ui.internal.services
org.eclipse.ui.internal.statushandlers
org.eclipse.ui.internal.testing
org.eclipse.ui.internal.themes
org.eclipse.ui.internal.tweaklets
org.eclipse.ui.internal.util
org.eclipse.ui.internal.wizards.preferences
org.eclipse.ui.model
org.eclipse.ui.part
org.eclipse.ui.preferences
org.eclipse.ui.progress
org.eclipse.ui.quickaccess
Comment 10 Eclipse Genie CLA 2019-10-01 11:16:56 EDT 
New Gerrit change created: https://git.eclipse.org/r/150447
Comment 11 Eclipse Genie CLA 2019-10-01 12:04:26 EDT 
New Gerrit change created: https://git.eclipse.org/r/150448
Comment 12 Wim Jongman CLA 2019-10-01 12:13:07 EDT 
Has Gerrit become weird? It seems to treat my amended commits as new changes. I also see two separate changes from Lars.
Comment 13 Lars Vogel CLA 2019-10-01 12:19:37 EDT 
(In reply to Wim Jongman from comment #12)
> Has Gerrit become weird? It seems to treat my amended commits as new
> changes. I also see two separate changes from Lars.

I pushed two changes, so that should be fine.
Comment 14 Wim Jongman CLA 2019-10-01 12:32:39 EDT 
Created attachment 280126 [details]
jdt core prefs with the strict javadoc rules
Comment 15 Paul Pazderski CLA 2019-10-01 13:26:45 EDT 
(In reply to Wim Jongman from comment #9)
> Paul:
> -------------------------------
> org.eclipse.ui.internal.progress

+ org.eclipse.ui.progress
Comment 16 Eclipse Genie CLA 2019-10-01 15:29:42 EDT 
New Gerrit change created: https://git.eclipse.org/r/150453
Comment 17 Paul Pazderski CLA 2019-10-01 15:31:04 EDT 
(In reply to Eclipse Genie from comment #16)
> New Gerrit change created: https://git.eclipse.org/r/150453

Change for Javadoc in org.eclipse.ui.progress and org.eclipse.ui.internal.progress except for the messages class.
Also applied the same changes on the e4 class copies.
Comment 19 Wim Jongman CLA 2019-10-02 04:17:16 EDT 
(In reply to Paul Pazderski from comment #17)
> (In reply to Eclipse Genie from comment #16)
> > New Gerrit change created: https://git.eclipse.org/r/150453
> 
> Change for Javadoc in org.eclipse.ui.progress and
> org.eclipse.ui.internal.progress except for the messages class.
> Also applied the same changes on the e4 class copies.

Thanks for your work Paul. I have reviewed and submitted.

I especially like your compacted way of single line documentation:

/** Viewer to show content. */
protected IViewer viewer;