chore: polishing documentation

Signed-off-by: Kakadu <[email protected]>

review/diff_parser.mli

@@ -1,12 +1,16 @@
-(** Copyright 2021-2023, Kakadu. *)
+[@@@ocaml.text "/*"]
+
+(** Copyright 2021-2024, Kakadu. *)
 
 (** SPDX-License-Identifier: LGPL-3.0-or-later *)
 
+[@@@ocaml.text "/*"]
+
 (** Parser of the diff file. The grammar is similar too
 
     diff ::= ( head chunk* )*
 
-    See also [file_head] and [a_chunk]. *)
+    See also {!file_head} and {!a_chunk}. *)
 val parse_whole_file : Types.file_info list Angstrom.t
 
 (** Main entry point. Uses [parse_whole_file] under the hood *)

review/line_parser.mli

@@ -1,7 +1,11 @@
-(** Copyright 2021-2024, Kakadu and contributors *)
+[@@@ocaml.text "/*"]
+
+(** Copyright 2021-2024, Kakadu. *)
 
 (** SPDX-License-Identifier: LGPL-3.0-or-later *)
 
+[@@@ocaml.text "/*"]
+
 (** [run ?info p] trims line break in the input string and runs parser [p]. *)
 val run : ?info:string -> 'a Angstrom.t -> 'a Angstrom.t
 

review/types.ml

@@ -1,7 +1,11 @@
-(** Copyright 2021-2023, Kakadu. *)
+[@@@ocaml.text "/*"]
+
+(** Copyright 2021-2024, Kakadu. *)
 
 (** SPDX-License-Identifier: LGPL-3.0-or-later *)
 
+[@@@ocaml.text "/*"]
+
 type chunk_info =
   { old : int
   ; old_range : int

src/Collected_decls.ml

@@ -1,22 +1,6 @@
-[@@@ocaml.text "/*"]
-
-(** Copyright 2021-2024, Kakadu. *)
-
-(** SPDX-License-Identifier: LGPL-3.0-or-later *)
-
-[@@@ocaml.text "/*"]
-
 open Utils
 module StringSet = Set.Make (String)
 
-(** Sonmething like Hastbl is needed **)
-
-(* let rec print_path = function
-  | Path.Pident ident -> "<ident>(" ^ Ident.unique_toplevel_name ident ^ ")"
-  | Path.Pdot (lhs, rhs) -> "<arrow>(" ^ print_path lhs ^ " -> " ^ rhs ^ ")"
-  | Path.Papply (lhs, rhs) -> "<apply>(" ^ print_path lhs ^ " @ " ^ print_path rhs ^ ")"
-;; *)
-
 let all_decls = Hashtbl.create 100
 let used_decls = Hashtbl.create 100
 

src/Collected_decls.mli

@@ -1,6 +1,15 @@
 (** Global storage for defined names. Is used to detect public but not used library fields.
 
-    Mutable. Not thread safe. *)
+    Mutable. Not thread safe.
+    See also {!Unused_ML_logger} *)
+
+[@@@ocaml.text "/*"]
+
+(** Copyright 2021-2024, Kakadu. *)
+
+(** SPDX-License-Identifier: LGPL-3.0-or-later *)
+
+[@@@ocaml.text "/*"]
 
 (** Report definition of a value. Usually is called from signature analyzer. *)
 val add_just_decl : string -> unit