Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hard to read method signatures in Javadoc views #1073

Closed
RedeemerSK opened this issue Jan 15, 2024 · 1 comment
Closed

Hard to read method signatures in Javadoc views #1073

RedeemerSK opened this issue Jan 15, 2024 · 1 comment
Assignees
@RedeemerSK
Labels
enhancement New feature or request
Milestone
4.32 M1

Comments

@RedeemerSK
Copy link
Contributor

RedeemerSK commented Jan 15, 2024 •
edited
Loading

Hello

as per advice via JDT mailing lists, I'm creating this issue to have a place to discuss my proposal for improvements to JavaDoc content styling and it's implementation.

Problem I'm addressing

Hard to read method signatures in JavaDoc views, for example:
javadoc_current

Enhancements proposal & prototype

My prototype changes the presentation into IMHO more readable format, example:
javadoc_new
javadoc_new_colored

New enhancements are fully configurable (when to apply them, what colors to use):
preview_overlay

More info

Can be found at Eclipse JDT forums topic I created to communicate goals, approach, decisions taken and progress.

Requesting

I would like to have somebody, preferably with some level of decision making weight in JDT codebase / project, to evaluate my prototype and provide feedback so that I can finalize it and hopefully have it accepted eventually.
@RedeemerSK
Copy link
Contributor Author

PR for prototype created: #1074

