More doc comment cleanup.

Author: cristianoc

src/rescript-editor-support/Hover.re

@@ -38,8 +38,8 @@ let showModuleTopLevel =
   let full = "module " ++ name ++ " = {" ++ "\n" ++ contents ++ "\n}";
   let doc =
     switch (docstring) {
-    | None => ""
-    | Some(s) => "\n" ++ s ++ "\n"
+    | [] => ""
+    | [_, ..._] => "\n" ++ (docstring |> String.concat("\n")) ++ "\n"
     };
   Some(doc ++ codeBlock(full));
 };
@@ -133,10 +133,7 @@ let newHover = (~file: SharedTypes.file, ~getModule, loc) => {
         | None => (typeString, docstring)
         | Some((extra, extraDocstring)) => (
             typeString ++ "\n\n" ++ codeBlock(extra),
-            switch (extraDocstring) {
-            | None => []
-            | Some(d) => [d]
-            },
+            extraDocstring,
           )
         };
       (typeString, docstring);

src/rescript-editor-support/NewCompletions.re

@@ -587,8 +587,8 @@ let mkItem = (~name, ~kind, ~detail, ~deprecated, ~docstring, ~uri, ~pos_lnum) =
     )
     ++ (
       switch (docstring) {
-      | None => ""
-      | Some(s) => s ++ "\n\n"
+      | [] => ""
+      | [_, ..._] => (docstring |> String.concat("\n")) ++ "\n\n"
       }
     )
     ++ "\n"
@@ -793,7 +793,7 @@ let processCompletable =
         ~kind=4,
         ~deprecated=None,
         ~detail="",
-        ~docstring=None,
+        ~docstring=[],
         ~uri=full.file.uri,
         ~pos_lnum=fst(pos),
       );
@@ -869,7 +869,7 @@ let processCompletable =
         ~kind=4,
         ~deprecated=None,
         ~detail=typ |> Shared.typeToString,
-        ~docstring=None,
+        ~docstring=[],
         ~uri=full.file.uri,
         ~pos_lnum=fst(pos),
       );

src/rescript-editor-support/ProcessAttributes.re

@@ -1,5 +1,4 @@
 open SharedTypes;
-open Infix;
 
 /* TODO should I hang on to location? */
 let rec findDocAttribute = attributes => {
@@ -73,7 +72,11 @@ let newDeclared =
     exported,
     modulePath,
     deprecated: findDeprecatedAttribute(attributes),
-    docstring: findDocAttribute(attributes) |?>> processDoc,
+    docstring:
+      switch (findDocAttribute(attributes)) {
+      | None => []
+      | Some(d) => processDoc(d)
+      },
     item,
     /* scopeType: Let, */
     /* scopeStart: env.scopeStart, */

src/rescript-editor-support/ProcessCmt.re

@@ -41,7 +41,7 @@ let sigItemsExtent = items => {
 
 type env = {
   stamps,
-  processDoc: string => string,
+  processDoc: string => list(string),
   modulePath: visibilityPath,
   scope: Location.t,
 };
@@ -203,7 +203,7 @@ and forSignatureType = (env, signature) => {
       signature,
       [],
     );
-  {docstring: None, exported, topLevel};
+  {docstring: [], exported, topLevel};
 }
 and forModuleType = (env, moduleType) =>
   switch (moduleType) {
@@ -376,7 +376,10 @@ let forSignature = (~env, items) => {
     | _ => []
     };
   let docstring =
-    ProcessAttributes.findDocAttribute(attributes) |?>> env.processDoc;
+    switch (ProcessAttributes.findDocAttribute(attributes)) {
+    | None => []
+    | Some(d) => env.processDoc(d)
+    };
   {docstring, exported, topLevel};
 };
 
@@ -573,7 +576,10 @@ and forStructure = (~env, items) => {
     | _ => []
     };
   let docstring =
-    ProcessAttributes.findDocAttribute(attributes) |?>> env.processDoc;
+    switch (ProcessAttributes.findDocAttribute(attributes)) {
+    | None => []
+    | Some(d) => env.processDoc(d)
+    };
   {docstring, exported, topLevel};
 };
 

