aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorGaëtan Gilbert2018-12-18 10:53:31 +0100
committerGaëtan Gilbert2018-12-18 10:53:31 +0100
commit1199cbc1a45e378e41f4b159c4c62db598173716 (patch)
tree02d0b04a0b412c34bf0767ebcbc54a0fb3f6505c /lib
parentfb18cf6bf7d7142bf3fab3d7d811f2cecd527f12 (diff)
Add comment to acyclicgraph API
Diffstat (limited to 'lib')
-rw-r--r--lib/acyclicGraph.mli5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/acyclicGraph.mli b/lib/acyclicGraph.mli
index 13a12b51cd..b53a4c018f 100644
--- a/lib/acyclicGraph.mli
+++ b/lib/acyclicGraph.mli
@@ -39,10 +39,13 @@ module Make (Point:Point) : sig
exception AlreadyDeclared
val add : ?rank:int -> Point.t -> t -> t
- (** Use a large [rank] to keep the node canonical *)
+ (** All points must be pre-declared through this function before
+ they can be mentioned in the others. NB: use a large [rank] to
+ keep the node canonical *)
exception Undeclared of Point.t
val check_declared : t -> Point.Set.t -> unit
+ (** @raise Undeclared if one of the points is not present in the graph. *)
type 'a check_function = t -> 'a -> 'a -> bool