Module Odoc_model.CommentSource

Sourcemodule Path = Paths.Path
Sourcemodule Reference = Paths.Reference
Sourcemodule Identifier = Paths.Identifier
Sourcetype 'a with_location = 'a 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 raw_markup_target * string
]
Sourcetype link_content = non_link_inline_element with_location list
Sourcetype reference_element = [
  1. | `Reference of Reference.t * link_content
]
Sourcetype inline_element = [
  1. | leaf_inline_element
  2. | `Styled of style * inline_element with_location list
  3. | reference_element
]
Sourcetype paragraph = inline_element with_location list
Sourcetype 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.

Sourcetype 'a cell = 'a with_location list * [ `Header | `Data ]
Sourcetype 'a row = 'a cell list
Sourcetype 'a grid = 'a row list
Sourcetype 'a abstract_table = {
  1. data : 'a grid;
  2. align : alignment option list option;
}
Sourcetype media_href = [
  1. | `Reference of Reference.Asset.t
]
Sourcetype media_element = [
  1. | `Media of media_href * media * string
]
Sourcetype code_block = {
  1. meta : Odoc_parser.Ast.code_block_meta option;
  2. delimiter : string option;
  3. content : string 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 : nestable_block_element with_location list option;
}
Sourceand nestable_block_element = [
  1. | `Paragraph of paragraph
  2. | `Code_block of code_block
  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
  8. | media_element
]
Sourcetype 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
  11. | `Custom of string * nestable_block_element with_location list
]
Sourcetype heading_level = [
  1. | `Title
  2. | `Section
  3. | `Subsection
  4. | `Subsubsection
  5. | `Paragraph
  6. | `Subparagraph
]
Sourcetype attached_block_element = [
  1. | nestable_block_element
  2. | `Tag of tag
]
Sourcetype heading_attrs = {
  1. heading_level : heading_level;
  2. heading_label_explicit : bool;
    (*

    Whether the label have been written by the user.

    *)
}
Sourcetype block_element = [
  1. | nestable_block_element
  2. | `Heading of heading_attrs * Identifier.Label.t * inline_element with_location list
  3. | `Tag of tag
]
Sourcetype elements = block_element with_location list
Sourcetype docs = {
  1. elements : elements;
  2. warnings_tag : string option;
}
Sourcetype docs_or_stop = [
  1. | `Docs of docs
  2. | `Stop
]
Sourceval 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.

Sourceval link_content_of_inline_element : inline_element with_location -> link_content
Sourceval link_content_of_inline_elements : inline_element with_location list -> non_link_inline_element with_location list
Sourceval find_zero_heading : [> `Heading of heading_attrs * 'a * inline_element with_location list ] Location_.with_location Odoc_utils.List.t -> link_content option
Sourceval to_string : link_content -> string