From d00472c59d15259b486868c5ccdb50b6e602a548 Mon Sep 17 00:00:00 2001
From: Emilio Jesus Gallego Arias
Date: Thu, 6 Dec 2018 04:44:27 +0100
Subject: [doc] Enable Warning 50 [incorrect doc comment] and fix comments.

This is a pre-requisite to use automated formatting tools such as
`ocamlformat`, also, there were quite a few places where the comments
had basically no effect, thus it was confusing for the developer.

p.s: Reading some comments was a lot of fun :)
---
 lib/control.ml | 6 +++---
 lib/system.mli | 1 +
 2 files changed, 4 insertions(+), 3 deletions(-)

(limited to 'lib')

diff --git a/lib/control.ml b/lib/control.ml
index 3fbeb168c4..e09068740d 100644
--- a/lib/control.ml
+++ b/lib/control.ml
@@ -62,8 +62,8 @@ let windows_timeout n f x e =
     let res = f x in
     let () = killed := true in
     let cur = Unix.gettimeofday () in
-    (** The thread did not interrupt, but the computation took longer than
-        expected. *)
+    (* The thread did not interrupt, but the computation took longer than
+       expected. *)
     let () = if float_of_int n <= cur -. init then begin
       exited := true;
       raise Sys.Break
@@ -71,7 +71,7 @@ let windows_timeout n f x e =
     res
   with
   | Sys.Break ->
-    (** Just in case, it could be a regular Ctrl+C *)
+    (* Just in case, it could be a regular Ctrl+C *)
     if not !exited then begin killed := true; raise Sys.Break end
     else raise e
   | e ->
diff --git a/lib/system.mli b/lib/system.mli
index f13fd30923..a3b79ee528 100644
--- a/lib/system.mli
+++ b/lib/system.mli
@@ -102,6 +102,7 @@ type time
 
 val get_time : unit -> time
 val time_difference : time -> time -> float (** in seconds *)
+
 val fmt_time_difference : time -> time -> Pp.t
 
 val with_time : batch:bool -> ('a -> 'b) -> 'a -> 'b
-- 
cgit v1.2.3