draft

ocaml · Feb 8, 2021 · a78cc2b · a78cc2b
1 parent e0068cb
commit a78cc2b
Show file tree

Hide file tree

Showing 4 changed files with 118 additions and 0 deletions.
diff --git a/test/cases/stop_dead_link_doc.mli b/test/cases/stop_dead_link_doc.mli
@@ -0,0 +1,22 @@
+(**/**)
+module For_generated_code : sig
+    (*_ don't use this by hand, it is only meant for ppx_fields_conv *)
+
+    type ('perm, 'record, 'field) t =
+      { force_variance : 'perm -> unit
+      ; name : string
+      ; setter : ('record -> 'field -> unit) option
+      ; getter : 'record -> 'field
+      ; fset : 'record -> 'field -> 'record
+      }
+
+    val opaque_identity : 'a -> 'a
+  end
+(**/**)
+
+  (**['record] is the type of the record.  ['field] is the type of the
+      values stored in the record field with name [name]. ['perm] is a way
+      of restricting the operations that can be used. *)
+  type ('perm, 'record, 'field) t_with_perm =
+    | Field of ('perm, 'record, 'field) For_generated_code.t
+  [@@unboxed]
diff --git a/test/html/expect/test_package+ml/Stop_dead_link_doc/index.html b/test/html/expect/test_package+ml/Stop_dead_link_doc/index.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+  <title>
+   Stop_dead_link_doc (test_package+ml.Stop_dead_link_doc)
+  </title>
+  <link rel="stylesheet" href="../../odoc.css">
+  <meta charset="utf-8">
+  <meta name="generator" content="odoc %%VERSION%%">
+  <meta name="viewport" content="width=device-width,initial-scale=1.0">
+  <script src="../../highlight.pack.js"></script>
+  <script>
+   hljs.initHighlightingOnLoad();
+  </script>
+ </head>
+ <body>
+  <nav>
+   <a href="../index.html">Up</a> – <a href="../index.html">test_package+ml</a> » Stop_dead_link_doc
+  </nav>
+  <header>
+   <h1>
+    Module <code>Stop_dead_link_doc</code>
+   </h1>
+  </header>
+  <div class="content">
+   <div>
+    <div class="spec type" id="type-t_with_perm">
+     <a href="#type-t_with_perm" class="anchor"></a><code><span class="keyword">type</span> <span>('perm, 'record, 'field) t_with_perm</span> = </code>
+     <table>
+      <tbody>
+       <tr id="type-t_with_perm.Field" class="anchored">
+        <td class="def variant constructor">
+         <a href="#type-t_with_perm.Field" class="anchor"></a><code>| <span class="constructor">Field</span> <span class="keyword">of</span> <span><span>(<span class="type-var">'perm</span>,&nbsp;<span class="type-var">'record</span>,&nbsp;<span class="type-var">'field</span>)</span> <a href="For_generated_code/index.html#type-t">For_generated_code.t</a></span></code>
+        </td>
+       </tr>
+      </tbody>
+     </table>
+    </div>
+    <div>
+     <p>
+      <code>'record</code> is the type of the record. <code>'field</code> is the type of the values stored in the record field with name <code>name</code>. <code>'perm</code> is a way of restricting the operations that can be used.
+     </p>
+    </div>
+   </div>
+  </div>
+ </body>
+</html>
diff --git a/test/html/expect/test_package+re/Stop_dead_link_doc/index.html b/test/html/expect/test_package+re/Stop_dead_link_doc/index.html
@@ -0,0 +1,48 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+  <title>
+   Stop_dead_link_doc (test_package+re.Stop_dead_link_doc)
+  </title>
+  <link rel="stylesheet" href="../../odoc.css">
+  <meta charset="utf-8">
+  <meta name="generator" content="odoc %%VERSION%%">
+  <meta name="viewport" content="width=device-width,initial-scale=1.0">
+  <script src="../../highlight.pack.js"></script>
+  <script>
+   hljs.initHighlightingOnLoad();
+  </script>
+ </head>
+ <body>
+  <nav>
+   <a href="../index.html">Up</a> – <a href="../index.html">test_package+re</a> » Stop_dead_link_doc
+  </nav>
+  <header>
+   <h1>
+    Module <code>Stop_dead_link_doc</code>
+   </h1>
+  </header>
+  <div class="content">
+   <div>
+    <div class="spec type" id="type-t_with_perm">
+     <a href="#type-t_with_perm" class="anchor"></a><code><span class="keyword">type</span> t_with_perm('perm, 'record, 'field) = </code>
+     <table>
+      <tbody>
+       <tr id="type-t_with_perm.Field" class="anchored">
+        <td class="def variant constructor">
+         <a href="#type-t_with_perm.Field" class="anchor"></a><code>| <span class="constructor">Field</span>(<a href="For_generated_code/index.html#type-t">For_generated_code.t</a><span>(<span class="type-var">'perm</span>,&nbsp;<span class="type-var">'record</span>,&nbsp;<span class="type-var">'field</span>)</span>)</code>
+        </td>
+       </tr>
+      </tbody>
+     </table>
+     <code>;</code>
+    </div>
+    <div>
+     <p>
+      <code>'record</code> is the type of the record. <code>'field</code> is the type of the values stored in the record field with name <code>name</code>. <code>'perm</code> is a way of restricting the operations that can be used.
+     </p>
+    </div>
+   </div>
+  </div>
+ </body>
+</html>
diff --git a/test/html/test.ml b/test/html/test.ml
@@ -273,6 +273,7 @@ let source_files_all =
     ("functor.mli", [ "Functor/index.html" ]);
     ("class.mli", [ "Class/index.html" ]);
     ("stop.mli", [ "Stop/index.html" ]);
+    ("stop_dead_link_doc.mli", [ "Stop_dead_link_doc/index.html" ]);
     ("bugs.ml", [ "Bugs/index.html" ]);
     ("alias.ml", [ "Alias/index.html"; "Alias/X/index.html" ]);
   ]