jon.recoil.org

Module Odoc_model.Comment

module Path = Odoc_model.Paths.Path
module Reference = Odoc_model.Paths.Reference
module Identifier = Odoc_model.Paths.Identifier
type 'a with_location = 'a Odoc_model.Location_.with_location
type style = [
  1. | `Bold
  2. | `Italic
  3. | `Emphasis
  4. | `Superscript
  5. | `Subscript
]
type alignment = [
  1. | `Left
  2. | `Center
  3. | `Right
]
type media = [
  1. | `Image
  2. | `Audio
  3. | `Video
]
type raw_markup_target = string
type leaf_inline_element = [
  1. | `Space
  2. | `Word of string
  3. | `Code_span of string
  4. | `Math_span of string
  5. | `Raw_markup of Odoc_model.Comment.raw_markup_target * string
]
type link_content = Odoc_model.Comment.non_link_inline_element Odoc_model.Comment.with_location list
type reference_element = [
  1. | `Reference of Reference.t * Odoc_model.Comment.link_content
]
type module_reference = {
  1. module_reference : Reference.Module.t;
  2. module_synopsis : Odoc_model.Comment.paragraph option;
}

The {!modules: ...} markup. module_synopsis is initially None, it is resolved during linking.

type 'a cell = 'a Odoc_model.Comment.with_location list * [ `Header | `Data ]
type 'a row = 'a Odoc_model.Comment.cell list
type 'a grid = 'a Odoc_model.Comment.row list
type 'a abstract_table = {
  1. data : 'a Odoc_model.Comment.grid;
  2. align : Odoc_model.Comment.alignment option list option;
}
type media_href = [
  1. | `Reference of Reference.Asset.t
]
type media_element = [
  1. | `Media of Odoc_model.Comment.media_href * Odoc_model.Comment.media * string
]
type nestable_block_element = [
  1. | `Paragraph of Odoc_model.Comment.paragraph
  2. | `Code_block of string option * string Odoc_model.Comment.with_location * Odoc_model.Comment.nestable_block_element Odoc_model.Comment.with_location list option
  3. | `Math_block of string
  4. | `Verbatim of string
  5. | `Modules of Odoc_model.Comment.module_reference list
  6. | `Table of Odoc_model.Comment.nestable_block_element Odoc_model.Comment.abstract_table
  7. | `List of [ `Unordered | `Ordered ] * Odoc_model.Comment.nestable_block_element Odoc_model.Comment.with_location list list
  8. | Odoc_model.Comment.media_element
]
type heading_level = [
  1. | `Title
  2. | `Section
  3. | `Subsection
  4. | `Subsubsection
  5. | `Paragraph
  6. | `Subparagraph
]
type attached_block_element = [
  1. | Odoc_model.Comment.nestable_block_element
  2. | `Tag of Odoc_model.Comment.tag
]
type heading_attrs = {
  1. heading_level : Odoc_model.Comment.heading_level;
  2. heading_label_explicit : bool;
    (*

    Whether the label have been written by the user.

    *)
}
type docs = {
  1. elements : Odoc_model.Comment.elements;
  2. warnings_tag : string option;
}
type docs_or_stop = [
  1. | `Docs of Odoc_model.Comment.docs
  2. | `Stop
]
val synopsis : [> `Paragraph of 'a ] Odoc_model.Location_.with_location list -> 'a option

The synopsis is the first element of a comment if it is a paragraph. Otherwise, there is no synopsis.

val link_content_of_inline_element : Odoc_model.Comment.inline_element Odoc_model.Comment.with_location -> Odoc_model.Comment.link_content
val link_content_of_inline_elements : Odoc_model.Comment.inline_element Odoc_model.Comment.with_location list -> Odoc_model.Comment.non_link_inline_element Odoc_model.Comment.with_location list
val to_string : Odoc_model.Comment.link_content -> string