summaryrefslogtreecommitdiff
path: root/stdlib/sort.mli
diff options
context:
space:
mode:
authorMaxence Guesdon <maxence.guesdon@inria.fr>2001-10-26 23:33:00 +0000
committerMaxence Guesdon <maxence.guesdon@inria.fr>2001-10-26 23:33:00 +0000
commit241f51d429e092c2a7f33154b237680381b427de (patch)
tree4cd535e62526428b4e5a7ea132feb80a45da9a12 /stdlib/sort.mli
parentb95796f46183761597e00edfaa495134f75a2559 (diff)
downloadocaml-241f51d429e092c2a7f33154b237680381b427de.tar.gz
Modification emplacements et syntaxe commentaires pour OCamldoc.
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@3927 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/sort.mli')
-rw-r--r--stdlib/sort.mli33
1 files changed, 17 insertions, 16 deletions
diff --git a/stdlib/sort.mli b/stdlib/sort.mli
index ce137b8bb0..1b7797fce6 100644
--- a/stdlib/sort.mli
+++ b/stdlib/sort.mli
@@ -12,28 +12,29 @@
(* $Id$ *)
-(* Module [Sort]: sorting and merging lists *)
+(** Sorting and merging lists.
-(* This module is obsolete and exists only for backward compatibility.
- The sorting functions in [Array] and [List] should be used instead.
+ @deprecated This module is obsolete and exists only for backward compatibility.
+ The sorting functions in {!Array} and {!List} should be used instead.
The new functions are faster and use less memory.
*)
+(** Sort a list in increasing order according to an ordering predicate.
+ The predicate should return [true] if its first argument is
+ less than or equal to its second argument. *)
val list : ('a -> 'a -> bool) -> 'a list -> 'a list
- (* Sort a list in increasing order according to an ordering predicate.
- The predicate should return [true] if its first argument is
- less than or equal to its second argument. *)
+(** Sort an array in increasing order according to an
+ ordering predicate.
+ The predicate should return [true] if its first argument is
+ less than or equal to its second argument.
+ The array is sorted in place. *)
val array : ('a -> 'a -> bool) -> 'a array -> unit
- (* Sort an array in increasing order according to an
- ordering predicate.
- The predicate should return [true] if its first argument is
- less than or equal to its second argument.
- The array is sorted in place. *)
+(** Merge two lists according to the given predicate.
+ Assuming the two argument lists are sorted according to the
+ predicate, [merge] returns a sorted list containing the elements
+ from the two lists. The behavior is undefined if the two
+ argument lists were not sorted. *)
val merge : ('a -> 'a -> bool) -> 'a list -> 'a list -> 'a list
- (* Merge two lists according to the given predicate.
- Assuming the two argument lists are sorted according to the
- predicate, [merge] returns a sorted list containing the elements
- from the two lists. The behavior is undefined if the two
- argument lists were not sorted. *)
+