diff options
| author | Jun FURUSE / 古瀬 淳 <jun.furuse@gmail.com> | 2004-06-18 05:04:14 +0000 |
|---|---|---|
| committer | Jun FURUSE / 古瀬 淳 <jun.furuse@gmail.com> | 2004-06-18 05:04:14 +0000 |
| commit | 5e1bf20850aaa9b1ceb86a971848609ee9e84c47 (patch) | |
| tree | f3a6e5b5c38263fe527e6275ff95425f12637226 /stdlib/format.mli | |
| parent | 8ec769214e067da9ee8b33d05f4ef275e9269dd5 (diff) | |
| download | ocaml-gcaml.tar.gz | |
port to the latest ocaml (2004/06/18)gcaml
git-svn-id: http://caml.inria.fr/svn/ocaml/branches/gcaml@6419 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/format.mli')
| -rw-r--r-- | stdlib/format.mli | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/stdlib/format.mli b/stdlib/format.mli index a8c83bd1b6..3526e2365b 100644 --- a/stdlib/format.mli +++ b/stdlib/format.mli @@ -20,6 +20,9 @@ at specified break hints, and indents lines according to the box structure. + For a gentle introduction to the basics of prety-printing using + [Format], read the FAQ at [http://caml.inria.fr/FAQ/format-eng.html]. + Warning: the material output by the following functions is delayed in the pretty-printer queue in order to compute the proper line breaking. Hence, you should not mix calls to the printing functions @@ -584,7 +587,9 @@ val fprintf : formatter -> ('a, formatter, unit) format -> 'a;; [nspaces] and [offset] parameters of the break may be optionally specified with the following syntax: the [<] character, followed by an integer [nspaces] value, - then an integer offset, and a closing [>] character. + then an integer offset, and a closing [>] character. + If no parameters are provided, the good break defaults to a + space. - [@?]: flush the pretty printer as with [print_flush ()]. This is equivalent to the conversion [%!]. - [@.]: flush the pretty printer and output a new line, as with |