Merge pull request #296 from MisterDA/odoc-type-annot

Add `{!type:…}` annot in docs to help odoc with ambiguities
ahrefs · May 24, 2022 · 65a4534 · 65a4534
2 parents 242e3ec + 0dd0610
commit 65a4534
Show file tree

Hide file tree

Showing 14 changed files with 896 additions and 891 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,8 @@
+Next release
+------------------
+
+* atdgen: use odoc syntax to disambiguate clashing names (#296).
+
 2.7.0 (2022-05-17)
 ------------------
 

diff --git a/atdgen/src/ob_emit.ml b/atdgen/src/ob_emit.ml
@@ -56,21 +56,21 @@ val %s_tag : Bi_io.node_tag
     bprintf buf "\
 val write_untagged_%s :%s
   Bi_outbuf.t -> %s -> unit
-  (** Output an untagged biniou value of type {!%s}. *)
+  (** Output an untagged biniou value of type {!type:%s}. *)
 
 " x.def_name writer_params full_name x.def_name;
 
     bprintf buf "\
 val write_%s :%s
   Bi_outbuf.t -> %s -> unit
-  (** Output a biniou value of type {!%s}. *)
+  (** Output a biniou value of type {!type:%s}. *)
 
 " x.def_name writer_params full_name x.def_name;
 
     bprintf buf "\
 val string_of_%s :%s
   ?len:int -> %s -> string
-  (** Serialize a value of type {!%s} into
+  (** Serialize a value of type {!type:%s} into
       a biniou string. *)
 
 " x.def_name writer_params full_name x.def_name;
@@ -81,21 +81,21 @@ val string_of_%s :%s
 val get_%s_reader :%s
   Bi_io.node_tag -> (Bi_inbuf.t -> %s)
   (** Return a function that reads an untagged
-      biniou value of type {!%s}. *)
+      biniou value of type {!type:%s}. *)
 
 " x.def_name reader_params full_name x.def_name;
 
     bprintf buf "\
 val read_%s :%s
   Bi_inbuf.t -> %s
-  (** Input a tagged biniou value of type {!%s}. *)
+  (** Input a tagged biniou value of type {!type:%s}. *)
 
 " x.def_name reader_params full_name x.def_name;
 
     bprintf buf "\
 val %s_of_string :%s
   ?pos:int -> string -> %s
-  (** Deserialize a biniou value of type {!%s}.
+  (** Deserialize a biniou value of type {!type:%s}.
       @param pos specifies the position where
                  reading starts. Default: 0. *)
 

diff --git a/atdgen/src/oj_emit.ml b/atdgen/src/oj_emit.ml
@@ -59,7 +59,7 @@ let make_ocaml_json_intf ~with_create buf deref defs =
     bprintf buf "\
 val write_%s :%s
   Bi_outbuf.t -> %s -> unit
-  (** Output a JSON value of type {!%s}. *)
+  (** Output a JSON value of type {!type:%s}. *)
 
 "
       s writer_params
@@ -69,7 +69,7 @@ val write_%s :%s
     bprintf buf "\
 val string_of_%s :%s
   ?len:int -> %s -> string
-  (** Serialize a value of type {!%s}
+  (** Serialize a value of type {!type:%s}
       into a JSON string.
       @param len specifies the initial length
                  of the buffer used internally.
@@ -83,7 +83,7 @@ val string_of_%s :%s
     bprintf buf "\
 val read_%s :%s
   Yojson.Safe.lexer_state -> Lexing.lexbuf -> %s
-  (** Input JSON data of type {!%s}. *)
+  (** Input JSON data of type {!type:%s}. *)
 
 "
       s reader_params
@@ -93,7 +93,7 @@ val read_%s :%s
     bprintf buf "\
 val %s_of_string :%s
   string -> %s
-  (** Deserialize JSON data of type {!%s}. *)
+  (** Deserialize JSON data of type {!type:%s}. *)
 
 "
       s reader_params

diff --git a/atdgen/src/ov_emit.ml b/atdgen/src/ov_emit.ml
@@ -37,7 +37,7 @@ let make_ocaml_validate_intf ~with_create buf deref defs =
       bprintf buf "\
 val validate_%s :%s
   Atdgen_runtime.Util.Validation.path -> %s -> Atdgen_runtime.Util.Validation.error option
-  (** Validate a value of type {!%s}. *)
+  (** Validate a value of type {!type:%s}. *)
 
 "
         s validator_params

diff --git a/atdgen/src/ox_emit.ml b/atdgen/src/ox_emit.ml
@@ -263,7 +263,7 @@ let make_record_creator deref x =
         sprintf "\
 val create_%s :%s
   unit -> %s
-  (** Create a record of type {!%s}. *)
+  (** Create a record of type {!type:%s}. *)
 
 "
           s (String.concat "" intf_params)