Commit 0c58894f authored by Andre Maroneze's avatar Andre Maroneze
Browse files

[Kernel] update @since tags

parent c0a8bb0b
......@@ -175,7 +175,9 @@ work for this purpose):
\begin{shell}
./bin/update_api_doc.sh <NEXT>
\end{shell}
\verb+<NEXT>+ is the name of the release, i.e. the contents of VERSION (without any \verb+rc+ suffix).
\verb+<NEXT>+ is the long name of the final release, i.e.
\verb+`cat VERSION`-`VERSION_CODENAME`+
(without the \verb+beta+ suffix, if any).
Check that no \verb|+dev| suffix remains inside comments:
......
......@@ -96,7 +96,7 @@ type callback = returns_clause -> goto_annot list -> unit
This function assumes that {!Oneret.oneret} has already been run on [f],
i.e. that there is exactly one return statement in there.
@since Frama-C+dev
@since 20.0-Calcium
@raise Abort.fatal if the function is not defined.
*)
......
......@@ -139,7 +139,7 @@ val local_definition: t -> varinfo -> stmt
(** [local_definition f v] returns the statement initializing the (defined)
local variable [v] of [f].
@raise AbortFatal if [v] is not defined or is not a local of [f]
@since Frama-C+dev
@since 20.0-Calcium
*)
val var_is_in_scope: stmt -> varinfo -> bool
......
......@@ -92,7 +92,7 @@ class type extensible_printer_type = object
parameter is the function to be applied in the ghost context (generally
some AST element).
@since 19.0-Potassium+dev *)
@since 20.0-Calcium *)
method private current_stmt: stmt option
(** @return the [stmt] being printed *)
......
......@@ -183,7 +183,7 @@ val selfFormalsDecl: State.t
val makeFormalsVarDecl: ?ghost:bool -> (string * typ * attributes) -> varinfo
(** creates a new varinfo for the parameter of a prototype.
By default, this formal variable is not ghost.
@modify 19.0-Potassium+dev adds a parameter for ghost status
@modify 20.0-Calcium adds a parameter for ghost status
*)
(** Update the formals of a function declaration from its identifier and its
......@@ -584,11 +584,11 @@ val isTypeTagType: logic_type -> bool
val isVariadicListType: typ -> bool
(** Obtain the argument list ([] if None).
@since 19.0-Potassium+dev Beware that it contains the ghost arguments. *)
@since 20.0-Calcium Beware that it contains the ghost arguments. *)
val argsToList:
(string * typ * attributes) list option -> (string * typ * attributes) list
(** @since 19.0-Potassium+dev
(** @since 20.0-Calcium
Obtain the argument lists (non-ghost, ghosts) ([], [] if None) *)
val argsToPairOfLists:
(string * typ * attributes) list option ->
......@@ -697,7 +697,7 @@ val makeFormalVar: fundec -> ?ghost:bool -> ?where:string -> ?loc:Location.t ->
a fresh name will be generated for the varinfo.
@modify Chlorine-20180501 the name of the variable is guaranteed to be fresh.
@modify Frama-C+dev add ghost optional argument
@modify 20.0-Calcium add ghost optional argument
*)
val makeLocalVar:
fundec -> ?scope:block -> ?temp:bool -> ?referenced:bool -> ?insert:bool ->
......@@ -720,7 +720,7 @@ val refresh_local_name: fundec -> varinfo -> unit
among other locals of the function. The value for [insert] should
only be changed if you are completely sure this is not useful.
@modify Frama-C+dev add ghost optional argument
@modify 20.0-Calcium add ghost optional argument
*)
val makeTempVar: fundec -> ?insert:bool -> ?ghost:bool -> ?name:string ->
?descr:string -> ?descrpure:bool -> ?loc:Location.t -> typ -> varinfo
......@@ -728,7 +728,7 @@ val makeTempVar: fundec -> ?insert:bool -> ?ghost:bool -> ?name:string ->
(** Make a global variable. Your responsibility to make sure that the name
is unique. [source] defaults to [true]. [temp] defaults to [false].
@modify Frama-C+dev add ghost optional arg
@modify 20.0-Calcium add ghost optional arg
*)
val makeGlobalVar: ?source:bool -> ?temp:bool -> ?referenced:bool ->
?ghost:bool -> ?loc:Cil_datatype.Location.t -> string -> typ -> varinfo
......@@ -1206,7 +1206,7 @@ val dropAttributes: string list -> attributes -> attributes
(** A varinfo marked with this attribute is known to be a ghost formal.
@since 19.0-Potassium+dev
@since 20.0-Calcium
*)
val frama_c_ghost_formal: string
......@@ -1232,13 +1232,13 @@ val is_mutable_or_initialized: lval -> bool
(** [true] if the given varinfo is a ghost formal variable.
@since 19.0-Potassium+dev
@since 20.0-Calcium
*)
val isGhostFormalVarinfo: varinfo -> bool
(** [true] if the given formal declaration corresponds to a ghost formal variable.
@since 19.0-Potassium+dev
@since 20.0-Calcium
*)
val isGhostFormalVarDecl: (string * typ * attributes) -> bool
......@@ -1385,12 +1385,12 @@ val expToAttrParam: exp -> attrparam
(** Return the attributes of the global annotation, if any.
@since Frama-C+dev
@since 20.0-Calcium
*)
val global_annotation_attributes: global_annotation -> attributes
(** Return the attributes of the global, if any.
@since Frama-C+dev
@since 20.0-Calcium
*)
val global_attributes: global -> attributes
......
......@@ -264,7 +264,7 @@ module Logic_info: S_with_collections_pretty with type t = logic_info
the same name and profile except for the name of their type variables
will compare unequal.
@since Frama-C+dev
@since 20.0-Calcium
*)
module Logic_info_structural: S_with_collections_pretty with type t = logic_info
module Logic_constant: S_with_collections_pretty with type t = logic_constant
......
......@@ -367,7 +367,7 @@ val merge_behaviors :
(** [merge_funspec ?oldloc oldspec newspec] merges [newspec] into [oldspec].
If the funspec belongs to a kernel function, do not forget to call
{!Kernel_function.set_spec} after merging.
@modify Frama-C+dev add optional parameter [oldloc].
@modify 20.0-Calcium add optional parameter [oldloc].
*)
val merge_funspec :
?oldloc:Cil_types.location -> ?silent_about_merging_behav:bool ->
......
......@@ -23,7 +23,7 @@
(**************************************************************************)
(** Operations on visitor behaviors.
@since Potassium-19.0+dev.
@since 20.0-Calcium.
*)
open Cil_types
......@@ -73,7 +73,7 @@ val get_project: t -> Project.t option
[Reset.ast_element vis] resets the tables associated to the considered type of
AST elements in [vis]. For example for {!Cil_types.varinfo}: [Reset.varinfo vis].
@since Potassium-19.0+dev
@since 20.0-Calcium
@plugin development guide
*)
module Reset: sig
......@@ -115,7 +115,7 @@ end
representative of [e] in [vis]. For example for {!Cil_types.varinfo}:
[Get.varinfo vis vi].
@since Potassium-19.0+dev
@since 20.0-Calcium
@plugin development guide
*)
module Get: Get
......@@ -127,7 +127,7 @@ module Get: Get
original representative of [new_e] in [vis]. For example for
{!Cil_types.varinfo}: [Get_orig.varinfo vis new_vi].
@since Potassium-19.0+dev
@since 20.0-Calcium
@plugin development guide
*)
module Get_orig: Get
......@@ -140,7 +140,7 @@ module Get_orig: Get
state, if it does not exist this binding is created. For example for
{!Cil_types.varinfo}: [Memo.varinfo vis vi].
@since Potassium-19.0+dev
@since 20.0-Calcium
@plugin development guide
*)
module Memo: Get
......@@ -173,7 +173,7 @@ end
the representative of [e] to [s] in [vis]. For example, for
{!Cil_types.varinfo}: [Set.varinfo vis vi new_representative].
@since Potassium-19.0+dev
@since 20.0-Calcium
@plugin development guide
*)
module Set: Set
......@@ -186,7 +186,7 @@ module Set: Set
the original representative of [e] to [s] in [vis]. For example, for
{!Cil_types.varinfo}: [Set_orig.varinfo vis vi new_original_repr].
@since Potassium-19.0+dev
@since 20.0-Calcium
*)
module Set_orig: Set
......@@ -216,7 +216,7 @@ end
representative of [e] in the [ast_element] table of [vis]. For example,
for {!Cil_types.varinfo}: [Unset.varinfo vis vi].
@since Potassium-19.0+dev
@since 20.0-Calcium
*)
module Unset: Unset
......@@ -227,7 +227,7 @@ module Unset: Unset
original representative of [e] in the [ast_element] table of [vis]. For
example, for {!Cil_types.varinfo}: [Unset_orig.varinfo vis vi].
@since Potassium-19.0+dev
@since 20.0-Calcium
*)
module Unset_orig: Unset
......@@ -238,7 +238,7 @@ module Unset_orig: Unset
first (that is, [f] looks like: [let f old_e new_e = ...]. For example for
{!Cil_types.varinfo}: [Iter.varinfo vis (fun old_vi new_vi -> ())].
@since Potassium-19.0+dev
@since 20.0-Calcium
*)
module Iter: sig
val varinfo:
......@@ -277,7 +277,7 @@ end
for {!Cil_types.varinfo}:
[Fold.varinfo vis (fun old_vi new_vi acc -> ... )].
@since Potassium-19.0+dev
@since 20.0-Calcium
*)
module Fold: sig
val varinfo:
......
......@@ -122,7 +122,7 @@ module Normalized: sig
(** Unknown filepath, used as 'dummy' for [Datatype.Filepath]. *)
val unknown: t
(** @since Frama-C+dev *)
(** @since 20.0-Calcium *)
val is_unknown: t -> bool
end
......
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