call the GenerateXmlDocumentation Command from a CodeFix #1094
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHAT
🤖 Generated by Copilot at 5d7aa48
This pull request adds a new code fix for generating XML documentation comments for F# elements that lack them. It defines a new module
GenerateXmlDocumentation
that implements the logic for the code fix, and registers it with the two types of language servers that FsAutoComplete supports:AdaptiveFSharpLspServer
andFSharpLspServer
. It also adds tests for the code fix in thetest/FsAutoComplete.Tests.Lsp/CodeFixTests/Tests.fs
file.🤖 Generated by Copilot at 5d7aa48
📝🔧🧪
WHY
As discussed on discord: This adds a codefix that calls the GenerateXmlDocumentation Command. Contrary to the command, the codefix is only applicable if there is not already xml documentation present.
There are two things the command could be improved on:
TryGetSignatureData
.If there is interest in that, I could improve the command in a separate PR.
HOW
🤖 Generated by Copilot at 5d7aa48
GenerateXmlDocumentation
that defines a code fix for generating placeholder XML documentation for F# elements that lack it (link)AdaptiveFSharpLspServer
andFSharpLspServer
types to handle theGenerateXmlDocumentation
code fix (link, link)GenerateXmlDocumentation
code fix in the moduleFsAutoComplete.Tests.CodeFixTests.Tests
(link)generateXmlDocumentationTests
function in the entry point for running all the code fix tests (link)