aboutsummaryrefslogtreecommitdiff
path: root/vernac/search.mli
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 /vernac/search.mli
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 'vernac/search.mli')
-rw-r--r--vernac/search.mli10
1 files changed, 5 insertions, 5 deletions
diff --git a/vernac/search.mli b/vernac/search.mli
index 0dc82c1c3f..ecbb02bc68 100644
--- a/vernac/search.mli
+++ b/vernac/search.mli
@@ -49,16 +49,16 @@ val search_about : int option -> (bool * glob_search_about_item) list
-> DirPath.t list * bool -> display_function -> unit
type search_constraint =
- (** Whether the name satisfies a regexp (uses Ocaml Str syntax) *)
| Name_Pattern of Str.regexp
- (** Whether the object type satisfies a pattern *)
+ (** Whether the name satisfies a regexp (uses Ocaml Str syntax) *)
| Type_Pattern of Pattern.constr_pattern
- (** Whether some subtype of object type satisfies a pattern *)
+ (** Whether the object type satisfies a pattern *)
| SubType_Pattern of Pattern.constr_pattern
- (** Whether the object pertains to a module *)
+ (** Whether some subtype of object type satisfies a pattern *)
| In_Module of Names.DirPath.t
- (** Bypass the Search blacklist *)
+ (** Whether the object pertains to a module *)
| Include_Blacklist
+ (** Bypass the Search blacklist *)
type 'a coq_object = {
coq_object_prefix : string list;