aboutsummaryrefslogtreecommitdiff
path: root/ide/protocol/interface.ml
diff options
context:
space:
mode:
authorEmilio Jesus Gallego Arias2018-12-06 04:44:27 +0100
committerEmilio Jesus Gallego Arias2018-12-09 02:54:02 +0100
commitd00472c59d15259b486868c5ccdb50b6e602a548 (patch)
tree008d862e4308ac8ed94cfbcd94ac26c739b89642 /ide/protocol/interface.ml
parentfa20a54d9fbe0f3872614a592fcef7ef56b05e49 (diff)
[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 :)
Diffstat (limited to 'ide/protocol/interface.ml')
-rw-r--r--ide/protocol/interface.ml14
1 files changed, 9 insertions, 5 deletions
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. *)