summaryrefslogtreecommitdiffstats
path: root/stdlib/char.mli
diff options
context:
space:
mode:
authorMaxence Guesdon <maxence.guesdon@inria.fr>2001-10-26 22:37:14 +0000
committerMaxence Guesdon <maxence.guesdon@inria.fr>2001-10-26 22:37:14 +0000
commita692df441cf8fd5690f41fe38ae94151337b4ebe (patch)
tree28005419623633ab88e4a580aba2d29531d97e96 /stdlib/char.mli
parent91f3863d3ef863133bd888932f157a1ef254d969 (diff)
Modification emplacement et syntaxe des commentaires pour OCamldoc
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@3924 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/char.mli')
-rw-r--r--stdlib/char.mli27
1 files changed, 16 insertions, 11 deletions
diff --git a/stdlib/char.mli b/stdlib/char.mli
index 9e9a445fa..26bf85483 100644
--- a/stdlib/char.mli
+++ b/stdlib/char.mli
@@ -12,22 +12,27 @@
(* $Id$ *)
-(* Module [Char]: character operations *)
+(** Character operations. *)
+(** Return the ASCII code of the argument. *)
external code : char -> int = "%identity"
- (* Return the ASCII code of the argument. *)
+
+(** Return the character with the given ASCII code.
+ Raise [Invalid_argument "Char.chr"] if the argument is
+ outside the range 0--255. *)
val chr: int -> char
- (* Return the character with the given ASCII code.
- Raise [Invalid_argument "Char.chr"] if the argument is
- outside the range 0--255. *)
+
+(** Return a string representing the given character,
+ with special characters escaped following the lexical conventions
+ of Objective Caml. *)
val escaped : char -> string
- (* Return a string representing the given character,
- with special characters escaped following the lexical conventions
- of Objective Caml. *)
+
+(** Convert the given character to its equivalent lowercase character. *)
val lowercase: char -> char
+
+(** Convert the given character to its equivalent uppercase character. *)
val uppercase: char -> char
- (* Convert the given character to its equivalent lowercase or
- uppercase character, respectively. *)
-(*--*)
+
+(*-*)
external unsafe_chr: int -> char = "%identity"