diff options
| author | Pierre-Marie Pédrot | 2015-06-29 14:19:31 +0200 |
|---|---|---|
| committer | Pierre-Marie Pédrot | 2015-06-29 14:31:47 +0200 |
| commit | e39b5b8eaa89950216bca646b5e9ef9b56bea7be (patch) | |
| tree | f8e88691aba5721ce77b2e80baf4f7b7a9db59f9 | |
| parent | 02663c526a3fd347fad803eb664d22e6b5c088ad (diff) | |
Code documentation of the TACTIC/VERNAC EXTEND macros.
| -rw-r--r-- | grammar/tacextend.ml4 | 2 | ||||
| -rw-r--r-- | grammar/vernacextend.ml4 | 2 | ||||
| -rw-r--r-- | intf/tacexpr.mli | 5 | ||||
| -rw-r--r-- | intf/vernacexpr.mli | 9 |
4 files changed, 17 insertions, 1 deletions
diff --git a/grammar/tacextend.ml4 b/grammar/tacextend.ml4 index f5f11e30a8..66f82fcdfc 100644 --- a/grammar/tacextend.ml4 +++ b/grammar/tacextend.ml4 @@ -8,6 +8,8 @@ (*i camlp4deps: "tools/compat5b.cmo" i*) +(** Implementation of the TACTIC EXTEND macro. *) + open Util open Pp open Names diff --git a/grammar/vernacextend.ml4 b/grammar/vernacextend.ml4 index 9db89308fb..03061d8bde 100644 --- a/grammar/vernacextend.ml4 +++ b/grammar/vernacextend.ml4 @@ -8,6 +8,8 @@ (*i camlp4deps: "tools/compat5b.cmo" i*) +(** Implementation of the VERNAC EXTEND macro. *) + open Pp open Util open Q_util diff --git a/intf/tacexpr.mli b/intf/tacexpr.mli index ff090ca844..2b37c580ea 100644 --- a/intf/tacexpr.mli +++ b/intf/tacexpr.mli @@ -94,8 +94,13 @@ type ('a,'t) match_rule = | Pat of 'a match_context_hyps list * 'a match_pattern * 't | All of 't +(** Extension indentifiers for the TACTIC EXTEND mechanism. *) type ml_tactic_name = { + (** Name of the plugin where the tactic is defined, typically coming from a + DECLARE PLUGIN statement in the source. *) mltac_plugin : string; + (** Name of the tactic entry where the tactic is defined, typically found + after the TACTIC EXTEND statement in the source. *) mltac_tactic : string; } diff --git a/intf/vernacexpr.mli b/intf/vernacexpr.mli index 0ca3bb35f6..b72577e1e0 100644 --- a/intf/vernacexpr.mli +++ b/intf/vernacexpr.mli @@ -225,7 +225,14 @@ type section_subset_expr = type section_subset_descr = SsAll | SsType | SsExpr of section_subset_expr -type extend_name = string * int +(** Extension identifiers for the VERNAC EXTEND mechanism. *) +type extend_name = + (** Name of the vernac entry where the tactic is defined, typically found + after the VERNAC EXTEND statement in the source. *) + string * + (** Index of the extension in the VERNAC EXTEND statement. Each parsing branch + is given an offset, starting from zero. *) + int (* This type allows registering the inlining of constants in native compiler. It will be extended with primitive inductive types and operators *) |