Skip to content
This repository has been archived by the owner on Nov 5, 2021. It is now read-only.

Add documentation support on hover #14

Merged
merged 1 commit into from
Jun 27, 2017

Conversation

kitsonk
Copy link
Contributor

@kitsonk kitsonk commented Jun 18, 2017

This PR adds support for quick info documentation and tags, which is similar to the hover support provided by vscode.

An example for the following code:

/**
 * Some documentation
 * @pure non-standard tag
 * @deprecated which should be parsed
 */
function foo() {
	//
}

You get the following when hovering:

_dojo_web-editor

Resolves: microsoft/monaco-editor#203
Resolves: microsoft/monaco-editor#277

@msftclas
Copy link

@kitsonk,
Thanks for having already signed the Contribution License Agreement. Your agreement was validated by Microsoft. We will now review your pull request.
Thanks,
Microsoft Pull Request Bot

@jrieken
Copy link
Member

jrieken commented Jun 19, 2017

Don't think that we need this anymore. See microsoft/monaco-editor#203 (comment)

@jrieken jrieken closed this Jun 19, 2017
@kitsonk
Copy link
Contributor Author

kitsonk commented Jun 19, 2017

@jrieken I mistook the functionality requested in that issue, but I still think this PR is valid.

This provides support for documentation and decorators that aren't otherwise injested by the language services, just like vscode.

Given this code:

/**
 * Documentation goes here
 * @deprecated
 */
function foo() {
	//
}

This is an example of the hover provider in vscode:

example_ts_ _web-editor

This is an example of monaco-editor without this PR:

playground_ _typescript

This is an example of monaco-editor with this PR:

_dojo_web-editor

@jrieken
Copy link
Member

jrieken commented Jun 27, 2017

Ok, thanks.

@jrieken jrieken reopened this Jun 27, 2017
@msftclas
Copy link

@kitsonk,
Thanks for having already signed the Contribution License Agreement. Your agreement was validated by Microsoft. We will now review your pull request.
Thanks,
Microsoft Pull Request Bot

@jrieken jrieken merged commit c8118cb into microsoft:master Jun 27, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants