From 08930eaf42120f608817ea31607dec9336aa96c8 Mon Sep 17 00:00:00 2001
From: Allan Blanchard <allan.blanchard@cea.fr>
Date: Mon, 12 Sep 2022 13:17:07 +0200
Subject: [PATCH] [doc] remove rebellious @plugin tags
---
src/init/boot/boot.mli | 2 +-
src/kernel_services/analysis/dataflow2.mli | 2 +-
src/kernel_services/ast_queries/cil_datatype.mli | 4 ++--
src/kernel_services/ast_queries/logic_utils.mli | 2 +-
.../cmdline_parameters/typed_parameter.mli | 2 +-
src/kernel_services/plugin_entry_points/log.mli | 8 ++++----
src/kernel_services/visitors/visitor_behavior.mli | 6 +++---
src/libraries/datatype/datatype.mli | 14 +++++++-------
src/libraries/project/project.mli | 2 +-
src/libraries/stdlib/FCHashtbl.mli | 2 +-
src/plugins/eva/Eva.mli | 2 +-
src/plugins/eva/engine/analysis.mli | 2 +-
src/plugins/gui/pretty_source.mli | 2 +-
13 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/src/init/boot/boot.mli b/src/init/boot/boot.mli
index 11d608fcace..db4d649f198 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 25f8da8cedf..0ae911b989c 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 d348749d998..c9cc0a1f83a 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 6a58e95a87d..5144832bd46 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 605be08c5c4..4edf14a1598 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 8a97b6a8dec..3c5d42faaba 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 2c0e74433bd..d5f9bc5223d 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 3729d9019e6..4c603aa208e 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 93816c8685e..a1f6582c244 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 3fe0a74217b..bc2dc0b1926 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 5fc9ded3be8..df135da7849 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 be2d743c970..dead4893d5c 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 5880954f800..4c0b01d4fa3 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. *)
--
GitLab