[alias] adapt comments for better odoc rendering

src/plugins/alias/src/API.mli

@@ -179,14 +179,14 @@ module Abstract_state : sig
   val get_vars : v -> t -> VarSet.t
 
   (** set of lvals which can be used to refered to the given vertex
-      Example graph: {a} → {b} -t→ {c}
-      The lvals corresponding to the rightmost vertex are {c, b.t, a->t}:
+      Example graph: <a> → <b> -t→ <c>
+      The lvals corresponding to the rightmost vertex are <c, b.t, a->t>:
       - c:    simply refers to a variable associated with the vertex.
       - b.t:  starting from the second vertex one can follow a field-edge
-              labelled "t" to come upon the rightmost vertex.
+              labelled [t] to come upon the rightmost vertex.
       - a->t: Following a pointer edge from the leftmost vertex one obtains
-              "*a". Following the "t" field-edge one arrives at the rightmost
-              vertex, corresponding to "( *a ).t" or "a->t". *)
+              [*a]. Following the [t] field-edge one arrives at the rightmost
+              vertex, corresponding to [( *a ).t] or [a->t]. *)
   val get_lval_set : v -> t -> LSet.t
 
   (** pretty printer; debug=true prints the graph, debug = false only
@@ -209,9 +209,9 @@ module Abstract_state : sig
   (** Note: You probably want to use [alias_lvals] instead of this function.
       Combining [find_vertex] with [get_lval_set], this function yields all the
       different ways the vertex containing the given lval can be referred to.
-      Example: {a} → {b,c}
-      If "a" points to "b", then the vertex containing "b" can be referred to not
-      only by "b" but also by "c" or "*a".
+      Example: <a> → <b,c>
+      If [a] points to [b], then the vertex containing [b] can be referred to not
+      only by [b] but also by [c] or [*a].
       Does not raise an exception but returns an empty set if the lval is not in
       the graph. *)
   val find_synonyms : lval -> t -> LSet.t
@@ -221,10 +221,10 @@ module Abstract_state : sig
       - variables from a neighbouring vertex, i.e. a vertex that shares a
         successor with the vertex of [lv].
 
-      Example: {a,b} → {c} ← {d} ← {e}
-      The aliases of "a" are {a,b,d}:
-      - "b" shares a vertex with "a"
-      - "d" is in a neighbouring vertex, pointing to "c" as does {a,b} *)
+      Example: <a,b> → <c> ← <d> ← <e>
+      The aliases of [a] are <a,b,d>:
+      - [b] shares a vertex with [a]
+      - [d] is in a neighbouring vertex, pointing to [c] as does <a,b> *)
   val alias_vars : lval -> t -> VarSet.t
 
   val find_aliases : lval -> t -> LSet.t
@@ -236,11 +236,11 @@ module Abstract_state : sig
         successor with the vertex of [lv].
       - lvals reconstructed from the variables from the two previous sets.
 
-      Example: {a,b} → {c} ← {d} ← {e}
-      The aliases of "a" are {a,b,d,*e}:
-      - "b" shares a vertex with "a"
-      - "d" is in a neighbouring vertex, as it shares a successor with {a,b}
-      - *e is obtained by following backwards the pointer edge from {d} to {e}. *)
+      Example: <a,b> → <c> ← <d> ← <e>
+      The aliases of [a] are <a,b,d,*e>:
+      - [b] shares a vertex with [a]
+      - [d] is in a neighbouring vertex, as it shares a successor with <a,b>
+      - [*e] is obtained by following backwards the pointer edge from <d> to <e>. *)
   val alias_lvals : lval -> t -> LSet.t
 
   val find_all_aliases : lval -> t -> LSet.t
@@ -258,14 +258,14 @@ module Abstract_state : sig
   [@@alert deprecated "Use points_to_vars or points_to_lvals instead!"]
 
   (** all the alias sets of a given state
-      Example: {a,b} → {c} ← {d} ← {e,f}
-      The aliases sets are {{a,b,d}, {e,f}}
+      Example: <a,b> → <c> ← <d> ← <e,f>
+      The aliases sets are <<a,b,d>, <e,f>>
   *)
   val alias_sets_vars : t -> VarSet.t list
 
   (** all the alias sets of a given state, including reconstructed lvals
-      Example: {a,b} → {c} ← {d} ← {e,f}
-      The aliases sets are {{a,b,d,*e,*f}, {e,f}}
+      Example: <a,b> → <c> ← <d> ← <e,f>
+      The aliases sets are <<a,b,d,*e,*f>, <e,f>>
   *)
   val alias_sets_lvals : t -> LSet.t list