src/rescript-editor-support/ProcessExtra.re

@@ -405,7 +405,7 @@ module F =
               loc_end: currentScopeExtent().loc_end,
             },
             ~modulePath=NotVisible,
-            ~processDoc=x => x,
+            ~processDoc=x => [x],
             ~item=val_desc.ctyp_type,
             false,
             val_attributes,
@@ -443,7 +443,7 @@ module F =
             },
             ~modulePath=NotVisible,
             ~extent=pat_loc,
-            ~processDoc=x => x,
+            ~processDoc=x => [x],
             ~item=pat_type,
             false,
             pat_attributes,

src/rescript-editor-support/Process_406.rei

@@ -1,7 +1,7 @@
 let fileForCmt:
-  (~moduleName: string, ~uri: Uri2.t, string, string => string) =>
+  (~moduleName: string, ~uri: Uri2.t, string, string => list(string)) =>
   result(SharedTypes.file, string);
 
 let fullForCmt:
-  (~moduleName: string, ~uri: Uri2.t, string, string => string) =>
+  (~moduleName: string, ~uri: Uri2.t, string, string => list(string)) =>
   result(SharedTypes.full, string);

src/rescript-editor-support/References.re

@@ -114,12 +114,7 @@ let definedForLoc = (~file, ~getModule, locKind) => {
       );
       let%opt declared =
         Query.declaredForTip(~stamps=file.stamps, stamp, tip);
-      let docstring =
-        switch (declared.docstring) {
-        | None => []
-        | Some(d) => [d]
-        };
-      Some((docstring, `Declared));
+      Some((declared.docstring, `Declared));
     };
   };
 

src/rescript-editor-support/SharedTypes.re

@@ -54,7 +54,7 @@ type declared('t) = {
   modulePath: visibilityPath,
   exported: bool,
   deprecated: option(string),
-  docstring: option(string),
+  docstring: list(string),
   item: 't,
   /* TODO maybe add a uri? */
   /* scopeType: scope, */
@@ -69,7 +69,7 @@ let emptyDeclared = name => {
   modulePath: NotVisible,
   exported: false,
   deprecated: None,
-  docstring: None,
+  docstring: [],
   item: (),
 };
 
@@ -142,7 +142,7 @@ type moduleItem =
   | MType(Type.t, Types.rec_status)
   | Module(moduleKind)
 and moduleContents = {
-  docstring: option(string),
+  docstring: list(string),
   exported,
   topLevel: list(declared(moduleItem)),
 }
@@ -178,7 +178,7 @@ let emptyFile = (moduleName, uri) => {
   stamps: initStamps(),
   moduleName,
   contents: {
-    docstring: None,
+    docstring: [],
     exported: initExported(),
     topLevel: [],
   },

src/rescript-editor-support/State.re

@@ -9,8 +9,8 @@ let odocToMd = text => MarkdownOfOCamldoc.convert(text);
 let compose = (fn1, fn2, arg) => fn1(arg) |> fn2;
 
 let converter = src => {
-  let mlToOutput = compose(odocToMd, Omd.to_markdown);
-  fold(src, mlToOutput, src => isMl(src) ? mlToOutput : (x => x));
+  let mlToOutput = s => [compose(odocToMd, Omd.to_markdown, s)];
+  fold(src, mlToOutput, src => isMl(src) ? mlToOutput : (x => [x]));
 };
 
 let newDocsForCmt = (~moduleName, cmtCache, changed, cmt, src) => {
@@ -62,11 +62,8 @@ let getFullFromCmt = (~state, ~uri) => {
   switch (Hashtbl.find_opt(package.pathsForModule, moduleName)) {
   | Some(paths) =>
     let cmt =
-      SharedTypes.getCmt(
-        ~interface=Utils.endsWith(path, "i"),
-        paths,
-      );
-    let%try full = Process_406.fullForCmt(~moduleName, ~uri, cmt, x => x);
+      SharedTypes.getCmt(~interface=Utils.endsWith(path, "i"), paths);
+    let%try full = Process_406.fullForCmt(~moduleName, ~uri, cmt, x => [x]);
     Hashtbl.replace(
       package.interModuleDependencies,
       moduleName,