package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

  1. T
    Thomas Refis <trefis@janestreet.com>
  2. D
    David Sheets <sheets@alum.mit.edu>
  3. L
    Leo White <leo@lpw25.net>
  4. Anton Bachin
  5. J
    Jon Ludlam <jon@recoil.org>

Maintainers

  1. J
    Jon Ludlam <jon@recoil.org>

Sources

odoc-1.5.3.tbz
sha256=f2b76f811658c4b52cb48ac4ffc2ec37cedd2a805111c7f8ec20f8f36b8bbf45
sha512=9e069590e0737c94813d25235b5cfe27feb5a0298a17ff9b9ee446c69827c3a0ea3b7da5d05b278639cd1f0202e0d83356707979edfaa2af73876fc000c23c4d

doc/odoc.model/Odoc_model/Comment/index.html

Module Odoc_model.Comment

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
]