Commit 089cbe8f authored by Guillaume Melquiond's avatar Guillaume Melquiond
Browse files

Clean generated documentation for modules a bit.

parent 4cc8890c
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
(** {2 Integer Division} (** {2 Integer Division}
It is checked that divisor is not null It is checked that divisor is not null.
*) *)
...@@ -14,14 +14,14 @@ module Int ...@@ -14,14 +14,14 @@ module Int
let (/) (x: int) (y:int) = { y <> 0 } div x y { result = div x y } let (/) (x: int) (y:int) = { y <> 0 } div x y { result = div x y }
end end
(** {2 Machine integers} (** {2 Machine integers}
32-bit integers and such go here 32-bit integers and such go here.
*) *)
module Int32 module Int32
use export int.Int use export int.Int
...@@ -47,11 +47,12 @@ module Int32 ...@@ -47,11 +47,12 @@ module Int32
end end
(** {2 Division on real numbers} (** {2 Division on real numbers}
See also Floating-Point theories See also {h <a href="floating_point.why.html">Floating-Point theories</a>.}
*) *)
module Real module Real
use import real.Real use import real.Real
......
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
(** {2 Generic Arrays} (** {2 Generic Arrays}
The length is a non-mutable field, so that we get for free that modification of an array does not modify its length The length is a non-mutable field, so that we get for free that
modification of an array does not modify its length.
*) *)
...@@ -110,7 +111,6 @@ module Array ...@@ -110,7 +111,6 @@ module Array
end end
(** {2 Sorted Arrays} *) (** {2 Sorted Arrays} *)
module ArraySorted module ArraySorted
...@@ -194,7 +194,6 @@ module ArraySum ...@@ -194,7 +194,6 @@ module ArraySum
clone import map.MapSum as M clone import map.MapSum as M
(** [sum a l h] is the sum of [a[i]] for [l <= i < h] *) (** [sum a l h] is the sum of [a[i]] for [l <= i < h] *)
function sum (a: array int) (l h: int) : int = M.sum a.elts l h function sum (a: array int) (l h: int) : int = M.sum a.elts l h
end end
......
(** {1 Hash tables} (** {1 Hash tables}
This module provides Hash tables à la OCaml. Each key is mapped to a *stack* of values, This module provides Hash tables à la OCaml. Each key is mapped to a {h <b>stack</b>} of values,
with [add h k v] pushing a new value [v] for key [k], with [add h k v] pushing a new value [v] for key [k],
and [remove h k] popping a value for key [key]. and [remove h k] popping a value for key [k].
*) *)
...@@ -102,7 +102,6 @@ module TestHashtbl ...@@ -102,7 +102,6 @@ module TestHashtbl
replace h k1 True; replace h k1 True;
assert { h[k1] = Cons True (Cons True Nil) } assert { h[k1] = Cons True (Cons True Nil) }
end end
(*** (***
......
(** {1 Imperative sets} (** {1 Imperative sets}
An imperative set is simply a reference containing a finite set An imperative set is simply a reference containing a finite set.
*) *)
...@@ -25,7 +25,7 @@ module Impset ...@@ -25,7 +25,7 @@ module Impset
let is_empty (b: t 'a) = let is_empty (b: t 'a) =
{} {}
is_empty !b is_empty !b
{ result=True <-> is_empty !b } { result = True <-> is_empty !b }
let push (x: 'a) (b: t 'a) = let push (x: 'a) (b: t 'a) =
{} {}
......
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
The following modules provide slightly more: pseudo-random generators The following modules provide slightly more: pseudo-random generators
which are deterministic according to a state. The state is either which are deterministic according to a state. The state is either
explicit (module [State]) or global (module [Random]). Functions init allow explicit (module [State]) or global (module [Random]). Functions [init] allow
to reset the generators according to a given seed. to reset the generators according to a given seed.
*) *)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment