Link to Ocamlary from index of pages

and add an example of comments associated to polymorphic variants Signed-off-by: Paul-Elliot <[email protected]>
ocaml · Jul 5, 2023 · 17e133c · 17e133c
1 parent 745ba87
commit 17e133c
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 3 deletions.
diff --git a/doc/driver.mld b/doc/driver.mld
@@ -269,7 +269,7 @@ let dep_libraries =
 let odoc_libraries = [
     "odoc_xref_test"; "odoc_xref2"; "odoc_odoc"; "odoc_html_support_files";
     "odoc_model_desc"; "odoc_model"; "odoc_manpage"; "odoc_loader";
-    "odoc_latex"; "odoc_html"; "odoc_document"; "odoc_examples" ];;
+    "odoc_latex"; "odoc_html"; "odoc_document"; "odoc_examples"; "ocamlary" ];;
 
 let all_libraries = dep_libraries @ odoc_libraries;;
 

diff --git a/doc/library_mlds/dune b/doc/library_mlds/dune
@@ -11,4 +11,5 @@
   odoc_model_desc
   odoc_odoc
   odoc_xref2
-  odoc_xref_test))
+  odoc_xref_test
+  ocamlary))
diff --git a/doc/library_mlds/ocamlary.mld b/doc/library_mlds/ocamlary.mld
@@ -0,0 +1,3 @@
+{0 Ocamlary}
+
+A demonstration of the rendering of most of the OCaml constructs {!module-Ocamlary}.
diff --git a/doc/odoc.mld b/doc/odoc.mld
@@ -53,4 +53,5 @@ The main other pages of this site:
 - {!page-dune} Dune
 - {!page-parent_child_spec} Parent/Child specification
 - {!page-interface} Interface guarantees
+- {!page-ocamlary} A demonstration of the rendering of most of the OCaml constructs
 
diff --git a/src/ocamlary/ocamlary.mli b/src/ocamlary/ocamlary.mli
@@ -430,7 +430,9 @@ type variant =
 (** This comment is also for [variant]. *)
 
 (** This comment is for [poly_variant]. *)
-type poly_variant = [ `TagA | `ConstrB of int ]
+type poly_variant =
+  [ `TagA  (** This is a comment for [`TagA] *)
+  | `ConstrB of int  (** This is a comment for [`ConstrB] *) ]
 (** Wow! It was a polymorphic variant! *)
 
 (** This comment is for [full_gadt]. *)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		{0 Ocamlary}

		A demonstration of the rendering of most of the OCaml constructs {!module-Ocamlary}.