diff options
Diffstat (limited to 'library/states.mli')
| -rw-r--r-- | library/states.mli | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/library/states.mli b/library/states.mli index fc6497b6..7e6535d9 100644 --- a/library/states.mli +++ b/library/states.mli @@ -1,14 +1,14 @@ (************************************************************************) (* v * The Coq Proof Assistant / The Coq Development Team *) -(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2011 *) +(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2012 *) (* \VV/ **************************************************************) (* // * This file is distributed under the terms of the *) (* * GNU Lesser General Public License Version 2.1 *) (************************************************************************) -(*i $Id: states.mli 14641 2011-11-06 11:59:10Z herbelin $ i*) +(** {6 States of the system} *) -(*s States of the system. In that module, we provide functions to get +(** In that module, we provide functions to get and set the state of the whole system. Internally, it is done by freezing the states of both [Lib] and [Summary]. We provide functions to write and restore state to and from a given file. *) @@ -20,13 +20,14 @@ type state val freeze : unit -> state val unfreeze : state -> unit -(*s Rollback. [with_heavy_rollback f x] applies [f] to [x] and restores the +(** {6 Rollback } *) + +(** [with_heavy_rollback f x] applies [f] to [x] and restores the state of the whole system as it was before the evaluation if an exception is raised. *) - val with_heavy_rollback : ('a -> 'b) -> (exn -> exn) -> 'a -> 'b -(*s [with_state_protection f x] applies [f] to [x] and restores the +(** [with_state_protection f x] applies [f] to [x] and restores the state of the whole system as it was before the evaluation of f *) val with_state_protection : ('a -> 'b) -> 'a -> 'b |