Module `Octavius.Types`Source

Types for the information collected in comments.

Sourcetype style_kind =

The differents kinds of style.

Sourcetype ref_kind =

The differents kinds of element references.

Sourcetype special_ref_kind =

Sourceand 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
*)

Sourceand text = text_element list

text is a list of text_elements. The order matters.

Sourcetype see_ref =

The different forms of references in @see tags.

Sourcetype tag =

package octavius