Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Support @example <caption> #79704

Closed
thany opened this issue Aug 23, 2019 · 3 comments · Fixed by #79846
Closed

Support @example <caption> #79704

thany opened this issue Aug 23, 2019 · 3 comments · Fixed by #79846
Assignees
@mjbvz
Labels
feature-request Request for new features or functionality grammar Syntax highlighting grammar help wanted Issues identified as good community contribution opportunities verification-needed Verification of issue is requested verified Verification succeeded
Milestone
August 2019

Comments

@thany
Copy link

thany commented Aug 23, 2019

Issue Type: Feature Request

I would like support for the <caption> element inside a JSdoc @example block.

See here:
https://jsdoc.app/tags-example.html

Currently it displays the <caption> element literally, because VScode (blindly) assumes that everything after @example is javascript/typescript.

VS Code version: Code 1.37.1 (f06011a, 2019-08-15T16:17:55.855Z)
OS version: Windows_NT x64 10.0.18362
@mjbvz mjbvz added feature-request Request for new features or functionality help wanted Issues identified as good community contribution opportunities grammar Syntax highlighting grammar labels Aug 24, 2019
@hypercubestart
Copy link
Contributor

I am interested in picking this issue up

@mjbvz
Copy link
Collaborator

mjbvz commented Aug 26, 2019

Here's the relevant code:

vscode/extensions/typescript-language-features/src/utils/previewer.ts

Line 16 in 017a497

case 'default':

@hypercubestart hypercubestart mentioned this issue Aug 27, 2019
Merged
@hypercubestart
Copy link
Contributor

@mjbvz I made a PR, I thought it made more sense for the code to be under

vscode/extensions/typescript-language-features/src/utils/previewer.ts

Line 15 in 017a497

case 'example':

but please let me know if I am wrong

@mjbvz mjbvz added the verification-needed Verification of issue is requested label Aug 27, 2019
@mjbvz mjbvz added this to the August 2019 milestone Aug 27, 2019
mjbvz added a commit that referenced this issue Aug 27, 2019
@mjbvz
Fix caption parsing
8891b85 
For #79704

- Use regexp
- Handle unix line endings
- Don't highlight caption as part of code block
@jrieken jrieken added the verified Verification succeeded label Aug 28, 2019
hunghw pushed a commit to hunghw/vscode that referenced this issue Aug 28, 2019
@mjbvz @hwhung0111
Fix caption parsing
31591bc 
For microsoft#79704

- Use regexp
- Handle unix line endings
- Don't highlight caption as part of code block
@vscodebot vscodebot bot locked and limited conversation to collaborators Oct 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@mjbvz mjbvz

Labels
feature-request Request for new features or functionality grammar Syntax highlighting grammar help wanted Issues identified as good community contribution opportunities verification-needed Verification of issue is requested verified Verification succeeded
Projects
None yet
Milestone
August 2019
Development

Successfully merging a pull request may close this issue.

fix for 79704 - support for @example <caption> hypercubestart/vscode
4 participants
@thany @jrieken @mjbvz @hypercubestart