ocamldoc-ify Markup.mli

This commit is contained in:
John David Pressman 2019-10-03 14:07:12 -07:00
parent 30d25ee247
commit c2489fd310

View File

@ -1,12 +1,11 @@
(* This module defines the sorts of markup recognised by the LIGO (** This module defines the sorts of markup recognised by the LIGO
lexer *) lexer *)
module Region = Simple_utils.Region module Region = Simple_utils.Region
(* A lexeme is piece of concrete syntax belonging to a token. In (** A lexeme is piece of concrete syntax belonging to a token. In
algebraic terms, a token is also a piece of abstract lexical algebraic terms, a token is also a piece of abstract lexical
syntax. Lexical units emcompass both markup and lexemes. *) syntax. Lexical units emcompass both markup and lexemes. *)
type lexeme = string type lexeme = string
type t = type t =
@ -19,7 +18,7 @@ type t =
type markup = t type markup = t
(* Pretty-printing of markup (** Pretty-printing of markup
The difference between [to_lexeme] and [to_string] is that the The difference between [to_lexeme] and [to_string] is that the
former builds the corresponding concrete syntax (the lexeme), former builds the corresponding concrete syntax (the lexeme),