Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 425962

Summary: [New Contributors] Remove (non-Javadoc) @see statements if @Override is used
Product: [Eclipse Project] Platform Reporter: Lars Vogel <Lars.Vogel>
Component: UIAssignee: Lars Vogel <Lars.Vogel>
Status: VERIFIED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: daniel_megert, ekchou, Gmsakith, jeandersonbc, Lars.Vogel, Michael_Rennie, nobody, pablo.cabrera, psuzzi, pwebster
Version: 4.4   
Target Milestone: 4.5 M1   
Hardware: PC   
OS: Linux   
Whiteboard:

Description Lars Vogel CLA 2014-01-17 04:55:31 EST 
(non-Javadoc) @see Class used to be used in platform ui code to indicate that a certain method was overriden. I suggest to remove them in cases in which @Override can be used (BREE 1.5 or 1.6) to cleanup the code.

My understanding is from a short discussion with Paul Webster that it is OK to do so. I suggest that such changes are NOT added to the copyright header to avoid to pollute it with such minor changes.
Comment 1 Lars Vogel CLA 2014-01-17 04:57:20 EST 
I plan to use this bug as placeholder for such activities, to have something for the commit message. I plan also to use such simple clean-up stuff as introduction exercises for Eclipse Hackthon events (see for example https://wiki.eclipse.org/Hackathon_Hamburg_2013).
Comment 2 Paul Webster CLA 2014-01-17 05:40:06 EST 
I recommend only making small changes.  i.e. removing a few at a time, in classes that are being worked on or in one class at a time.

PW
Comment 3 Lars Vogel CLA 2014-01-17 05:42:30 EST 
(In reply to Paul Webster from comment #2)
> I recommend only making small changes.  i.e. removing a few at a time, in
> classes that are being worked on or in one class at a time.

Thanks Paul, I plan to follow your advice. I assume real adjustments should be separated from this clean-up, therefore I created this bug to have something for the commit message to point to.
Comment 4 Dani Megert CLA 2014-01-17 06:10:20 EST 
(In reply to Paul Webster from comment #2)
> I recommend only making small changes.  i.e. removing a few at a time, in
> classes that are being worked on or in one class at a time.
> 
> PW

+1!
Comment 6 Paul Webster CLA 2014-01-24 09:34:21 EST 
Léo added https://git.eclipse.org/r/#/c/20982/

PW
Comment 10 Leo Denault CLA 2014-02-07 19:15:44 EST 
Since using regex to find these specific statements has been a little tricky, I used the following regex: "@see.*\n\s*\*/\n\s*@Override". This currently pulls up 336 matches for me.
Comment 11 Erik Chou CLA 2014-02-07 19:55:27 EST 
I made a fix to one file: bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/dialogs/ViewsPreferencePage.java.
https://git.eclipse.org/r/21710
Comment 12 Paul Webster CLA 2014-02-08 17:05:59 EST 
(In reply to Erik Chou from comment #11)
> I made a fix to one file: bundles/org.eclipse.ui.workbench/Eclipse
> UI/org/eclipse/ui/internal/dialogs/ViewsPreferencePage.java.
> https://git.eclipse.org/r/21710

Thanks, released as http://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=ad53831bbd4a7854561d9b03a2c8e10cb1f6659f

PW
Comment 13 Jeanderson Candido CLA 2014-02-14 01:32:56 EST 
Hi everyone. I removed the non-javadoc statements from 2 files (one from org.eclipse.e4.ui.bindings.internal and org.eclipse.e4.commands.internal): https://git.eclipse.org/r/#/c/21981/

PS.: Is there someone else having issues using Eclipse Luna on Windows?
Comment 14 Jeanderson Candido CLA 2014-02-14 07:35:37 EST 
* I updated my last review with only one class now and opened another https://git.eclipse.org/r/#/c/22001/
Comment 16 Jeanderson Candido CLA 2014-02-17 09:47:20 EST 
Updated ComboViewer: https://git.eclipse.org/r/#/c/22096/
Comment 19 Lars Vogel CLA 2014-02-21 15:46:39 EST 
FileResourcesLocatorImpl, HttpResourcesLocatorImpl and OSGiResourceLocator done with https://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=fb348eeef12d18c729c8cac95fa0ef26c07eb46d
Comment 20 Jeanderson Candido CLA 2014-02-21 21:21:30 EST 
ProgressMonitorPart fixed with https://git.eclipse.org/r/#/c/22335/
Comment 21 Jeanderson Candido CLA 2014-02-21 22:07:50 EST 
Fixed DeferredContentProvider, LazySortedCollection, and SetModel with https://git.eclipse.org/r/22401

Fixed BackgroundContentProvider with https://git.eclipse.org/r/22400
Comment 22 Jeanderson Candido CLA 2014-02-21 22:47:19 EST 
DeferredContentProvider, LazySortedCollection, and SetModel fixed with https://git.eclipse.org/r/#/c/22401/
Comment 23 Jeanderson Candido CLA 2014-02-21 23:03:14 EST 
Sorry about my last comment... Forget about it.
Comment 25 Jeanderson Candido CLA 2014-02-28 18:46:44 EST 
Could someone help me to figure why the build is failing? https://git.eclipse.org/r/#/c/22401/

Before commiting my changes, I updated my codebase to origin/master (git pull) and then pushed my patch to gerrit. I thought it could be something related to out-of-dated code but everything was updated before commiting...

Thanks in advance.
Comment 26 Paul Webster CLA 2014-02-28 19:00:49 EST 
Looks like there was a change in the target platform.  I've pushed that to the eclipse maven repo and re-triggered the build.

PW
Comment 27 Jeanderson Candido CLA 2014-02-28 21:14:58 EST 
(In reply to Paul Webster from comment #26)
> Looks like there was a change in the target platform.  I've pushed that to
> the eclipse maven repo and re-triggered the build.
> 
> PW

Thank you very much for your assistance Paul, I'm glad it worked now :)
Comment 28 Lars Vogel CLA 2014-03-02 17:11:11 EST 
https://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=2bc10ff71bc6a3972fe8b1d0c1c6a245e57041f8 removed unnecessary javadoc on the following classes:
- preference/PreferenceStore.java
- viewers/deferred/BackgroundContentProvider.java
- viewers/deferred/DeferredContentProvider.java
- viewers/deferred/SetModel.java
Comment 29 Sakith Indula CLA 2014-03-03 13:50:29 EST 
https://git.eclipse.org/r/#/c/22728/

Removed  non-javadoc @see statements for @overriden methods from
/org.eclipse.core.commands/src/org/eclipse/core/commands/ParameterizedCommand.java
Comment 30 Lars Vogel CLA 2014-03-03 13:58:59 EST 
(In reply to Sakith Indula from comment #29)
> https://git.eclipse.org/r/#/c/22728/
> 
> Removed  non-javadoc @see statements for @overriden methods from
> /org.eclipse.core.commands/src/org/eclipse/core/commands/
> ParameterizedCommand.java

Thanks. See comment in the review.
Comment 31 Jeanderson Candido CLA 2014-03-03 15:10:38 EST 
(In reply to Sakith Indula from comment #29)
> https://git.eclipse.org/r/#/c/22728/
> 
> Removed  non-javadoc @see statements for @overriden methods from
> /org.eclipse.core.commands/src/org/eclipse/core/commands/
> ParameterizedCommand.java

Hi Sakith.

I had some issues similar to what you have now. I guess the build is failing because your patch requires an abandoned change. In any case, you have to rebase your local branch and remove the unnecessary commit from your "commit stack". You can work around it by checking out your patch, resetting your local branch to remove the dependency, redo your work, and finally update your patch.

I hope you find this information useful. If you are not comfortable with Git, I suggest you to read this: http://git-scm.com/book/en/

Jeanderson
Comment 32 Lars Vogel CLA 2014-03-05 01:24:00 EST 
For the Jface Dialog class

https://git.eclipse.org/r/22899
Comment 33 Lars Vogel CLA 2014-03-06 07:44:45 EST 
For ModelServiceImpl including the removal of one obsolete //HACK statement 

https://git.eclipse.org/r/22974
Comment 34 Patrik Suzzi CLA 2014-03-07 11:49:11 EST 
For ContextSet: https://git.eclipse.org/r/23052
Comment 35 Patrik Suzzi CLA 2014-03-08 12:52:28 EST 
For E4Workbench class: https://git.eclipse.org/r/23084
Comment 36 Patrik Suzzi CLA 2014-03-08 14:33:53 EST 
For ElementMatcher class: https://git.eclipse.org/r/23085
Comment 37 Lars Vogel CLA 2014-03-18 07:49:59 EDT 
Thanks, all provided cleanup patches have been merged
Comment 38 Paul Webster CLA 2014-03-18 23:20:39 EDT 
Fix for review: https://git.eclipse.org/r/#/c/23568/
Comment 48 Matthias Mailänder CLA 2014-03-28 13:36:31 EDT 
https://git.eclipse.org/r/24083 to get started on https://wiki.eclipse.org/Hackathon_Hamburg_2014
Comment 55 Lars Vogel CLA 2014-08-06 07:59:20 EDT 
Marking as fixed for M1, this bug get long and the title is a bit to bulky. New fixed should go to Bug 441244.
Comment 56 Lars Vogel CLA 2014-08-06 07:59:32 EDT 
.