Module Odoc_parser.Ast

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 reference_kind = [
  1. | `Simple
  2. | `With_text
]
type inline_element = [
  1. | `Code_span of string
  2. | `Math_span of string
  3. | `Raw_markup of string option * string
  4. | `Reference of reference_kind * string with_location * inline_element with_location list
  5. | `Space of string
  6. | `Styled of style * inline_element with_location list
  7. | `Word of string
]
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 = 'a grid * alignment option list option
type code_block_meta = {
  1. language : string with_location;
  2. tags : string with_location option;
}
type code_block = {
  1. meta : code_block_meta option;
  2. delimiter : string option;
  3. content : string with_location;
  4. output : nestable_block_element with_location list option;
}
and nestable_block_element = [
  1. | `Code_block of code_block
  2. | `List of [ `Ordered | `Unordered ] * [ `Heavy | `Light ] * nestable_block_element with_location list list
  3. | `Math_block of string
  4. | `Modules of string with_location list
  5. | `Paragraph of inline_element with_location list
  6. | `Table of table
  7. | `Verbatim of string
]
and table = nestable_block_element abstract_table * [ `Heavy | `Light ]
type internal_tag = [
  1. | `Canonical of string with_location
  2. | `Closed
  3. | `Hidden
  4. | `Inline
  5. | `Open
]
type ocamldoc_tag = [
  1. | `Author of string
  2. | `Before of string * nestable_block_element with_location list
  3. | `Deprecated of nestable_block_element with_location list
  4. | `Param of string * nestable_block_element with_location list
  5. | `Raise of string * nestable_block_element with_location list
  6. | `Return of nestable_block_element with_location list
  7. | `See of [ `Document | `File | `Url ] * string * nestable_block_element with_location list
  8. | `Since of string
  9. | `Version of string
]
type tag = [
  1. | `Author of string
  2. | `Before of string * nestable_block_element with_location list
  3. | `Canonical of string with_location
  4. | `Closed
  5. | `Deprecated of nestable_block_element with_location list
  6. | `Hidden
  7. | `Inline
  8. | `Open
  9. | `Param of string * nestable_block_element with_location list
  10. | `Raise of string * nestable_block_element with_location list
  11. | `Return of nestable_block_element with_location list
  12. | `See of [ `Document | `File | `Url ] * string * nestable_block_element with_location list
  13. | `Since of string
  14. | `Version of string
]
type heading = int * string option * inline_element with_location list
type block_element = [
  1. | `Code_block of code_block
  2. | `Heading of heading
  3. | `List of [ `Ordered | `Unordered ] * [ `Heavy | `Light ] * nestable_block_element with_location list list
  4. | `Math_block of string
  5. | `Modules of string with_location list
  6. | `Paragraph of inline_element with_location list
  7. | `Table of table
  8. | `Tag of tag
  9. | `Verbatim of string
]