Skip to content
Snippets Groups Projects
Commit a96cdc84 authored by Andre Maroneze's avatar Andre Maroneze Committed by Allan Blanchard
Browse files

[Kernel] replace several @modify tags with @before

parent fbfec08b
No related branches found
No related tags found
No related merge requests found
...@@ -977,12 +977,12 @@ val need_cast: ?force:bool -> typ -> typ -> bool ...@@ -977,12 +977,12 @@ val need_cast: ?force:bool -> typ -> typ -> bool
(** Construct a cast when having the old type of the expression. If the new (** Construct a cast when having the old type of the expression. If the new
type is the same as the old type, then no cast is added, unless [force] type is the same as the old type, then no cast is added, unless [force]
is [true] (default is [false]) is [true] (default is [false])
@modify 23.0-Vanadium change order or arguments @before 23.0-Vanadium different order of arguments.
*) *)
val mkCastT: ?force:bool -> oldt:typ -> newt:typ -> exp -> exp val mkCastT: ?force:bool -> oldt:typ -> newt:typ -> exp -> exp
(** Like {!Cil.mkCastT} but uses typeOf to get [oldt] (** Like {!Cil.mkCastT} but uses typeOf to get [oldt]
@modify 23.0-Vanadium change order or arguments @before 23.0-Vanadium different order of arguments.
*) *)
val mkCast: ?force:bool -> newt:typ -> exp -> exp val mkCast: ?force:bool -> newt:typ -> exp -> exp
...@@ -1105,8 +1105,8 @@ val mkPureExpr: ...@@ -1105,8 +1105,8 @@ val mkPureExpr:
(** Make a loop. Can contain Break or Continue. (** Make a loop. Can contain Break or Continue.
The kind of loop (while, for, dowhile) is given by [sattr] The kind of loop (while, for, dowhile) is given by [sattr]
(none by default). Use {!Cil.mkWhile} for a While loop. (none by default). Use {!Cil.mkWhile} for a While loop.
@modify 23.0-Vanadium add unit argument. Default type is no longer While, @before 23.0-Vanadium no unit argument, and default type was While
use {!Cil.mkWhile} instead. (for while loops, there is now {!Cil.mkWhile}).
*) *)
val mkLoop: ?sattr:attributes -> guard:exp -> body:stmt list -> unit -> val mkLoop: ?sattr:attributes -> guard:exp -> body:stmt list -> unit ->
stmt list stmt list
...@@ -1115,14 +1115,14 @@ val mkLoop: ?sattr:attributes -> guard:exp -> body:stmt list -> unit -> ...@@ -1115,14 +1115,14 @@ val mkLoop: ?sattr:attributes -> guard:exp -> body:stmt list -> unit ->
can contain Break but not Continue. Can be used with i a pointer can contain Break but not Continue. Can be used with i a pointer
or an integer. Start and done must have the same type but incr or an integer. Start and done must have the same type but incr
must be an integer must be an integer
@modify 23.0-Vanadium add unit argument @before 23.0-Vanadium did not have unit argument.
*) *)
val mkForIncr: ?sattr:attributes -> iter:varinfo -> first:exp -> stopat:exp -> val mkForIncr: ?sattr:attributes -> iter:varinfo -> first:exp -> stopat:exp ->
incr:exp -> body:stmt list -> unit -> stmt list incr:exp -> body:stmt list -> unit -> stmt list
(** Make a for loop for(start; guard; next) \{ ... \}. The body can (** Make a for loop for(start; guard; next) \{ ... \}. The body can
contain Break but not Continue !!! contain Break but not Continue !!!
@modify 23.0-Vanadium add unit argument @before 23.0-Vanadium did not have unit argument.
*) *)
val mkFor: ?sattr:attributes -> start:stmt list -> guard:exp -> next: stmt list -> val mkFor: ?sattr:attributes -> start:stmt list -> guard:exp -> next: stmt list ->
body: stmt list -> unit -> stmt list body: stmt list -> unit -> stmt list
......
...@@ -146,7 +146,7 @@ val get_name: t -> string ...@@ -146,7 +146,7 @@ val get_name: t -> string
val get_preprocessor_command: unit -> string val get_preprocessor_command: unit -> string
(** Return the preprocessor command to use. (** Return the preprocessor command to use.
@modify 23.0-Vanadium return type now contains only the command @before 23.0-Vanadium return type also contained cpp_opt_kind.
*) *)
val pre_register: t -> unit val pre_register: t -> unit
......
...@@ -122,7 +122,7 @@ val is_reconfigurable: unit -> unit ...@@ -122,7 +122,7 @@ val is_reconfigurable: unit -> unit
only parameters corresponding to options registered at the only parameters corresponding to options registered at the
{!Cmdline.Configuring} stage are reconfigurable. {!Cmdline.Configuring} stage are reconfigurable.
@since Nitrogen-20111001 @since Nitrogen-20111001
@modify 22.0-Titanium [do_iterate] renamed to [is_reconfigurable] @before 22.0-Titanium this function was called [do_iterate].
*) *)
val is_not_reconfigurable: unit -> unit val is_not_reconfigurable: unit -> unit
...@@ -130,7 +130,7 @@ val is_not_reconfigurable: unit -> unit ...@@ -130,7 +130,7 @@ val is_not_reconfigurable: unit -> unit
parameters corresponding to options registered at the parameters corresponding to options registered at the
{!Cmdline.Configuring} stage are reconfigurable. {!Cmdline.Configuring} stage are reconfigurable.
@since Nitrogen-20111001 @since Nitrogen-20111001
@modify 22.0-Titanium [do_iterate] renamed to [is_reconfigurable] @before 22.0-Titanium this function was called [do_not_iterate].
*) *)
val no_category: unit -> unit val no_category: unit -> unit
......
...@@ -335,7 +335,8 @@ module AstDiff: Parameter_sig.Bool ...@@ -335,7 +335,8 @@ module AstDiff: Parameter_sig.Bool
(** Behavior of option "-add-symbolic-path" (** Behavior of option "-add-symbolic-path"
@since Neon-20140301 @since Neon-20140301
@modify 23.0-Vanadium inversed argument order (now uses path:name) *) @before 23.0-Vanadium argument order was inversed (name:path); now it is
(path:name). *)
module SymbolicPath: Parameter_sig.Filepath_map with type value = string module SymbolicPath: Parameter_sig.Filepath_map with type value = string
module FloatNormal: Parameter_sig.Bool module FloatNormal: Parameter_sig.Bool
...@@ -383,13 +384,13 @@ end ...@@ -383,13 +384,13 @@ end
module Session_dir: Parameter_sig.Filepath module Session_dir: Parameter_sig.Filepath
(** Directory in which session files are searched. (** Directory in which session files are searched.
@since Neon-20140301 @since Neon-20140301
@modify 23.0-Vanadium parameter type is now Filepath instead of string @before 23.0-Vanadium parameter type was string instead of Filepath.
*) *)
module Config_dir: Parameter_sig.Filepath module Config_dir: Parameter_sig.Filepath
(** Directory in which config files are searched. (** Directory in which config files are searched.
@since Neon-20140301 @since Neon-20140301
@modify 23.0-Vanadium parameter type is now Filepath instead of string @before 23.0-Vanadium parameter type was string instead of Filepath.
*) *)
(* this stop special comment does not work as expected (and as explained in the (* this stop special comment does not work as expected (and as explained in the
......
...@@ -68,7 +68,8 @@ module type S_no_log = sig ...@@ -68,7 +68,8 @@ module type S_no_log = sig
[add_plugin_output_aliases [alias]] adds the aliases -alias-help, [add_plugin_output_aliases [alias]] adds the aliases -alias-help,
-alias-verbose, etc. -alias-verbose, etc.
@since 18.0-Argon @since 18.0-Argon
@modify 22.0-Titanium add [visible] and [deprecated] arguments. *) @before 22.0-Titanium no [visible] and [deprecated] arguments.
*)
end end
(** Provided plug-general services for plug-ins. (** Provided plug-general services for plug-ins.
...@@ -85,8 +86,8 @@ type plugin = private ...@@ -85,8 +86,8 @@ type plugin = private
p_help: string; p_help: string;
p_parameters: (string, Typed_parameter.t list) Hashtbl.t } p_parameters: (string, Typed_parameter.t list) Hashtbl.t }
(** @since Beryllium-20090901 (** @since Beryllium-20090901
@modify 22.0-Titanium previously only "iterable" parameters were included, @before 22.0-Titanium only "iterable" parameters were included;
now all parameters are. now all parameters are.
*) *)
module type General_services = sig module type General_services = sig
......
...@@ -208,8 +208,7 @@ val the: exn:exn -> 'a option -> 'a ...@@ -208,8 +208,7 @@ val the: exn:exn -> 'a option -> 'a
(** @raise Exn if the value is [None] and [exn] is specified. (** @raise Exn if the value is [None] and [exn] is specified.
@raise Invalid_argument if the value is [None] and [exn] is not specified. @raise Invalid_argument if the value is [None] and [exn] is not specified.
@return v if the value is [Some v]. @return v if the value is [Some v].
@modify 23.0-Vanadium optional argument [exn] now mandatory; otherwise, @before 23.0-Vanadium [exn] was an optional argument.
use [Option.get], which is equivalent.
@plugin development guide *) @plugin development guide *)
val opt_hash: ('a -> int) -> 'a option -> int val opt_hash: ('a -> int) -> 'a option -> int
......
...@@ -49,7 +49,7 @@ exception File_exists ...@@ -49,7 +49,7 @@ exception File_exists
- non-existing directories in [realpath] may lead to ENOTDIR errors, - non-existing directories in [realpath] may lead to ENOTDIR errors,
but [normalize] may accept them. but [normalize] may accept them.
@modify 21.0-Scandium optional existence. @before 21.0-Scandium no [existence] argument.
*) *)
val normalize: ?existence:existence -> ?base_name:string -> string -> string val normalize: ?existence:existence -> ?base_name:string -> string -> string
...@@ -70,7 +70,7 @@ module Normalized: sig ...@@ -70,7 +70,7 @@ module Normalized: sig
(** [of_string s] converts [s] into a normalized path. (** [of_string s] converts [s] into a normalized path.
@raise Invalid_argument if [s] is the empty string. @raise Invalid_argument if [s] is the empty string.
@modify 21.0-Scandium add optional existence parameter. @before 21.0-Scandium no [existence] argument.
*) *)
val of_string: ?existence:existence -> ?base_name:string -> string -> t val of_string: ?existence:existence -> ?base_name:string -> string -> t
...@@ -169,7 +169,7 @@ end ...@@ -169,7 +169,7 @@ end
(that is, it is prefixed by [base_name]), or to the current (that is, it is prefixed by [base_name]), or to the current
working directory if no base is specified. working directory if no base is specified.
@since Aluminium-20160501 @since Aluminium-20160501
@modify 23.0-Vanadium argument types changed from string to Normalized.t @before 23.0-Vanadium argument types were string instead of Normalized.t.
*) *)
val is_relative: ?base_name:Normalized.t -> Normalized.t -> bool val is_relative: ?base_name:Normalized.t -> Normalized.t -> bool
......
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