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

Add support for href in xmldoc, as we have for cref and langword #25671

Open
jcouv opened this issue Mar 22, 2018 · 3 comments
Open

Add support for href in xmldoc, as we have for cref and langword #25671

jcouv opened this issue Mar 22, 2018 · 3 comments
Labels
Area-IDE Feature Request help wanted The issue is "up for grabs" - add a comment if you are interested in working on it
Milestone

Comments

@jcouv
Copy link
Member

jcouv commented Mar 22, 2018

cref
When typing <see you get an automatic completion with cref=”” and the completion of symbols inside cref also works, and QuickInfo shows cref with proper symbol coloring:

langword
If you edit what was typed above, there is also a completion for langword offered, the choices for langword are also offered (abstract, async, etc), and the langwords are displayed specially in QuickInfo.

href
But when typing href instead, there is no completion for href="" and when displaying this documentation in the IDE, the href is treated as text (no colorization and no link).

href-quickinfo

Tagging @mairaw @BillWagner for additional
Issue relates to dotnet/docs#4176
Relates to https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md

@sharwell
Copy link
Member

sharwell commented Apr 3, 2018

⚠️ be careful not to change the existing tests when implementing this feature. Some of them will seem wrong and/or conflicting, but they were carefully written to catch some muscle memory regressions.

@jinujoseph jinujoseph added this to the Unknown milestone Apr 20, 2018
@joelmartinez
Copy link

fwiw, this support was added to mdoc's ecmaxml format last year :)
mono/api-doc-tools#62

@sharwell sharwell added the help wanted The issue is "up for grabs" - add a comment if you are interested in working on it label May 23, 2018
@dend
Copy link

dend commented May 23, 2018

Another tag that we might need to make sure is properly supported is <threadsafety>.

cc: @joelmartinez @BillWagner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-IDE Feature Request help wanted The issue is "up for grabs" - add a comment if you are interested in working on it
Projects
None yet
Development

No branches or pull requests

5 participants