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

Highitling can't represent interfaces or structs from XML documentation #9606

Open
cartermp opened this issue Jun 30, 2020 · 1 comment
Open

Comments

@cartermp
Copy link
Contributor

Consider the following tooltip:

image

The IApplicationBuilder in the summary text is colored as a class. This is because the information is read as an XML doc, and the type is given the "type" tag. This tag has no information about if the type it is referring to is a class, interface, or struct. Currently, VS tooling (VS layer, not FCS layer) reads this and defaults to class since it's probably assumed to be the most common.

A quick hack would be to see if the name starts with I, then treat it as an interface. But that's a hack.

To do this properly, we would need to read this data and build a mapping between the fully-qualified type and a real symbol we resolve. This would then tell us which kind of type it is, and we could tag it appropriately.

Labeling this as a bug because it seems like a bug from the user's perspective, but it is actually a fundamental change we have to make.

@cartermp cartermp added this to the Unknown / not bug milestone Jun 30, 2020
@dsyme dsyme added Bug and removed Bug labels Aug 26, 2020
@dsyme dsyme changed the title Cannot reasonably represent interfaces or structs from XML documentation Highitling can't represent interfaces or structs from XML documentation Sep 1, 2020
@dsyme dsyme removed the Bug label Sep 1, 2020
@dsyme
Copy link
Contributor

dsyme commented Sep 1, 2020

@cartermp I removed "bug" because, have been through various bug/improvements, this does seem to fall on the "improvement" line of things

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

No branches or pull requests

3 participants