vmware-archive / scripted

The Scripted code editor
Eclipse Public License 1.0
1.56k stars 166 forks source link

Some comments on navigation and hovers #220

Closed aclement closed 11 years ago

aclement commented 11 years ago

Some issues and some observations:

Observations:

a) contentAssist.js:386. Hover on ContentAssistMode. Need some color on those @ elements or they need pulling out. Are they not being pulled out for separate formatting due to incorrect jsdoc format?

b) for some simple hover it looks a bit odd, to me, to have them on separate lines. e.g. layoutmanager.js:20, hover on getBoolean, there are two lines in the hover text, when one would suffice. Wonder if we should compress it onto one.

c) the trailing '}' aren't on a newline which I know is a little bit of a waste of space but makes the formatting look crude. E.g. scriptedEditor.js:101 hover over editor. Final '}' in the hover should be on a newline for the formatting to look right, this problem occurs everywhere.

d) scriptedEditor.js:161, hover on shouldExclude. parameter signature is split across lines, looks poor.

e) contentAssist.js:403, hover on cancel. Not sure the comment should be shown or it should be on all those members (as they are all getting the contribution)

f) a la Eclipse, when content assist is open the tooltip for the function should be shown in a box to the right of the content assist box if we have the information.

aeisenberg commented 11 years ago

Lots of things here. Some easy to fix, some hard.

I'll start by taking a look at the non-navigable links you have above and see if there are any improvements we can make.

As for formatting of hovers, particularly jsdoc, my intention is to use doctrine to parse the docs and then use that to feed into a formatter. However currently, doctrine is not error tolerant enough and will barf on too many reasonably formatted jsdoc comments.

aeisenberg commented 11 years ago

More work done in recent commit. Closing this issue. Raised issue #226 for remaining work.