diff options
| author | octachron <octa@polychoron.fr> | 2016-10-01 22:35:05 +0200 |
|---|---|---|
| committer | octachron <octa@polychoron.fr> | 2017-10-04 13:05:05 +0200 |
| commit | e30e82a2198d8649d773fbe346e4ba358f7cfef4 (patch) | |
| tree | b54e0c81c12e935df7dc86525f1e133e317b15d3 /stdlib/stream.mli | |
| parent | 03e1a93f0be8656226f139545b4ea85a55078cc4 (diff) | |
| download | ocaml-e30e82a2198d8649d773fbe346e4ba358f7cfef4.tar.gz | |
PR#7363: start documentation headers at {1
Diffstat (limited to 'stdlib/stream.mli')
| -rw-r--r-- | stdlib/stream.mli | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/stdlib/stream.mli b/stdlib/stream.mli index 03b34a04b8..e52bab8961 100644 --- a/stdlib/stream.mli +++ b/stdlib/stream.mli @@ -27,7 +27,7 @@ exception Error of string accepted, but one of the following components is rejected. *) -(** {6 Stream builders} *) +(** {1 Stream builders} *) val from : (int -> 'a option) -> 'a t (** [Stream.from f] returns a stream built from the function [f]. @@ -56,14 +56,14 @@ val of_channel : in_channel -> char t (** Return the stream of the characters read from the input channel. *) -(** {6 Stream iterator} *) +(** {1 Stream iterator} *) val iter : ('a -> unit) -> 'a t -> unit (** [Stream.iter f s] scans the whole stream s, applying function [f] in turn to each stream element encountered. *) -(** {6 Predefined parsers} *) +(** {1 Predefined parsers} *) val next : 'a t -> 'a (** Return the first element of the stream and remove it from the @@ -73,7 +73,7 @@ val empty : 'a t -> unit (** Return [()] if the stream is empty, else raise {!Stream.Failure}. *) -(** {6 Useful functions} *) +(** {1 Useful functions} *) val peek : 'a t -> 'a option (** Return [Some] of "the first element" of the stream, or [None] if |