Refactor the Ata module:
[tatoo.git] / src / tree.ml
index e06a11e..d44755e 100644 (file)
 (*                                                                     *)
 (***********************************************************************)
 
-(*
-  Time-stamp: <Last modified on 2013-04-22 16:29:52 CEST by Kim Nguyen>
-*)
-
 (** The different kind of XML nodes and utility functions *)
 
 module NodeKind =
@@ -108,9 +104,8 @@ sig
   (** Returns the kind of the given node *)
 
   val preorder : t -> node -> int
-  (** Returns the position of a node in pre-order in the tree. The
-    root has preorder 0. [nil] has pre-order [-1].
+  (** [preorder t n] returns the pre-order position of [n] in [t].
+      [preodrder t (root t) == 0] and [preorder t nil < 0].
   *)
-
   val print_node : Format.formatter -> node -> unit
 end