jon.recoil.org

Module Odoc_model.CommentSource

module Path = Odoc_model.Paths.Path
module Reference = Odoc_model.Paths.Reference
module Identifier = Odoc_model.Paths.Identifier
Sourcetype 'a with_location = 'a Odoc_model.Location_.with_location
Sourcetype style = [
  1. | `Bold
  2. | `Italic
  3. | `Emphasis
  4. | `Superscript
  5. | `Subscript
]
Sourcetype alignment = [
  1. | `Left
  2. | `Center
  3. | `Right
]
Sourcetype media = [
  1. | `Image
  2. | `Audio
  3. | `Video
]
Sourcetype raw_markup_target = string
Sourcetype 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
]
Sourcetype link_content = Odoc_model.Comment.non_link_inline_element Odoc_model.Comment.with_location list
Sourcetype reference_element = [
  1. | `Reference of Reference.t * Odoc_model.Comment.link_content
]
Sourcetype 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.

Sourcetype 'a cell = 'a Odoc_model.Comment.with_location list * [ `Header | `Data ]
Sourcetype 'a row = 'a Odoc_model.Comment.cell list
Sourcetype 'a grid = 'a Odoc_model.Comment.row list
Sourcetype 'a abstract_table = {
  1. data : 'a Odoc_model.Comment.grid;
  2. align : Odoc_model.Comment.alignment option list option;
}
Sourcetype media_href = [
  1. | `Reference of Reference.Asset.t
]
Sourcetype media_element = [
  1. | `Media of Odoc_model.Comment.media_href * Odoc_model.Comment.media * string
]
Sourcetype code_block = {
  1. meta : Odoc_parser.Ast.code_block_meta option;
  2. delimiter : string option;
  3. content : string Odoc_model.Comment.with_location;
    (*

    This is the raw content, that is the exact string inside the delimiters. In order to get the "processed" content, see Odoc_parser.codeblock_content

    *)
  4. output : Odoc_model.Comment.nestable_block_element Odoc_model.Comment.with_location list option;
}
Sourceand nestable_block_element = [
  1. | `Paragraph of Odoc_model.Comment.paragraph
  2. | `Code_block of Odoc_model.Comment.code_block
  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
]
Sourcetype heading_level = [
  1. | `Title
  2. | `Section
  3. | `Subsection
  4. | `Subsubsection
  5. | `Paragraph
  6. | `Subparagraph
]
Sourcetype attached_block_element = [
  1. | Odoc_model.Comment.nestable_block_element
  2. | `Tag of Odoc_model.Comment.tag
]
Sourcetype heading_attrs = {
  1. heading_level : Odoc_model.Comment.heading_level;
  2. heading_label_explicit : bool;
    (*

    Whether the label have been written by the user.

    *)
}
Sourcetype docs = {
  1. elements : Odoc_model.Comment.elements;
  2. warnings_tag : string option;
}
Sourcetype docs_or_stop = [
  1. | `Docs of Odoc_model.Comment.docs
  2. | `Stop
]
Sourceval 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.

Sourceval link_content_of_inline_element : Odoc_model.Comment.inline_element Odoc_model.Comment.with_location -> Odoc_model.Comment.link_content
Sourceval 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
Sourceval to_string : Odoc_model.Comment.link_content -> string