@RedeemerSK RedeemerSK changed the title JavaDoc readability improvements addressing hard to read method signatures Hard to read method signatures in Javaodc views Jan 16, 2024
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Jan 27, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
bfc5b8f 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Jan 27, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
3970cc2 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Jan 29, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
cd7440f 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Jan 30, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
c6c89cc 
…1073)
jukzi pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Jan 31, 2024
@RedeemerSK @jukzi
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
1c94ede 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Jan 31, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
0dcc1cd 
…1073)
jukzi pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Feb 14, 2024
@RedeemerSK @jukzi
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
25a5036 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 9, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
9831c97 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 9, 2024
@RedeemerSK
WIP: Add enhancements toggling item to styling menu (eclipse-jdt#1073)
caacb68
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 9, 2024
@RedeemerSK
WIP: Add enhancements toggling item to styling menu (eclipse-jdt#1073)
46bb0dc
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 10, 2024
@RedeemerSK
WIP: Refresh / close views on enhancements toggled (eclipse-jdt#1073)
76784d7
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 10, 2024
@RedeemerSK
Add enhancements toggling item to styling menu (eclipse-jdt#1073)
4fb7760
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 10, 2024
@RedeemerSK
Add enhancements toggling feature flag (eclipse-jdt#1073)
4c49a1c
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 14, 2024
@RedeemerSK
Enhancements toggling done by styling menu button itself (eclipse-jdt…
cffd6eb 
…#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Merge wrapping & formatting enhancements into one (eclipse-jdt#1073)
05bb0d0
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Remove type parameters levels coloring (eclipse-jdt#1073)
24ab139
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Formatting enhancement always ON when all enhancements enabled (eclip…
538e3d0 
…se-jdt#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Remove preview overlay (eclipse-jdt#1073)
c972c30
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Remove hover support & make coloring menu item a checkbox (eclipse-jd…
7bd4d99 
…t#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
JavadocView & JavadocHover share all enhancements preferences (eclips…
9626a39 
…e-jdt#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Realtime coloring enhancement state/color change in other view (eclip…
3251637 
…se-jdt#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
ecc38df 
…1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Add enhancements toggling item to styling menu (eclipse-jdt#1073)
666f28b
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Enhancements toggling done by styling menu button itself (eclipse-jdt…
6aac2f6 
…#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Merge wrapping & formatting enhancements into one (eclipse-jdt#1073)
45e31d0
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Remove type parameters levels coloring (eclipse-jdt#1073)
906dc32
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Formatting enhancement always ON when all enhancements enabled (eclip…
b65ec78 
…se-jdt#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 17, 2024
@RedeemerSK
Remove preview overlay (eclipse-jdt#1073)
19885c1
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 22, 2024
@RedeemerSK
Revert adding new icons (eclipse-jdt#1073)
39bf91d
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 22, 2024
@RedeemerSK
Apply new enhancements settings to JavadocHover without closing (ecli…
504c8f2 
…pse-jdt#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 22, 2024
@RedeemerSK
Remove code for toggling checkbox inside Browser content (eclipse-jdt…
1a9a525 
…#1073)

Also fix unnecessary triggering/calling of enhancementsReconfiguredTask.
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 22, 2024
@RedeemerSK
Allow showing styling menu when enhancements disabled (eclipse-jdt#1073)
73ac28d
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 22, 2024
@RedeemerSK
Remove changed color log messages on reseting colors to defaults (ecl…
366d1f4 
…ipse-jdt#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Add styling enhancements to JavaElementLinks in Javadoc (eclipse-jdt#…
2027af2 
…1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Add enhancements toggling item to styling menu (eclipse-jdt#1073)
a54d63d
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Enhancements toggling done by styling menu button itself (eclipse-jdt…
a398347 
…#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Merge wrapping & formatting enhancements into one (eclipse-jdt#1073)
5414781
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Remove type parameters levels coloring (eclipse-jdt#1073)
57eb284
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Formatting enhancement always ON when all enhancements enabled (eclip…
944ad21 
…se-jdt#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Remove preview overlay (eclipse-jdt#1073)
578737b
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Remove hover support & make coloring menu item a checkbox (eclipse-jd…
eee7e37 
…t#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
JavadocView & JavadocHover share all enhancements preferences (eclips…
3f7ba10 
…e-jdt#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Realtime coloring enhancement state/color change in other view (eclip…
bd6a5a7 
…se-jdt#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Revert adding new icons (eclipse-jdt#1073)
30d4926
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Apply new enhancements settings to JavadocHover without closing (ecli…
37d2dd8 
…pse-jdt#1073)
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Remove code for toggling checkbox inside Browser content (eclipse-jdt…
2d241c0 
…#1073)

Also fix unnecessary triggering/calling of enhancementsReconfiguredTask.
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Allow showing styling menu when enhancements disabled (eclipse-jdt#1073)
eb30b2c
jjohnstn pushed a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 26, 2024
@RedeemerSK @jjohnstn
Remove changed color log messages on reseting colors to defaults (ecl…
bb2702b 
…ipse-jdt#1073)
RedeemerSK added a commit to RedeemerSK/eclipse.jdt.ui that referenced this issue Mar 29, 2024
@RedeemerSK
Fix type parameters coloring corner cases (eclipse-jdt#1073 eclipse-j…
2c7497c 
…dt#1074)

Missing coloring for class / interface from other compilation unit.
Applied coloring to labels outside of diamond brackets.
@RedeemerSK RedeemerSK mentioned this issue Apr 2, 2024
Closed
jjohnstn pushed a commit that referenced this issue Apr 3, 2024
@RedeemerSK
Fix type parameters coloring corner cases (#1073 #1074) (#1296)
a0babe0 
Missing coloring for class / interface from other compilation unit.
Applied coloring to labels outside of diamond brackets.
@iloveeclipse iloveeclipse mentioned this issue Apr 22, 2024
Closed
@iloveeclipse iloveeclipse added this to the 4.32 M1 milestone Apr 22, 2024
@iloveeclipse iloveeclipse changed the title Hard to read method signatures in Javaodc views Hard to read method signatures in Javadoc views Apr 22, 2024
@iloveeclipse iloveeclipse added the enhancement New feature or request label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RedeemerSK RedeemerSK

Labels
enhancement New feature or request
Projects
None yet
Milestone
4.32 M1
Development

Successfully merging a pull request may close this issue.

Add N&N for Javadoc styling improvements RedeemerSK/www.eclipse.org-eclipse
2 participants
@iloveeclipse @RedeemerSK