diff options
| author |  Pierre-Marie Pédrot <pierre-marie.pedrot@inria.fr> | 2016-06-09 16:50:07 +0200 |
|---|---|---|
| committer | Pierre-Marie Pédrot <pierre-marie.pedrot@inria.fr> | 2016-06-09 17:48:02 +0200 |
| commit | 7527751d9772656b4680df311546825cc2dd3d8f (patch) | |
| tree | 27c07324760d255939dcb9ec556bf8e309ab5186 /kernel/names.mli | |
| parent | 8efb78da7900e7f13105aac8361272477f8f5119 (diff) | |
Adding a bit of documentation in the mli.
Diffstat (limited to 'kernel/names.mli')
| -rw-r--r-- | kernel/names.mli | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/kernel/names.mli b/kernel/names.mli index 56f0f8c60..feaedc775 100644 --- a/kernel/names.mli +++ b/kernel/names.mli @@ -6,6 +6,20 @@ (* * GNU Lesser General Public License Version 2.1 *) (************************************************************************) +(** This file defines a lot of different notions of names used pervasively in + the kernel as well as in other places. The essential datatypes exported by + this API are: + + - Id.t is the type of identifiers, that is morally a subset of strings which + only contains Unicode characters of the Letter kind (and a few more). + - Name.t is an ad-hoc variant of Id.t option allowing to handle optionally + named objects. + - DirPath.t represents generic paths as sequences of identifiers. + - Label.t is an equivalent of Id.t made distinct for semantical purposes. + - ModPath.t are module paths. + - KerName.t are absolute names of objects in Coq. +*) + open Util (** {6 Identifiers } *) |