Eclipse Community Forums: Java Development Tools (JDT) » Javadoc constructor/method signature readability

Home » Language IDEs » Java Development Tools (JDT) » Javadoc constructor/method signature readability(Javadoc view lack of readability for long signatures)

Show: Today's Messages :: Show Polls :: Message Navigator

Javadoc constructor/method signature readability [message #1870623]

Wed, 04 September 2024 11:16

Mykhaylo Adamovych

Messages: 5
Registered: April 2015

Junior Member

Hi, is it possible to improve Javadoc view (both pop-up and static) to display constructor/method signatures? Making text bold is not about improving readability. For example, return type and method name could be at the same line and long list of arguments may go next line or even each argument on a new line with indentation. Package name, class name, parameter types, parameter names could differ by color to grasp it easily.
Is there any configuration to achieve that? If not, how could this be addressed?

Attachment: screenshot.png
(Size: 55.15KB, Downloaded 40 times)

Report message to a moderator

Re: Javadoc constructor/method signature readability [message #1870641 is a reply to message #1870623]

Wed, 04 September 2024 12:07

Erik Brangs

Messages: 55
Registered: February 2010

Member

What version of Eclipse are you using? IIRC improved JavaDoc formatting was added in Eclipse 2024-06.

Report message to a moderator

Re: Javadoc constructor/method signature readability [message #1870644 is a reply to message #1870623]

Wed, 04 September 2024 13:37

Eitan Rosenberg

Messages: 149
Registered: October 2018

Senior Member

This is what is shown in version: 2024-06 (4.32)

index.php/fa/45120/0/

Much better.....

Attachment: 2024-09-04_16-34-39.png
(Size: 23.16KB, Downloaded 69 times)

Report message to a moderator

Re: Javadoc constructor/method signature readability [message #1870683 is a reply to message #1870644]

Thu, 05 September 2024 08:58

Mykhaylo Adamovych

Messages: 5
Registered: April 2015

Junior Member

Indeed )
This was annoying issue for years and after I tried to discuss this with Eclipse dev community I found that 2 months ago there was a release which has a fix.
Somebody was reading my thoughts )
Thanks a lot for your answers!

Report message to a moderator

Re: Javadoc constructor/method signature readability [message #1870686 is a reply to message #1870683]

Thu, 05 September 2024 09:40

Mykhaylo Adamovych

Messages: 5
Registered: April 2015

Junior Member

Started using new Eclipse and found that when pointing to method name it's (method) javadoc is displayed but when pointing to a parameter outer method's javadoc is displayed.
I would like to see the same method javadoc (I'm still on a method signature) with respective parameter highlighted somehow on a javadoc view to help with understanding and visualizing the method I'm scrutinizing in the code.
But this is definitely better then it was before.

Report message to a moderator

Previous Topic:	Installation problem
Next Topic:	eclipse for java variable debugger does not show some values

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Wed Feb 05 04:52:19 GMT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter