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 :)
---
 ide/protocol/interface.ml | 14 +++++++++-----
 ide/protocol/richpp.ml    | 10 +++++-----
 2 files changed, 14 insertions(+), 10 deletions(-)

(limited to 'ide/protocol')

diff --git a/ide/protocol/interface.ml b/ide/protocol/interface.ml
index debbc8301e..ccb6bedaf6 100644
--- a/ide/protocol/interface.ml
+++ b/ide/protocol/interface.ml
@@ -78,16 +78,20 @@ type option_state = {
 }
 
 type search_constraint =
-(** Whether the name satisfies a regexp (uses Ocaml Str syntax) *)
 | Name_Pattern of string
-(** Whether the object type satisfies a pattern *)
+(** Whether the name satisfies a regexp (uses Ocaml Str syntax) *)
+
 | Type_Pattern of string
-(** Whether some subtype of object type satisfies a pattern *)
+(** Whether the object type satisfies a pattern *)
+
 | SubType_Pattern of string
-(** Whether the object pertains to a module *)
+(** Whether some subtype of object type satisfies a pattern *)
+
 | In_Module of string list
-(** Bypass the Search blacklist *)
+(** Whether the object pertains to a module *)
+
 | Include_Blacklist
+(** Bypass the Search blacklist *)
 
 (** A list of search constraints; the boolean flag is set to [false] whenever
     the flag should be negated. *)
diff --git a/ide/protocol/richpp.ml b/ide/protocol/richpp.ml
index 19e9799c19..b2ce55e89a 100644
--- a/ide/protocol/richpp.ml
+++ b/ide/protocol/richpp.ml
@@ -46,7 +46,7 @@ let rich_pp width ppcmds =
   let pp_buffer = Buffer.create 180 in
 
   let push_pcdata () =
-    (** Push the optional PCData on the above node *)
+    (* Push the optional PCData on the above node *)
     let len = Buffer.length pp_buffer in
     if len = 0 then ()
     else match context.stack with
@@ -77,7 +77,7 @@ let rich_pp width ppcmds =
       let xml = Element (node, annotation, List.rev child) in
       match ctx with
       | Leaf ->
-        (** Final node: we keep the result in a dummy context *)
+        (* Final node: we keep the result in a dummy context *)
         context.stack <- Node ("", [xml], 0, Leaf)
       | Node (node, child, pos, ctx) ->
         context.stack <- Node (node, xml :: child, pos, ctx)
@@ -104,15 +104,15 @@ let rich_pp width ppcmds =
   pp_set_max_boxes ft 50 ;
   pp_set_ellipsis_text ft "...";
 
-  (** The whole output must be a valid document. To that
-      end, we nest the document inside <pp> tags. *)
+  (* The whole output must be a valid document. To that
+     end, we nest the document inside <pp> tags. *)
   pp_open_box ft 0;
   pp_open_tag ft "pp";
   Pp.(pp_with ft ppcmds);
   pp_close_tag ft ();
   pp_close_box ft ();
 
-  (** Get the resulting XML tree. *)
+  (* Get the resulting XML tree. *)
   let () = pp_print_flush ft () in
   let () = assert (Buffer.length pp_buffer = 0) in
   match context.stack with
-- 
cgit v1.2.3