dotnet / dotnet/fsharp

Have PreXmlDoc/XmlDoc track names and ranges for param/paramref children

Open
#15,134 0 comments 0 reactions 0 assignees View on GitHub
Area-XmlDocs Feature Request
Dominant language
F#
Stars
4.3k
Forks
876
Avg merge
4d 11h
Merged PRs (30d)
131

Description

**Is your feature request related to a problem? Please describe.**

I wanted to make xmldocs participate in rename in FsAutoComplete, so that when a user renamed a constructor parameter, or function binding parameter, etc. the matching xmlDoc on that element, as well as any `paramRef`s referring to that parameter, would be updated as well. This turned out to be very difficult.

**Describe the solution you'd like**

I'd like the PreXmlDoc/XmlDoc structures to track the names (including source-file-ranges of the actual name string) of the parsed Xml Doc Comments for structures that can have parameters. This includes, but may not be limited to

* implicit and explicit constructors
* DU case type constructors
* let bindings that describe functions

**Describe alternatives you've considered**

FSAC starts doing _a lot_ of re-parsing of XmlDocs :)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.