package octavius

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
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
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
type special_ref_kind =
  1. | SRK_module_list of string list
  2. | SRK_index_list
and text_element =
  1. | Raw of string
  2. | Code of string
  3. | PreCode of string
  4. | Verbatim of string
  5. | Style of style_kind * text
  6. | List of text list
  7. | Enum of text list
  8. | Newline
  9. | Title of int * string option * text
  10. | Ref of ref_kind * string * text option
  11. | Special_ref of special_ref_kind
  12. | Target of string option * string
and text = text_element list
type see_ref =
  1. | See_url of string
  2. | See_file of string
  3. | See_doc of string
type tag =
  1. | Author of string
  2. | Version of string
  3. | See of see_ref * text
  4. | Since of string
  5. | Before of string * text
  6. | Deprecated of text
  7. | Param of string * text
  8. | Raised_exception of string * text
  9. | Return_value of text
  10. | Inline
  11. | Custom of string * text
  12. | Canonical of string
type t = text * tag list
OCaml

Innovation. Community. Security.