← Back to branch summary

~ubuntu-branches/ubuntu/wily/coq-doc/wily

« back to all changes in this revision

Viewing changes to library/declare.mli

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Glondu, Stéphane Glondu, Samuel Mimram
  • Date: 2010-01-07 22:50:39 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107225039-n3cq82589u0qt0s2
Tags: 8.2pl1-1
http://bugs.debian.org/563669
http://bugs.debian.org/543545
[ Stéphane Glondu ]
* New upstream release (Closes: #563669)
  - remove patches
* Packaging overhaul:
  - use git, advertise it in Vcs-* fields of debian/control
  - use debhelper 7 and dh with override
  - use source format 3.0 (quilt)
* debian/control:
  - set Maintainer to d-o-m, set Uploaders to Sam and myself
  - add Homepage field
  - bump Standards-Version to 3.8.3
* Register PDF documentation into doc-base
* Add debian/watch
* Update debian/copyright

[ Samuel Mimram ]
* Change coq-doc's description to mention that it provides documentation in
  pdf format, not postscript, closes: #543545.

Show diffs side-by-side

added added

removed removed

Lines of Context:
library/declare.mli
 
1
(************************************************************************)
 
2
(*  v      *   The Coq Proof Assistant  /  The Coq Development Team     *)
 
3
(* <O___,, * CNRS-Ecole Polytechnique-INRIA Futurs-Universite Paris Sud *)
 
4
(*   \VV/  **************************************************************)
 
5
(*    //   *      This file is distributed under the terms of the       *)
 
6
(*         *       GNU Lesser General Public License Version 2.1        *)
 
7
(************************************************************************)
 
8
 
 
9
(*i $Id: declare.mli 12187 2009-06-13 19:36:59Z msozeau $ i*)
 
10
 
 
11
(*i*)
 
12
open Names
 
13
open Libnames
 
14
open Term
 
15
open Sign
 
16
open Declarations
 
17
open Entries
 
18
open Indtypes
 
19
open Safe_typing
 
20
open Nametab
 
21
open Decl_kinds
 
22
(*i*)
 
23
 
 
24
(* This module provides the official functions to declare new variables, 
 
25
   parameters, constants and inductive types. Using the following functions
 
26
   will add the entries in the global environment (module [Global]), will
 
27
   register the declarations in the library (module [Lib]) --- so that the
 
28
   reset works properly --- and will fill some global tables such as 
 
29
   [Nametab] and [Impargs]. *)
 
30
 
 
31
open Nametab
 
32
 
 
33
(* Declaration of local constructions (Variable/Hypothesis/Local) *)
 
34
 
 
35
type section_variable_entry =
 
36
  | SectionLocalDef of constr * types option * bool (* opacity *)
 
37
  | SectionLocalAssum of types * bool * identifier list (* Implicit status, Keep list *)
 
38
 
 
39
type variable_declaration = dir_path * section_variable_entry * logical_kind
 
40
 
 
41
val declare_variable : variable -> variable_declaration -> object_name
 
42
 
 
43
(* Declaration of global constructions *)
 
44
(* i.e. Definition/Theorem/Axiom/Parameter/... *)
 
45
 
 
46
type constant_declaration = constant_entry * logical_kind
 
47
 
 
48
(* [declare_constant id cd] declares a global declaration
 
49
   (constant/parameter) with name [id] in the current section; it returns
 
50
   the full path of the declaration *)
 
51
val declare_constant :
 
52
 identifier -> constant_declaration -> constant
 
53
 
 
54
val declare_internal_constant :
 
55
  identifier -> constant_declaration -> constant
 
56
 
 
57
(* [declare_mind me] declares a block of inductive types with
 
58
   their constructors in the current section; it returns the path of
 
59
   the whole block (boolean must be true iff it is a record) *)
 
60
val declare_mind : bool -> mutual_inductive_entry -> object_name
 
61
 
 
62
(* hooks for XML output *)
 
63
val set_xml_declare_variable : (object_name -> unit) -> unit
 
64
val set_xml_declare_constant : (bool * constant -> unit) -> unit
 
65
val set_xml_declare_inductive : (bool * object_name -> unit) -> unit