[MLton-commit] r4735

[Vesa K. <ve...@ml...>]

Documented.
----------------------------------------------------------------------

U   mltonlib/trunk/com/ssh/extended-basis/unstable/char.sig

----------------------------------------------------------------------

Modified: mltonlib/trunk/com/ssh/extended-basis/unstable/char.sig
===================================================================
--- mltonlib/trunk/com/ssh/extended-basis/unstable/char.sig	2006-10-20 15:25:54 UTC (rev 4734)
+++ mltonlib/trunk/com/ssh/extended-basis/unstable/char.sig	2006-10-20 15:27:21 UTC (rev 4735)
@@ -7,12 +7,31 @@
 (**
  * Extended {CHAR} signature.
  *)
-
 signature CHAR =
    sig
       include CHAR
+
       val intIso : (char, Int.int) iso
+      (**
+       * The isomorphism between characters and character codes.  It
+       * always equals {(ord, chr)}.  Note that the projection part of the
+       * isomorphism, namely {chr}, is likely to be a partial function.
+       *)
+
+      val boundsChar : char * char
+      (**
+       * Pair of the least and greatest characters.  It always equals
+       * {(minChar, maxChar)}.
+       *)
+
       val minOrd : Int.int
-      val boundsChar : char * char
+      (**
+       * The least character code.  It always equals {0}.
+       *)
+
       val boundsOrd : Int.int * Int.int
+      (**
+       * Pair of the least and greatest character codes.  It always equals
+       * {(minOrd, maxOrd)}.
+       *)
    end