package octavius

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Types for the information collected in comments.

type style_kind =
  1. | SK_bold
  2. | SK_italic
  3. | SK_emphasize
  4. | SK_center
  5. | SK_left
  6. | SK_right
  7. | SK_superscript
  8. | SK_subscript
  9. | SK_custom of string

The differents kinds of style.

type ref_kind =
  1. | RK_element
  2. | RK_module
  3. | RK_module_type
  4. | RK_class
  5. | RK_class_type
  6. | RK_value
  7. | RK_type
  8. | RK_exception
  9. | RK_attribute
  10. | RK_method
  11. | RK_section
  12. | RK_recfield
  13. | RK_const
  14. | RK_custom of string

The differents kinds of element references.

type special_ref_kind =
  1. | SRK_module_list of string list
  2. | SRK_index_list
and text_element =
  1. | Raw of string
    (*

    Raw text.

    *)
  2. | Code of string
    (*

    The string is source code.

    *)
  3. | PreCode of string
    (*

    The string is pre-formatted source code.

    *)
  4. | Verbatim of string
    (*

    String 'as is'.

    *)
  5. | Style of style_kind * text
    (*

    Text tagged with a style.

    *)
  6. | List of text list
    (*

    A list.

    *)
  7. | Enum of text list
    (*

    An enumerated list.

    *)
  8. | Newline
    (*

    To force a line break.

    *)
  9. | Title of int * string option * text
    (*

    Style number, optional label, and text.

    *)
  10. | 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.

    *)
  11. | Special_ref of special_ref_kind
    (*

    Special kinds of reference

    *)
  12. | Target of string option * string
    (*

    (target, code) : to specify code for a specific target format

    *)
and text = text_element list

text is a list of text_elements. The order matters.

type see_ref =
  1. | See_url of string
  2. | See_file of string
  3. | See_doc of string

The different forms of references in @see tags.

type tag =
  1. | Author of string
    (*

    @author tag

    *)
  2. | Version of string
    (*

    @version tag

    *)
  3. | See of see_ref * text
    (*

    @see tag

    *)
  4. | Since of string
    (*

    @since tag

    *)
  5. | Before of string * text
    (*

    @before tag

    *)
  6. | Deprecated of text
    (*

    @deprecated tag

    *)
  7. | Param of string * text
    (*

    @param tag

    *)
  8. | Raised_exception of string * text
    (*

    @raise tag

    *)
  9. | Return_value of text
    (*

    @return tag

    *)
  10. | Inline
    (*

    @inline tag

    *)
  11. | Custom of string * text
    (*

    custom tag

    *)
  12. | Canonical of string
    (*

    @canonical tag

    *)

Tags

type t = text * tag list

A special comment

OCaml

Innovation. Community. Security.