package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Path = Paths.Path
module Reference = Paths.Reference
module Identifier = Paths.Identifier
type 'a with_location = 'a Location_.with_location
type style = [
  1. | `Bold
  2. | `Italic
  3. | `Emphasis
  4. | `Superscript
  5. | `Subscript
]
type raw_markup_target = [
  1. | `Html
]
type leaf_inline_element = [
  1. | `Space
  2. | `Word of string
  3. | `Code_span of string
  4. | `Raw_markup of raw_markup_target * string
]
type link_content = non_link_inline_element with_location list
type inline_element = [
  1. | leaf_inline_element
  2. | `Styled of style * inline_element with_location list
  3. | `Reference of Reference.t * link_content
]
type nestable_block_element = [
  1. | `Paragraph of inline_element with_location list
  2. | `Code_block of string
  3. | `Verbatim of string
  4. | `Modules of Reference.Module.t list
  5. | `List of [ `Unordered | `Ordered ] * nestable_block_element with_location list list
]
type 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 string * 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. | `Canonical of Path.Module.t * Reference.Module.t
  11. | `Inline
  12. | `Open
  13. | `Closed
]
type heading_level = [
  1. | `Title
  2. | `Section
  3. | `Subsection
  4. | `Subsubsection
  5. | `Paragraph
  6. | `Subparagraph
]
type block_element = [
  1. | nestable_block_element
  2. | `Heading of heading_level * Identifier.Label.t * link_content
  3. | `Tag of tag
]
type docs = block_element with_location list
type docs_or_stop = [
  1. | `Docs of docs
  2. | `Stop
]
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct