diff options
| -rw-r--r-- | printing/ppconstr.mli | 2 | ||||
| -rw-r--r-- | printing/ppvernac.mli | 15 |
2 files changed, 16 insertions, 1 deletions
diff --git a/printing/ppconstr.mli b/printing/ppconstr.mli index a4c262b92..d2877edc5 100644 --- a/printing/ppconstr.mli +++ b/printing/ppconstr.mli @@ -15,7 +15,7 @@ include Ppconstrsig.Pp (** The rich pretty-printers produce {!Pp.std_ppcmds} that are interpreted as annotated strings. The annotations can be - retrieved using {!RichPp.rich_pp}. Their definitions is + retrieved using {!RichPp.rich_pp}. Their definitions are located in {!Ppannotation.t}. Please refer to {!RichPp} to know what are the requirements over diff --git a/printing/ppvernac.mli b/printing/ppvernac.mli index 0a8324bf8..616fc7345 100644 --- a/printing/ppvernac.mli +++ b/printing/ppvernac.mli @@ -6,4 +6,19 @@ (* * GNU Lesser General Public License Version 2.1 *) (************************************************************************) +(** This module implements pretty-printers for vernac_expr syntactic + objects and their subcomponents. *) + +(** The default pretty-printers produce {!Pp.std_ppcmds} that are + interpreted as raw strings. *) include Ppvernacsig.Pp + +(** The rich pretty-printers produce {!Pp.std_ppcmds} that are + interpreted as annotated strings. The annotations can be + retrieved using {!RichPp.rich_pp}. Their definitions are + located in {!Ppannotation.t}. + + Please refer to {!RichPp} to know what are the requirements over + [Indexer.index] behavior. *) +module RichPp (Indexer : sig val index : Ppannotation.t -> string end) + : Ppvernacsig.Pp |