Skip to content
Snippets Groups Projects
Commit 3dda5509 authored by Allan Blanchard's avatar Allan Blanchard
Browse files

[doc] Document a few API changes

parent 483d34ac
No related branches found
No related tags found
No related merge requests found
...@@ -268,7 +268,6 @@ module Varinfo: sig ...@@ -268,7 +268,6 @@ module Varinfo: sig
val self: State.t val self: State.t
end end
val dummy: t val dummy: t
(**/**)
end end
module Kf: sig module Kf: sig
......
...@@ -63,6 +63,8 @@ val register_compute: ...@@ -63,6 +63,8 @@ val register_compute:
val register_guarded_compute: val register_guarded_compute:
(unit -> bool) -> (unit -> bool) ->
(unit -> unit) ref -> (unit -> unit) -> unit (unit -> unit) ref -> (unit -> unit) -> unit
(** @before Frama-C+dev there was a string parameter (first position) that was
only used for Journalization, that has been removed. *)
(** Frama-C main interface. (** Frama-C main interface.
@since Lithium-20081201 @since Lithium-20081201
......
...@@ -35,6 +35,8 @@ val register: ...@@ -35,6 +35,8 @@ val register:
[name], the type [ty] and the plug-in [plugin]. [name], the type [ty] and the plug-in [plugin].
@raise Type.AlreadyExists if [name] already exists. In other words you @raise Type.AlreadyExists if [name] already exists. In other words you
cannot register a value with the same name twice. cannot register a value with the same name twice.
@before Frama-C+dev there was a labeled argument [journalized], that has
been removed when Journalization has been removed.
@plugin development guide *) @plugin development guide *)
(* ************************************************************************* *) (* ************************************************************************* *)
...@@ -155,7 +157,8 @@ end ...@@ -155,7 +157,8 @@ end
*) *)
val load_packages: string list -> unit val load_packages: string list -> unit
(** Load the module specification. See -load-module option. *) (** Load the module specification. See -load-module option.
@modify Magnesium-20151001 new API. *)
val load_module: string -> unit val load_module: string -> unit
(** Sets the load path for modules in FRAMAC_PLUGIN, prepending it with [path]. (** Sets the load path for modules in FRAMAC_PLUGIN, prepending it with [path].
...@@ -173,7 +176,8 @@ val is_loaded: string -> bool ...@@ -173,7 +176,8 @@ val is_loaded: string -> bool
val load_plugin_path: unit -> unit val load_plugin_path: unit -> unit
(** Load all plugins in the path set with [set_module_load_path]. (** Load all plugins in the path set with [set_module_load_path].
Must be invoked only once from boot during extending stage. Must be invoked only once from boot during extending stage.
@since Magnesium-20151001 new API. *) @since Magnesium-20151001 new API.
@modify Phosphorus-20170501-beta1 changed signature. *)
(**/**) (**/**)
(* (*
......
...@@ -30,7 +30,10 @@ ...@@ -30,7 +30,10 @@
(* ********************************************************************** *) (* ********************************************************************** *)
(** Values associated to each datatype. (** Values associated to each datatype.
Some others are provided directly in module {!Type}. *) Some others are provided directly in module {!Type}.
@before Frama-C+dev there was additional fields only used for Journalization
that has been removed.
*)
type 'a t = private type 'a t = private
{ equal: 'a -> 'a -> bool; { equal: 'a -> 'a -> bool;
compare: 'a -> 'a -> int; compare: 'a -> 'a -> int;
...@@ -45,7 +48,10 @@ module type Ty = sig ...@@ -45,7 +48,10 @@ module type Ty = sig
val ty: t Type.t val ty: t Type.t
end end
(** All values associated to a datatype, excepted [copy]. *) (** All values associated to a datatype, excepted [copy].
@before Frama-C+dev there was several additional values only used for
Journalization that has been removed.
*)
module type S_no_copy = sig module type S_no_copy = sig
include Ty include Ty
...@@ -122,7 +128,11 @@ val never_any_project: (Project_skeleton.t -> bool) -> 'a -> bool ...@@ -122,7 +128,11 @@ val never_any_project: (Project_skeleton.t -> bool) -> 'a -> bool
@plugin development guide *) @plugin development guide *)
(** Sub-signature of {!S}. (** Sub-signature of {!S}.
@plugin development guide *) @plugin development guide
@before Frama-C+dev there was several additional values only used for
Journalization that has been removed.
*)
module type Undefined = sig module type Undefined = sig
val structural_descr: Structural_descr.t val structural_descr: Structural_descr.t
val equal: 'a -> 'a -> bool val equal: 'a -> 'a -> bool
...@@ -157,7 +167,11 @@ module Serializable_undefined: Undefined ...@@ -157,7 +167,11 @@ module Serializable_undefined: Undefined
(** Input signature of {!Make} and {!Make_with_collections}. (** Input signature of {!Make} and {!Make_with_collections}.
Values to implement in order to get a datatype. Values to implement in order to get a datatype.
Feel free to use easy builders (see above) for easy implementation. *) Feel free to use easy builders (see above) for easy implementation.
@before Frama-C+dev there was several additional values only used for
Journalization that has been removed.
*)
module type Make_input = sig module type Make_input = sig
type t (** Type for this datatype *) type t (** Type for this datatype *)
...@@ -334,7 +348,11 @@ module type Polymorphic = sig ...@@ -334,7 +348,11 @@ module type Polymorphic = sig
end end
(** Functor for polymorphic types with only 1 type variable. (** Functor for polymorphic types with only 1 type variable.
@plugin development guide *) @plugin development guide
@before Frama-C+dev the functor had several additional values only used for
Journalization that has been removed.
*)
module Polymorphic module Polymorphic
(P: sig (P: sig
include Type.Polymorphic_input include Type.Polymorphic_input
...@@ -357,7 +375,11 @@ module type Polymorphic2 = sig ...@@ -357,7 +375,11 @@ module type Polymorphic2 = sig
end end
(** Functor for polymorphic types with 2 type variables. (** Functor for polymorphic types with 2 type variables.
@plugin development guide *) @plugin development guide
@before Frama-C+dev the functor had several additional values only used for
Journalization that has been removed.
*)
module Polymorphic2 module Polymorphic2
(P: sig (P: sig
include Type.Polymorphic2_input include Type.Polymorphic2_input
...@@ -387,7 +409,10 @@ end ...@@ -387,7 +409,10 @@ end
(** Functor for polymorphic types with 3 type variables. (** Functor for polymorphic types with 3 type variables.
@since Oxygen-20120901 @since Oxygen-20120901
@plugin development guide *) @plugin development guide
@before Frama-C+dev the functor had several additional values only used for
Journalization that has been removed.
*)
module Polymorphic3 module Polymorphic3
(P: sig (P: sig
include Type.Polymorphic3_input include Type.Polymorphic3_input
...@@ -425,7 +450,10 @@ end ...@@ -425,7 +450,10 @@ end
(** Functor for polymorphic types with 4 type variables. (** Functor for polymorphic types with 4 type variables.
@since Oxygen-20120901 @since Oxygen-20120901
@plugin development guide *) @plugin development guide
@before Frama-C+dev the functor had several additional values only used for
Journalization that has been removed.
*)
module Polymorphic4 module Polymorphic4
(P: sig (P: sig
include Type.Polymorphic4_input include Type.Polymorphic4_input
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment