Feature request: function documentation preview

[developerdavi]

trafficstars

The issue

When you hover above a function/event call you get some description of it on a popup, but you can't see the documented block - if there's any - in the popup as well like we have on other languages.

Example

Consider this function:

If we hover the mouse above a function call we will see the popup with the function definition but without the text extracted from the documentation block:

In other languages e.g JavaScript the editor will show the documentation extracted from the JSDOC comment:

Is that feature already included in the roadmap or is there some on going work already about that? I'm open to help to implement that if nobody is working on it right now.

[kanej]

That is a great feature and one we want to deliver. The reason we don't show the documentation against the function currently is that our parser ignores comments (it is designed for compilation and comments don't affect that), hence that information is not coming through in our analysis.

We are developing a new parser that will include the documentation information and associate with the function, so this feature is currently blocked behind that.

[developerdavi]

Got it! That's awesome. Thank you for the feedback :)