offer "generate xml documentation" to properties with explicit getter…

…/setter (#1126)
ionide · Jul 1, 2023 · 95fa929 · 95fa929
1 parent 0e4a2e3
commit 95fa929
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 0 deletions.
diff --git a/src/FsAutoComplete.Core/Commands.fs b/src/FsAutoComplete.Core/Commands.fs
@@ -2104,6 +2104,18 @@ type Commands
                                 rangeContainsPos ident.idRange pos && xmlDoc.IsEmpty
                                 ->
                                 Some()
+                              | SynMemberDefn.GetSetMember(
+                                  memberDefnForGet = Some(SynBinding(
+                                    xmlDoc = xmlDoc; headPat = SynPat.LongIdent(longDotId = longDotId)))) when
+                                rangeContainsPos longDotId.Range pos && xmlDoc.IsEmpty
+                                ->
+                                Some()
+                              | SynMemberDefn.GetSetMember(
+                                  memberDefnForSet = Some(SynBinding(
+                                    xmlDoc = xmlDoc; headPat = SynPat.LongIdent(longDotId = longDotId)))) when
+                                rangeContainsPos longDotId.Range pos && xmlDoc.IsEmpty
+                                ->
+                                Some()
                               | _ -> None)
                           | _ -> None)
                       | _ -> None)

diff --git a/test/FsAutoComplete.Tests.Lsp/CodeFixTests/Tests.fs b/test/FsAutoComplete.Tests.Lsp/CodeFixTests/Tests.fs
@@ -1618,6 +1618,69 @@ let private generateXmlDocumentationTests state =
         Diagnostics.acceptAll
         selectCodeFix
 
+      testCaseAsync "documentation on property with explicit getter and setter"
+      <| CodeFix.check
+        server
+        """
+        type MyClass() =
+          let mutable someField = ""
+          member _.$0Name
+            with get () = "foo"
+            and set (x: string) = someField <- x
+        """
+        Diagnostics.acceptAll
+        selectCodeFix
+        """
+        type MyClass() =
+          let mutable someField = ""
+          /// <summary></summary>
+          /// <returns></returns>
+          member _.Name
+            with get () = "foo"
+            and set (x: string) = someField <- x
+        """
+
+      testCaseAsync "documentation on property with explicit getter"
+      <| CodeFix.check
+        server
+        """
+        type MyClass() =
+          let mutable someField = ""
+          member _.$0Name
+            with get () = "foo"
+        """
+        Diagnostics.acceptAll
+        selectCodeFix
+        """
+        type MyClass() =
+          let mutable someField = ""
+          /// <summary></summary>
+          /// <returns></returns>
+          member _.Name
+            with get () = "foo"
+        """
+
+      testCaseAsync "documentation on property with explicit setter"
+      <| CodeFix.check
+        server
+        """
+        type MyClass() =
+          let mutable someField = ""
+          member _.$0Name
+            with set (x: string) = someField <- x
+        """
+        Diagnostics.acceptAll
+        selectCodeFix
+        """
+        type MyClass() =
+          let mutable someField = ""
+          /// <summary></summary>
+          /// <param name="x"></param>
+          /// <returns></returns>
+          member _.Name
+            with set (x: string) = someField <- x
+        """
+
       testCaseAsync "not applicable for explicit getter"
 
       <| CodeFix.checkNotApplicable