Use Hemlock doc attributes rather than OCaml doc strings

BranchTaken · Aug 1, 2024 · 79c012d · 79c012d
1 parent ec91c69
commit 79c012d
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 36 deletions.
diff --git a/bootstrap/bin/hocc/spec.ml b/bootstrap/bin/hocc/spec.ml
@@ -1959,10 +1959,10 @@ let hmi_template = {|{
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1 [@doc "LR(1) algorithm."]
+              | Ielr1 [@doc "IELR(1) algorithm."]
+              | Pgm1 [@doc "PGM(1) algorithm."]
+              | Lalr1 [@doc "LALR(1) algorithm."]
 
             pp >e: t -> Fmt.Formatter e >e-> Fmt.Formatter e
           }
@@ -2445,10 +2445,10 @@ let hm_template = {|{
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1
+              | Ielr1
+              | Pgm1
+              | Lalr1
 
             to_string = function
               | Lr1 -> "Lr1"

diff --git a/bootstrap/test/hocc/Example.expected.hm b/bootstrap/test/hocc/Example.expected.hm
@@ -6,10 +6,10 @@ include [:]{
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1
+              | Ielr1
+              | Pgm1
+              | Lalr1
 
             to_string = function
               | Lr1 -> "Lr1"

diff --git a/bootstrap/test/hocc/Example.expected.hmi b/bootstrap/test/hocc/Example.expected.hmi
@@ -7,10 +7,10 @@ include [:]{
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1 [@doc "LR(1) algorithm."]
+              | Ielr1 [@doc "IELR(1) algorithm."]
+              | Pgm1 [@doc "PGM(1) algorithm."]
+              | Lalr1 [@doc "LALR(1) algorithm."]
 
             pp >e: t -> Fmt.Formatter e >e-> Fmt.Formatter e
           }

diff --git a/bootstrap/test/hocc/Example_b.expected.hm b/bootstrap/test/hocc/Example_b.expected.hm
@@ -7,10 +7,10 @@ include
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1
+              | Ielr1
+              | Pgm1
+              | Lalr1
 
             to_string = function
               | Lr1 -> "Lr1"

diff --git a/bootstrap/test/hocc/Example_b.expected.hmi b/bootstrap/test/hocc/Example_b.expected.hmi
@@ -7,10 +7,10 @@ include
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1 [@doc "LR(1) algorithm."]
+              | Ielr1 [@doc "IELR(1) algorithm."]
+              | Pgm1 [@doc "PGM(1) algorithm."]
+              | Lalr1 [@doc "LALR(1) algorithm."]
 
             pp >e: t -> Fmt.Formatter e >e-> Fmt.Formatter e
           }

diff --git a/bootstrap/test/hocc/Example_c.expected.hm b/bootstrap/test/hocc/Example_c.expected.hm
@@ -7,10 +7,10 @@ Parser = {
         Spec = {
             Algorithm = {
                 type t: t =
-                  | Lr1 (** LR(1) algorithm. *)
-                  | Ielr1 (** IELR(1) algorithm. *)
-                  | Pgm1 (** PGM(1) algorithm. *)
-                  | Lalr1 (** LALR(1) algorithm. *)
+                  | Lr1
+                  | Ielr1
+                  | Pgm1
+                  | Lalr1
 
                 to_string = function
                   | Lr1 -> "Lr1"

diff --git a/bootstrap/test/hocc/Example_c.expected.hmi b/bootstrap/test/hocc/Example_c.expected.hmi
@@ -7,10 +7,10 @@ Parser = {
         Spec = {
             Algorithm = {
                 type t: t =
-                  | Lr1 (** LR(1) algorithm. *)
-                  | Ielr1 (** IELR(1) algorithm. *)
-                  | Pgm1 (** PGM(1) algorithm. *)
-                  | Lalr1 (** LALR(1) algorithm. *)
+                  | Lr1 [@doc "LR(1) algorithm."]
+                  | Ielr1 [@doc "IELR(1) algorithm."]
+                  | Pgm1 [@doc "PGM(1) algorithm."]
+                  | Lalr1 [@doc "LALR(1) algorithm."]
 
                 pp >e: t -> Fmt.Formatter e >e-> Fmt.Formatter e
               }

diff --git a/doc/tools/hocc.md b/doc/tools/hocc.md
@@ -538,10 +538,10 @@ parser states can be used as persistent reusable snapshots.
     Spec = {
         Algorithm = {
             type t: t =
-              | Lr1 (** LR(1) algorithm. *)
-              | Ielr1 (** IELR(1) algorithm. *)
-              | Pgm1 (** PGM(1) algorithm. *)
-              | Lalr1 (** LALR(1) algorithm. *)
+              | Lr1 [@doc "LR(1) algorithm."]
+              | Ielr1 [@doc "IELR(1) algorithm."]
+              | Pgm1 [@doc "PGM(1) algorithm."]
+              | Lalr1 [@doc "LALR(1) algorithm."]
 
             pp >e: t -> Fmt.Formatter e >e-> Fmt.Formatter e
           }