diff --git a/src/init/boot/boot.mli b/src/init/boot/boot.mli index 11d608fcaced570e6d4586bd475b091c177a9b77..db4d649f19821ebc9bc5a668ab06478bdd3bd50a 100644 --- a/src/init/boot/boot.mli +++ b/src/init/boot/boot.mli @@ -21,5 +21,5 @@ (**************************************************************************) (** Main entry point of Frama-C. Nothing is exported. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) diff --git a/src/kernel_services/analysis/dataflow2.mli b/src/kernel_services/analysis/dataflow2.mli index 25f8da8cedf699d3ed2fddb5afb828d5b36b26f2..0ae911b989c0a603604d74f0da0e9490391b975f 100644 --- a/src/kernel_services/analysis/dataflow2.mli +++ b/src/kernel_services/analysis/dataflow2.mli @@ -21,7 +21,7 @@ (**************************************************************************) (** Implementation of data flow analyses over user-supplied domains. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) (** possible kinds of action for backward analysis *) diff --git a/src/kernel_services/ast_queries/cil_datatype.mli b/src/kernel_services/ast_queries/cil_datatype.mli index d348749d99889ed6d083d637c0820eff1b796bf0..c9cc0a1f83ae9057a35dc4019a650e9597d02bba 100644 --- a/src/kernel_services/ast_queries/cil_datatype.mli +++ b/src/kernel_services/ast_queries/cil_datatype.mli @@ -219,7 +219,7 @@ module OffsetStructEqStrict: S_with_collections with type t = offset module Stmt_Id: Hptmap.Id_Datatype with type t = stmt -(** @plugin development guide *) +(** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) module Stmt: sig include S_with_collections_pretty with type t = stmt module Hptset: sig @@ -299,7 +299,7 @@ module Funbehavior: S_with_pretty with type t = funbehavior module Funspec: S_with_pretty with type t = funspec (** @since Fluorine-20130401 - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) module Fundec: S_with_collections_pretty with type t = fundec diff --git a/src/kernel_services/ast_queries/logic_utils.mli b/src/kernel_services/ast_queries/logic_utils.mli index 6a58e95a87d18225ce75c5d49d7c632cf1bf2653..5144832bd46e4972b509eda6b4369364615b6802 100644 --- a/src/kernel_services/ast_queries/logic_utils.mli +++ b/src/kernel_services/ast_queries/logic_utils.mli @@ -168,7 +168,7 @@ val expr_to_term : ?coerce:bool -> exp -> term [expr_to_predicate] instead. @before 21.0-Scandium was unsound in many cases. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val expr_to_predicate: exp -> predicate diff --git a/src/kernel_services/cmdline_parameters/typed_parameter.mli b/src/kernel_services/cmdline_parameters/typed_parameter.mli index 605be08c5c4c771cd6080bdaccae7e7971931b95..4edf14a1598883adbb181bdb14d7d307f8c5d08c 100644 --- a/src/kernel_services/cmdline_parameters/typed_parameter.mli +++ b/src/kernel_services/cmdline_parameters/typed_parameter.mli @@ -24,7 +24,7 @@ This is a low level API, internally used by the kernel. As a plug-in developer, you certainly prefer to use the API of {!Plugin} instead. @since Nitrogen-20111001 - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) (** generic accessor type *) diff --git a/src/kernel_services/plugin_entry_points/log.mli b/src/kernel_services/plugin_entry_points/log.mli index 8a97b6a8decfeff87b59d8c0ce99ac01c7b60986..3c5d42faaba22321d72f5bea8621ca169e365be9 100644 --- a/src/kernel_services/plugin_entry_points/log.mli +++ b/src/kernel_services/plugin_entry_points/log.mli @@ -134,7 +134,7 @@ module type Messages = sig type warn_category (** Same as above, but for warnings @since Chlorine-20180501 - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val verbose_atleast : int -> bool @@ -268,7 +268,7 @@ module type Messages = sig This kind of message denotes a fatal error aborting Frama-C. Notice that the [~emitwith] action is called iff a message is logged. @since 18.0-Argon - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val register : kind -> (event -> unit) -> unit @@ -333,7 +333,7 @@ module type Messages = sig *) val register_warn_category: string -> warn_category - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val is_warn_category: string -> bool @@ -353,7 +353,7 @@ module type Messages = sig val get_all_warn_categories_status: unit -> (warn_category * warn_status) list val set_warn_status: warn_category -> warn_status -> unit - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val get_warn_status: warn_category -> warn_status diff --git a/src/kernel_services/visitors/visitor_behavior.mli b/src/kernel_services/visitors/visitor_behavior.mli index 2c0e74433bddc466861e551265247c814b7109b5..d5f9bc5223dde093b430c3359fad5c94f3a3ec57 100644 --- a/src/kernel_services/visitors/visitor_behavior.mli +++ b/src/kernel_services/visitors/visitor_behavior.mli @@ -99,7 +99,7 @@ module type Get = sig val enumitem: t -> enumitem -> enumitem val typeinfo: t -> typeinfo -> typeinfo val stmt: t -> stmt -> stmt - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val logic_info: t -> logic_info -> logic_info val logic_type_info: t -> logic_type_info -> logic_type_info @@ -107,7 +107,7 @@ module type Get = sig val model_info: t -> model_info -> model_info val logic_var: t -> logic_var -> logic_var val kernel_function: t -> kernel_function -> kernel_function - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val fundec: t -> fundec -> fundec end @@ -191,7 +191,7 @@ module Set: Set {!Cil_types.varinfo}: [Set_orig.varinfo vis vi new_original_repr]. @since 20.0-Calcium - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) module Set_orig: Set diff --git a/src/libraries/datatype/datatype.mli b/src/libraries/datatype/datatype.mli index 3729d9019e6a9c6c02d0a32c25af16d15446d193..4c603aa208ee9b0425c3d22bbaff40702e5dfd00 100644 --- a/src/libraries/datatype/datatype.mli +++ b/src/libraries/datatype/datatype.mli @@ -45,10 +45,10 @@ type 'a t = private (** A type with its type value. *) module type Ty = sig type t - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val ty: t Type.t - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) end (** All values associated to a datatype, excepted [copy]. @@ -73,7 +73,7 @@ module type S_no_copy = sig val equal: t -> t -> bool (** Equality: same spec than [Stdlib.(=)]. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val compare: t -> t -> int @@ -84,7 +84,7 @@ module type S_no_copy = sig val pretty: Format.formatter -> t -> unit (** Pretty print each value in an user-friendly way. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val mem_project: (Project_skeleton.t -> bool) -> t -> bool @@ -270,16 +270,16 @@ end (** A datatype for a type [t] extended with predefined set, map and hashtbl over [t]. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) module type S_with_collections = sig include S module Set: Set with type elt = t - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) module Map: Map with type key = t module Hashtbl: Hashtbl with type key = t - (** @plugin development guide *) + (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) end (** Generic comparable datatype builder: functions [equal], [compare] and diff --git a/src/libraries/project/project.mli b/src/libraries/project/project.mli index 93816c8685e6f407b206a27e5ccded9e463b8454..a1f6582c244d68e7da0a1091b28b978a6cdf7939 100644 --- a/src/libraries/project/project.mli +++ b/src/libraries/project/project.mli @@ -200,7 +200,7 @@ val register_before_remove_hook: (t -> unit) -> unit (* ************************************************************************* *) exception IOError of string -(** @plugin development guide *) +(** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val save: ?selection:State_selection.t -> ?project:t -> Filepath.Normalized.t -> unit (** Save a given project in a file. Default project is [current ()]. diff --git a/src/libraries/stdlib/FCHashtbl.mli b/src/libraries/stdlib/FCHashtbl.mli index 3fe0a74217bc8add3a933a5226ae458c6907c6a9..bc2dc0b19263cef903ba64f40798fac74d649629 100644 --- a/src/libraries/stdlib/FCHashtbl.mli +++ b/src/libraries/stdlib/FCHashtbl.mli @@ -22,7 +22,7 @@ (** Extension of OCaml's [Hashtbl] module. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) (* No need to expand OCaml's [Hashtbl.S] here: we do not provide an alternative diff --git a/src/plugins/eva/Eva.mli b/src/plugins/eva/Eva.mli index 5fc9ded3be8d4c07e658455346c9484de411fab1..df135da7849fbc957d259dbdf022611f6cd5107c 100644 --- a/src/plugins/eva/Eva.mli +++ b/src/plugins/eva/Eva.mli @@ -49,7 +49,7 @@ module Analysis: sig val is_computed : unit -> bool (** Return [true] iff the Eva analysis has been done. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val self : State.t diff --git a/src/plugins/eva/engine/analysis.mli b/src/plugins/eva/engine/analysis.mli index be2d743c970b9b935bff2fb5bfa5b2f260628f01..dead4893d5c2c434ad6d0a6463f3690f73901010 100644 --- a/src/plugins/eva/engine/analysis.mli +++ b/src/plugins/eva/engine/analysis.mli @@ -89,7 +89,7 @@ val compute : unit -> unit val is_computed : unit -> bool (** Return [true] iff the Eva analysis has been done. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) val self : State.t diff --git a/src/plugins/gui/pretty_source.mli b/src/plugins/gui/pretty_source.mli index 5880954f800a2a3940c4b32afca227cc54bb8b9e..4c0b01d4fa3172205912f31fb4b4f3eeb69e0c27 100644 --- a/src/plugins/gui/pretty_source.mli +++ b/src/plugins/gui/pretty_source.mli @@ -38,7 +38,7 @@ type localizable = Printer_tag.localizable = one in which the variable is declared. The [kinstr] argument is given for local variables with an explicit initializer. - @plugin development guide + @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> Plug-in Development Guide *) | PGlobal of global (** all globals but variable declarations and function definitions. *)