Module `Odoc_model.Frontmatter`Source

Sourcetype child =

| Page of string
| Dir of string
| Module of string

Sourcetype short_title = Odoc_model.Comment.link_content

Sourcetype line

type children_order =
  Odoc_model.Frontmatter.child Odoc_model.Location_.with_location list
    Odoc_model.Location_.with_location

Sourcetype t = {

children_order : Odoc_model.Frontmatter.children_order option;
short_title : Odoc_model.Frontmatter.short_title option;
toc_status : [ `Open | `Hidden ] option;
order_category : string option;

}

Sourceval empty : Odoc_model.Frontmatter.t

Source

type tag_payload =
  Odoc_model.Comment.nestable_block_element Odoc_model.Location_.with_location
    list

Source

val parse_children_order : 
  Odoc_model.Location_.span ->
  Odoc_model.Frontmatter.tag_payload ->
  (Odoc_model.Frontmatter.line Odoc_model.Location_.with_location,
    Odoc_model.Error.t)
    Stdlib.result

Source

val parse_short_title : 
  Odoc_model.Location_.span ->
  Odoc_model.Frontmatter.tag_payload ->
  (Odoc_model.Frontmatter.line Odoc_model.Location_.with_location,
    Odoc_model.Error.t)
    Stdlib.result

Source

val parse_toc_status : 
  Odoc_model.Location_.span ->
  Odoc_model.Frontmatter.tag_payload ->
  (Odoc_model.Frontmatter.line Odoc_model.Location_.with_location,
    Odoc_model.Error.t)
    Stdlib.result

Source

val parse_order_category : 
  Odoc_model.Location_.span ->
  Odoc_model.Frontmatter.tag_payload ->
  (Odoc_model.Frontmatter.line Odoc_model.Location_.with_location,
    Odoc_model.Error.t)
    Stdlib.result

Source

val of_lines : 
  Odoc_model.Frontmatter.line Odoc_model.Location_.with_location list ->
  Odoc_model.Frontmatter.t Odoc_model.Error.with_warnings

Module Odoc_model.FrontmatterSource

Module `Odoc_model.Frontmatter`Source