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 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

(limited to 'ide/protocol/interface.ml')

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. *)
-- 
cgit v1.2.3