Module Odoc_model__Comment
module Path = Odoc_model.Paths.Path
module Reference = Odoc_model.Paths.Reference
module Identifier = Odoc_model.Paths.Identifier
type 'a with_location
= 'a Odoc_model.Location_.with_location
type style
=[
|
`Bold
|
`Italic
|
`Emphasis
|
`Superscript
|
`Subscript
]
type raw_markup_target
=[
|
`Html
]
type leaf_inline_element
=[
|
`Space
|
`Word of string
|
`Code_span of string
|
`Raw_markup of raw_markup_target * string
]
type non_link_inline_element
=[
|
leaf_inline_element
|
`Styled of style * non_link_inline_element with_location list
]
type link_content
= non_link_inline_element with_location list
type inline_element
=[
|
leaf_inline_element
|
`Styled of style * inline_element with_location list
|
`Reference of Reference.t * link_content
|
`Link of string * link_content
]
type nestable_block_element
=[
|
`Paragraph of inline_element with_location list
|
`Code_block of string
|
`Verbatim of string
|
`Modules of Reference.Module.t list
|
`List of [ `Unordered | `Ordered ] * nestable_block_element with_location list list
]
type tag
=[
|
`Author of string
|
`Deprecated of nestable_block_element with_location list
|
`Param of string * nestable_block_element with_location list
|
`Raise of string * nestable_block_element with_location list
|
`Return of nestable_block_element with_location list
|
`See of [ `Url | `File | `Document ] * string * nestable_block_element with_location list
|
`Since of string
|
`Before of string * nestable_block_element with_location list
|
`Version of string
|
`Canonical of Path.Module.t * Reference.Module.t
|
`Inline
|
`Open
|
`Closed
]
type heading_level
=[
|
`Title
|
`Section
|
`Subsection
|
`Subsubsection
|
`Paragraph
|
`Subparagraph
]
type block_element
=[
|
nestable_block_element
|
`Heading of heading_level * Identifier.Label.t * link_content
|
`Tag of tag
]
type docs
= block_element with_location list
type docs_or_stop
=[
|
`Docs of docs
|
`Stop
]