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.

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

Parse documentation "see" tag #6353

Open
arunchndr opened this issue Sep 12, 2023 · 2 comments
Open

Parse documentation "see" tag #6353

arunchndr opened this issue Sep 12, 2023 · 2 comments
Assignees
Milestone

Comments

@arunchndr
Copy link
Member

From vscode-dotnettools created by Number-3434: microsoft/vscode-dotnettools#453

Type: Bug

Documentation code containing "see" tags are not shown as clickable, or different.
The following:

/// <summary>
/// <see cref="string"/>
/// </summary>
public void MyMethod () { }

should show up as an inline code span in the editor hover, that can be peeked.
Currently, it only shows up as normal text, and cannot be peeked.
The expected result is similar to:

/// <summary>
/// <see href="System.String"><c>string</c></see>
/// </summary>
public void MyMethod () { }

Extension version: 0.3.21
VS Code version: Code 1.81.1 (Universal) (6c3e3dba23e8fadc360aed75ce363ba185c49794, 2023-08-09T22:20:33.924Z)
OS version: Darwin x64 22.4.0
Modes:

System Info
Item Value
CPUs Intel(R) Core(TM) i7-7660U CPU @ 2.50GHz (4 x 2500)
GPU Status 2d_canvas: enabled
canvas_oop_rasterization: disabled_off
direct_rendering_display_compositor: disabled_off_ok
gpu_compositing: enabled
metal: disabled_off
multiple_raster_threads: enabled_on
opengl: enabled_on
rasterization: enabled
raw_draw: disabled_off_ok
video_decode: enabled
video_encode: enabled
vulkan: disabled_off
webgl: enabled
webgl2: enabled
webgpu: enabled
Load (avg) 3, 12, 15
Memory (System) 16.00GB (0.77GB free)
Process Argv --crash-reporter-id e4f569aa-2d6f-475d-805e-ac24d24373c8
Screen Reader no
VM 0%
A/B Experiments
vsliv368:30146709
vsreu685:30147344
python383:30185418
vspor879:30202332
vspor708:30202333
vspor363:30204092
vslsvsres303:30308271
vserr242cf:30382550
pythontb:30283811
vsjup518:30340749
pythonptprofiler:30281270
vsdfh931cf:30280410
vshan820:30294714
vstes263:30335439
vscod805:30301674
binariesv615:30325510
bridge0708:30335490
bridge0723:30353136
vsaa593:30376534
pythonvs932:30410667
vsclangdf:30486550
c4g48928:30535728
dsvsc012:30540252
pynewext54:30695312
azure-dev_surveyone:30548225
vscccc:30803845
282f8724:30602487
f6dab269:30613381
showlangstatbar:30737416
962ge761:30823813
03d35959:30757346
pythonfmttext:30731395
fixshowwlkth:30771522
showindicator:30805244
pythongtdpath:30769146
i26e3531:30792625
gsofa:30804715
pythonnosmt12:30797651
pythonidxpt:30805730
pythonnoceb:30805159
dsvsc013:30795093
dsvsc014:30804076
diffeditorv2:30821572

@sharwell
Copy link
Member

sharwell commented Sep 13, 2023

I would expect this to already be supported by the system that provides this:
https://github.com/dotnet/roslyn/blob/0959e07bd092935fb5a39fb0e9c6eefc3fc26d6c/src/EditorFeatures/Test2/IntelliSense/IntellisenseQuickInfoBuilderTests_Code.vb

Strangely I don't see any existing tests for <see> in these files.

I see tests for <see href="..."/> and <see href="...">...</see>, but I don't see any for <see cref="..."/>:
https://github.com/dotnet/roslyn/blob/0959e07bd092935fb5a39fb0e9c6eefc3fc26d6c/src/EditorFeatures/Test2/IntelliSense/IntellisenseQuickInfoBuilderTests_Links.vb

@dibarbet
Copy link
Member

To support this we'd need to implement a link in markdown that either

  1. Links to a file URI in this format - https://github.com/microsoft/vscode/blob/b3ec8181fc49f5462b5128f38e0723ae85e295c2/src/vs/platform/opener/common/opener.ts#L151-L160
  2. Or references a VSCode command that can be executed on the client or server to navigate to the file, see Markdown Render VSCode Command Link microsoft/vscode#140733

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants