Module Odoc_model.Comment

module Path = Paths.Path
module Reference = Paths.Reference
module Identifier = Paths.Identifier
type 'a with_location = 'a Location_.with_location
type style = [
  1. | `Bold
  2. | `Italic
  3. | `Emphasis
  4. | `Superscript
  5. | `Subscript
]
type alignment = [
  1. | `Left
  2. | `Center
  3. | `Right
]
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 raw_markup_target * string
]
type link_content = non_link_inline_element with_location list
type reference_element = [
  1. | `Reference of Reference.t * link_content
]
type inline_element = [
  1. | leaf_inline_element
  2. | `Styled of style * inline_element with_location list
  3. | reference_element
]
type paragraph = inline_element with_location list
type module_reference = {
  1. module_reference : Reference.Module.t;
  2. module_synopsis : paragraph option;
}

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

type 'a cell = 'a with_location list * [ `Header | `Data ]
type 'a row = 'a cell list
type 'a grid = 'a row list
type 'a abstract_table = {
  1. data : 'a grid;
  2. align : alignment option list option;
}
type nestable_block_element = [
  1. | `Paragraph of paragraph
  2. | `Code_block of string option * string with_location * nestable_block_element with_location list option
  3. | `Math_block of string
  4. | `Verbatim of string
  5. | `Modules of module_reference list
  6. | `Table of nestable_block_element abstract_table
  7. | `List of [ `Unordered | `Ordered ] * nestable_block_element with_location list list
]
type tag = [
  1. | `Author of string
  2. | `Deprecated of nestable_block_element with_location list
  3. | `Param of string * nestable_block_element with_location list
  4. | `Raise of [ `Code_span of string | reference_element ] * nestable_block_element with_location list
  5. | `Return of nestable_block_element with_location list
  6. | `See of [ `Url | `File | `Document ] * string * nestable_block_element with_location list
  7. | `Since of string
  8. | `Before of string * nestable_block_element with_location list
  9. | `Version of string
  10. | `Alert of string * string option
]
type heading_level = [
  1. | `Title
  2. | `Section
  3. | `Subsection
  4. | `Subsubsection
  5. | `Paragraph
  6. | `Subparagraph
]
type attached_block_element = [
  1. | nestable_block_element
  2. | `Tag of tag
]
type heading_attrs = {
  1. heading_level : heading_level;
  2. heading_label_explicit : bool;
    (*

    Whether the label have been written by the user.

    *)
}
type block_element = [
  1. | nestable_block_element
  2. | `Heading of heading_attrs * Identifier.Label.t * inline_element with_location list
  3. | `Tag of tag
]
type docs = block_element with_location list
type docs_or_stop = [
  1. | `Docs of docs
  2. | `Stop
]
val synopsis : [> `Paragraph of 'a ] 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 : inline_element with_location -> link_content
val link_content_of_inline_elements : inline_element with_location list -> non_link_inline_element with_location list