Fix issue where doc comment with nested comments inside is not shown properly on hover. (#526)

* Add an example doc comment with code block

See #522

* More tests in a separate file.

* Add example with no nested comments.

* Found the issue.

* Remove PrepareUtils

Might be the last file inherited from the original extension, which keeps on giving years later.

* Update CHANGELOG.md

Author: cristianoc

CHANGELOG.md

@@ -23,6 +23,8 @@
 
 - Fix Incorrect semantic highlighting of `external` declarations https://github.com/rescript-lang/rescript-vscode/pull/517
 
+- Fix issue where doc comment with nested comments inside is not shown properly on hover https://github.com/rescript-lang/rescript-vscode/pull/526
+
 ## v1.4.2
 
 #### :bug: Bug Fix

analysis/src/PrepareUtils.ml

@@ -14,7 +14,7 @@ let rec findDocAttribute attributes =
           };
         ] )
     :: _ ->
-    Some (PrepareUtils.cleanOffStars doc)
+    Some doc
   | _ :: rest -> findDocAttribute rest
 
 let rec findDeprecatedAttribute attributes =

analysis/src/ProcessAttributes.ml

@@ -0,0 +1,46 @@
+@ns.doc("  Doc comment with a triple-backquote example
+  
+  ```res example
+    let a = 10
+    /*
+     * stuff
+     */
+  ```
+")
+let docComment1 = 12
+//       ^hov
+
+/**
+  Doc comment with a triple-backquote example
+  
+  ```res example
+    let a = 10
+    /*
+     * stuff
+     */
+  ```
+*/
+let docComment2 = 12
+//    ^hov
+
+
+@ns.doc("  Doc comment with a triple-backquote example
+  
+  ```res example
+    let a = 10
+    let b = 20
+  ```
+")
+let docCommentNoNested1 = 12
+//       ^hov
+
+/**
+  Doc comment with a triple-backquote example
+  
+  ```res example
+    let a = 10
+    let b = 20
+  ```
+*/
+let docCommentNoNested2 = 12
+//    ^hov

analysis/tests/src/DocComments.res

@@ -0,0 +1,12 @@
+Hover src/DocComments.res 9:9
+{"contents": "```rescript\nint\n```\n\n  Doc comment with a triple-backquote example\\n  \\n  ```res example\\n    let a = 10\\n    /*\\n     * stuff\\n     */\\n  ```\\n"}
+
+Hover src/DocComments.res 22:6
+{"contents": "```rescript\nint\n```\n\n\n  Doc comment with a triple-backquote example\n  \n  ```res example\n    let a = 10\n    /*\n     * stuff\n     */\n  ```\n"}
+
+Hover src/DocComments.res 33:9
+{"contents": "```rescript\nint\n```\n\n  Doc comment with a triple-backquote example\\n  \\n  ```res example\\n    let a = 10\\n    let b = 20\\n  ```\\n"}
+
+Hover src/DocComments.res 44:6
+{"contents": "```rescript\nint\n```\n\n\n  Doc comment with a triple-backquote example\n  \n  ```res example\n    let a = 10\n    let b = 20\n  ```\n"}
+