Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package octavius
Types for the information collected in comments.
and text_element = | Raw of string(*Raw text.
*)| Code of string(*The string is source code.
*)| PreCode of string(*The string is pre-formatted source code.
*)| Verbatim of string(*String 'as is'.
*)| Style of style_kind * text(*Text tagged with a style.
*)| List of text list(*A list.
*)| Enum of text list(*An enumerated list.
*)| Newline(*To force a line break.
*)| Title of int * string option * text(*Style number, optional label, and text.
*)| Ref of ref_kind * string * text option(*A reference to an element. Complete name and kind. An optional text can be given to display this text instead of the element name.
*)| Special_ref of special_ref_kind(*Special kinds of reference
*)| Target of string option * string(*(target, code) : to specify code for a specific target format
*)
and text = text_element listtext is a list of text_elements. The order matters.
The different forms of references in @see tags.
type tag = | Author of string(*@author tag
*)| Version of string(*@version tag
*)| See of see_ref * text(*@see tag
*)| Since of string(*@since tag
*)| Before of string * text(*@before tag
*)| Deprecated of text(*@deprecated tag
*)| Param of string * text(*@param tag
*)| Raised_exception of string * text(*@raise tag
*)| Return_value of text(*@return tag
*)| Inline(*@inline tag
*)| Custom of string * text(*custom tag
*)| Canonical of string(*@canonical tag
*)
Tags