-
Notifications
You must be signed in to change notification settings - Fork 47
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.
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
Adds support for function docs in hover #495
Conversation
@@ -893,16 +893,6 @@ export class LanguageServer { | |||
|
|||
//return the first non-falsey hover. TODO is there a way to handle multiple hover results? | |||
let hover = hovers.filter((x) => !!x)[0]; | |||
|
|||
//TODO improve this to support more than just .brs files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was forcing all hovers to be brightscript...but we need to support any documentation information provided, so force the underlying files to provide the full markdown text instead of casting it all here.
…munity/brighterscript into feat/hover-func-markdown
@TwitchBronBron, does the documentation has to be in a specific format? do you have a code snippet with a sample? |
@livecano as of right now, it just reads every comment statement between functions. For example: 'I'm shown for one()
sub one()
end sub
' I'm shown for two()
' I'm shown also for two()
'I'm shown for two() as well
sub two()
end sub |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
This shows the function documentation comments when hovering over a function.
Here's an example:
All comments will be parsed as markdown.