search

vmware-archive / scripted

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

Include JSDoc in hovers #170

Closed aeisenberg closed 11 years ago

aeisenberg commented 11 years ago

We should be showing a nicely formatted JSDoc of the target in hovers (if appropriate).

Phoscur commented 11 years ago

While doing this, fix hovers! Bug: try to get type info from hover: hover blinks in and out of sight -> unreadable leaving the mouse somewhere in the editor also produces this annoying blinking hover Seems to be chrome specific.

aeisenberg commented 11 years ago

I have not seen the blinking hover problem. What OS are you on?

Phoscur commented 11 years ago

Windows 7 x64 Chrome 26 Chrome Canary

npm install -g scripted

aeisenberg commented 11 years ago

Could also be something about running the canary builds. I used to run canary, but things started randomly breaking and so I moved back to the release channel. Much happier now.

aeisenberg commented 11 years ago

If you still get this problem, please raise a new issue for it. This issue is about jsdoc in hovers. This is a feature that is becoming more important. Will try to get this for the 0.4 release.

aeisenberg commented 11 years ago

Done. Just pushed 6ec9c87 that now shows jsdoc comments in hovers. I do some minimal formatting to remove the * and trailing whitespace, but it is not formatted like proper docs should be. I would like to use a library to do this, but so far have not found a good library for jsdoc rendering that doesn't expect an entire project.

I will raise a new issue for proper rendering of jsdoc.