Don't remove the doc of @inline include expansions

Author: Julow

src/xref2/compile.ml

@@ -308,11 +308,6 @@ and module_type : Env.t -> ModuleType.t -> ModuleType.t =
 and include_ : Env.t -> Include.t -> Include.t =
  fun env i ->
   let open Include in
-  let remove_top_doc_from_signature s =
-    let open Signature in
-    let items = match s.items with Comment (`Docs _) :: xs -> xs | xs -> xs in
-    { s with items }
-  in
   let decl = Component.Of_Lang.(include_decl empty i.decl) in
   let get_expansion () =
     match
@@ -339,8 +334,7 @@ and include_ : Env.t -> Include.t -> Include.t =
         in
         {
           shadowed = i.expansion.shadowed;
-          content =
-            remove_top_doc_from_signature (signature env i.parent expansion_sg);
+          content = signature env i.parent expansion_sg;
         }
   in
   let expansion =

src/xref2/link.ml

@@ -34,6 +34,11 @@ let synopsis_from_comment docs =
       | _ -> None)
     docs
 
+let remove_top_doc_from_signature s =
+  let open Signature in
+  let items = match s.items with Comment (`Docs _) :: xs -> xs | xs -> xs in
+  { s with items }
+
 exception Loop
 
 let rec is_forward : Paths.Path.Module.t -> bool = function
@@ -417,14 +422,12 @@ and module_ : Env.t -> Module.t -> Module.t =
                 Alias (`Resolved p, Some (simple_expansion env sg_id le))
             | Error _ -> Alias (`Resolved p, e)
           else Alias (`Resolved p, e)
-      | Alias _ -> type_
-      | ModuleType mty -> ModuleType mty
+      | Alias _ | ModuleType _ -> type_
     in
     let doc, type_ =
       match m.doc with [] -> extract_doc type_ | _ -> (m.doc, type_)
     in
-    let result = { m with doc = comment_docs env doc; type_ } in
-    result
+    { m with doc = comment_docs env doc; type_ }
 
 and module_decl : Env.t -> Id.Signature.t -> Module.decl -> Module.decl =
  fun env id decl ->
@@ -470,17 +473,15 @@ and include_ : Env.t -> Include.t -> Include.t =
     let is_inline_tag element = element.Location_.value = `Tag `Inline in
     List.exists is_inline_tag doc
   in
-  {
-    i with
-    decl;
-    expansion =
-      {
-        shadowed = i.expansion.shadowed;
-        content = signature env i.parent i.expansion.content;
-      };
-    inline = should_be_inlined;
-    doc;
-  }
+  let expansion =
+    let content = signature env i.parent i.expansion.content in
+    let content =
+      if should_be_inlined then content
+      else remove_top_doc_from_signature content
+    in
+    { i.expansion with content }
+  in
+  { i with decl; expansion; inline = should_be_inlined; doc }
 
 and functor_parameter_parameter :
     Env.t -> FunctorParameter.parameter -> FunctorParameter.parameter =

test/html/expect/test_package+ml/Toplevel_comments/Include_inline'/index.html

@@ -35,6 +35,9 @@ <h1>
       <p>
        part 3
       </p>
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code>

test/html/expect/test_package+ml/Toplevel_comments/Include_inline/index.html

@@ -26,6 +26,9 @@ <h1>
    <div class="odoc-include">
     <div class="spec include">
      <div class="doc">
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code>

test/html/expect/test_package+ml/Toplevel_comments/module-type-Include_inline_T'/index.html

@@ -35,6 +35,9 @@ <h1>
       <p>
        part 3
       </p>
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code>

test/html/expect/test_package+ml/Toplevel_comments/module-type-Include_inline_T/index.html

@@ -26,6 +26,9 @@ <h1>
    <div class="odoc-include">
     <div class="spec include">
      <div class="doc">
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code>

test/html/expect/test_package+re/Toplevel_comments/Include_inline'/index.html

@@ -35,6 +35,9 @@ <h1>
       <p>
        part 3
       </p>
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span>;</span></code>

test/html/expect/test_package+re/Toplevel_comments/Include_inline/index.html

@@ -26,6 +26,9 @@ <h1>
    <div class="odoc-include">
     <div class="spec include">
      <div class="doc">
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span>;</span></code>

test/html/expect/test_package+re/Toplevel_comments/module-type-Include_inline_T'/index.html

@@ -35,6 +35,9 @@ <h1>
       <p>
        part 3
       </p>
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span>;</span></code>

test/html/expect/test_package+re/Toplevel_comments/module-type-Include_inline_T/index.html

@@ -26,6 +26,9 @@ <h1>
    <div class="odoc-include">
     <div class="spec include">
      <div class="doc">
+      <p>
+       Doc of <code>T</code>, part 2.
+      </p>
       <div class="odoc-spec">
        <div class="spec type" id="type-t">
         <a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span>;</span></code>