Bug 570942 - [clean up] Add tooltips / help for JDT cleanup entries
Summary: [clean up] Add tooltips / help for JDT cleanup entries
Status: ASSIGNED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.14   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-02-05 03:21 EST by Lars Vogel CLA
Modified: 2021-02-05 05:05 EST (History)
4 users (show)

See Also:

Attachments
Screenshot (562.34 KB, image/png)
2021-02-05 05:00 EST, Noopur Gupta 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 Lars Vogel CLA 2021-02-05 03:21:12 EST 
Autorefactor has explanation why a certain cleanup is good.

Can we add something like this to JDT cleanups, maybe a tooltip? This could also used to copy and paste this message into the commit message.
Comment 1 Noopur Gupta CLA 2021-02-05 03:52:33 EST 
Reading/copying long explanation in tooltips will not be convenient. These details can be added to the F1 help documentation.
Comment 2 Lars Vogel CLA 2021-02-05 04:03:17 EST 
(In reply to Noopur Gupta from comment #1)
> Reading/copying long explanation in tooltips will not be convenient. These
> details can be added to the F1 help documentation.

I don't think that will be usable, as the I cannot access the help from the dialog. So if I want to get an idea why a cleanup is good, I would have to close the dialog, open the help and search for the correct term. I don't think lots of users will be doing that.
Comment 3 Noopur Gupta CLA 2021-02-05 04:11:23 EST 
(In reply to Lars Vogel from comment #2)
> (In reply to Noopur Gupta from comment #1)
> > Reading/copying long explanation in tooltips will not be convenient. These
> > details can be added to the F1 help documentation.
> 
> I don't think that will be usable, as the I cannot access the help from the
> dialog. So if I want to get an idea why a cleanup is good, I would have to
> close the dialog, open the help and search for the correct term. I don't
> think lots of users will be doing that.

Any associated help page can be opened from the dialog itself by pressing F1 or by clicking "?" icon at bottom left in the dialog.
Comment 4 Lars Vogel CLA 2021-02-05 04:41:04 EST 
(In reply to Noopur Gupta from comment #3)

> Any associated help page can be opened from the dialog itself by pressing F1
> or by clicking "?" icon at bottom left in the dialog.

Does not work for me. Or are you saying this should be done via this bug report?
Comment 5 Noopur Gupta CLA 2021-02-05 05:00:51 EST 
Created attachment 285454 [details]
Screenshot

The top-level clean up help page that's available now is opening when you go via Preferences (see screenshot). But it's not opening when reached via Source > Clean Up... which looks like a bug.

We need a new associated page which opens when "?" is pressed on the clean up *profile* page and explains each clean up option.
Comment 6 Noopur Gupta CLA 2021-02-05 05:05:05 EST 
For example, check the help in: Source > Generate Getters and Setters > "?" > click "Create Getters and Setters" link.