Use ocamldoc references in ArrayDomain.Str

goblint · Nov 29, 2023 · 44705f4 · 44705f4
1 parent 309f000
commit 44705f4
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/cdomains/arrayDomain.mli b/src/cdomains/arrayDomain.mli
@@ -93,9 +93,9 @@ sig
     * [s2] if present *)
 
   val substring_extraction: t -> t -> substr
-  (** [substring_extraction haystack needle] returns [IsNotSubstr] if the string represented by
-    * the abstract value [needle] surely isn't a substring of [haystack], [IsSubstrAtIndex0] if
-    * [needle] is the empty string, else [Unknown] *)
+  (** [substring_extraction haystack needle] returns {!IsNotSubstr} if the string represented by
+    * the abstract value [needle] surely isn't a substring of [haystack], {!IsSubstrAtIndex0} if
+    * [needle] is the empty string, else {!IsMaybeSubstr} *)
 
   val string_comparison: t -> t -> int option -> idx
   (** [string_comparison s1 s2 n] returns a negative / positive idx element if the string