Module Odoc_model.Comment

module Path : sig ... end
module Reference : sig ... end
module Identifier : sig ... end
type !'a with_location
type style = [
  1. | `Bold
  2. | `Emphasis
  3. | `Italic
  4. | `Subscript
  5. | `Superscript
]
type alignment = [
  1. | `Center
  2. | `Left
  3. | `Right
]
type raw_markup_target = string
type leaf_inline_element = [
  1. | `Code_span of string
  2. | `Math_span of string
  3. | `Raw_markup of raw_markup_target * string
  4. | `Space
  5. | `Word of 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. | `Code_span of string
  2. | `Math_span of string
  3. | `Raw_markup of raw_markup_target * string
  4. | `Reference of Reference.t * link_content
  5. | `Space
  6. | `Styled of style * inline_element with_location list
  7. | `Word of string
]
type paragraph = inline_element with_location list
type module_reference = {
  1. module_reference : Reference.Module.t;
  2. module_synopsis : paragraph option;
}
type !'a cell = 'a with_location list * [ `Data | `Header ]
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. | `Code_block of string option * string with_location * nestable_block_element with_location list option
  2. | `List of [ `Ordered | `Unordered ] * nestable_block_element with_location list list
  3. | `Math_block of string
  4. | `Modules of module_reference list
  5. | `Paragraph of paragraph
  6. | `Table of nestable_block_element abstract_table
  7. | `Verbatim of string
]
type tag = [
  1. | `Alert of string * string option
  2. | `Author of string
  3. | `Before of string * nestable_block_element with_location list
  4. | `Deprecated of nestable_block_element with_location list
  5. | `Param of string * nestable_block_element with_location list
  6. | `Raise of [ `Code_span of string | `Reference of Reference.t * link_content ] * nestable_block_element with_location list
  7. | `Return of nestable_block_element with_location list
  8. | `See of [ `Document | `File | `Url ] * string * nestable_block_element with_location list
  9. | `Since of string
  10. | `Version of string
]
type heading_level = [
  1. | `Paragraph
  2. | `Section
  3. | `Subparagraph
  4. | `Subsection
  5. | `Subsubsection
  6. | `Title
]
type attached_block_element = [
  1. | `Code_block of string option * string with_location * nestable_block_element with_location list option
  2. | `List of [ `Ordered | `Unordered ] * nestable_block_element with_location list list
  3. | `Math_block of string
  4. | `Modules of module_reference list
  5. | `Paragraph of paragraph
  6. | `Table of nestable_block_element abstract_table
  7. | `Tag of tag
  8. | `Verbatim of string
]
type heading_attrs = {
  1. heading_level : heading_level;
  2. heading_label_explicit : bool;
}
type block_element = [
  1. | `Code_block of string option * string with_location * nestable_block_element with_location list option
  2. | `Heading of heading_attrs * Identifier.Label.t * inline_element with_location list
  3. | `List of [ `Ordered | `Unordered ] * nestable_block_element with_location list list
  4. | `Math_block of string
  5. | `Modules of module_reference list
  6. | `Paragraph of paragraph
  7. | `Table of nestable_block_element abstract_table
  8. | `Tag of tag
  9. | `Verbatim of string
]
type docs = block_element with_location list
type docs_or_stop = [
  1. | `Docs of docs
  2. | `Stop
]
val synopsis : [> `Paragraph of 'a ] Odoc_parser__Loc.with_location list -> 'a option
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