Commit 08930eaf authored by Allan Blanchard's avatar Allan Blanchard
Browse files

[doc] remove rebellious @plugin tags

parent 6052c729
......@@ -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
*)
......@@ -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 *)
......
......@@ -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
......
......@@ -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
......
......@@ -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 *)
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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 ()].
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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. *)
......
Supports Markdown
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