From b2658b000132b29d7bba8b833e0347f895d147ad Mon Sep 17 00:00:00 2001 From: David Sancho Moreno Date: Mon, 4 Mar 2024 18:22:53 +0100 Subject: [PATCH] Set docs --- lib/RegExp.mli | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/RegExp.mli b/lib/RegExp.mli index 0b7e0707..dcf1bedc 100644 --- a/lib/RegExp.mli +++ b/lib/RegExp.mli @@ -1,53 +1,53 @@ type t -(* The RegExp object *) +(** The RegExp object *) type result -(* The result of a executing a RegExp on a string *) +(** The result of a executing a RegExp on a string *) val compile : string -> string -> t -(* Constructs a RegExp.t from a string describing a regex and their flags *) +(** Constructs a RegExp.t from a string describing a regex and their flags *) val lastIndex : t -> int -(* returns the index where the next match will start its search *) +(** returns the index where the next match will start its search *) val setLastIndex : t -> int -> unit -(* sets the index at which the next match (RegExp.exec or RegExp.test) will start its search from *) +(** sets the index at which the next match (RegExp.exec or RegExp.test) will start its search from *) val flags : t -> string -(* returns the enabled flags as a string *) +(** returns the enabled flags as a string *) val global : t -> bool -(* returns a bool indicating whether the global flag (g) is set *) +(** returns a bool indicating whether the global flag (g) is set *) val ignorecase : t -> bool -(* returns a bool indicating whether the ignorecase (i) flag is set *) +(** returns a bool indicating whether the ignorecase (i) flag is set *) val multiline : t -> bool -(* returns a bool indicating whether the multiline (m) flag is set *) +(** returns a bool indicating whether the multiline (m) flag is set *) val dotall : t -> bool -(* returns a bool indicating whether the dot all (s) flag is set *) +(** returns a bool indicating whether the dot all (s) flag is set *) val sticky : t -> bool -(* returns a bool indicating whether the sticky (y) flag is set *) +(** returns a bool indicating whether the sticky (y) flag is set *) val unicode : t -> bool -(* returns a bool indicating whether the unicode (u ) flag is set *) +(** returns a bool indicating whether the unicode (u ) flag is set *) val source : t -> string -(* returns the regexp pattern as a string *) +(** returns the regexp pattern as a string *) val test : t -> string -> bool -(* checks whether the given RegExp.t will match (or not match) a given string *) +(** checks whether the given RegExp.t will match (or not match) a given string *) val exec : t -> string -> result -(* executes a search on a given string using the given RegExp.t *) +(** executes a search on a given string using the given RegExp.t *) val captures : result -> string array -(* an array of the match and captures *) +(** an array of the match and captures *) val input : result -> string -(* the original input string *) +(** the original input string *) val index : result -> int -(* sets the index at which the next match (RegExp.exec or RegExp.test) will start its search from *) +(** sets the index at which the next match (RegExp.exec or RegExp.test) will start its search from *)