package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (24)

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.0.0.tbz
sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b
sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

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

Module Odoc_model.CommentSource

Sourcemodule Path = Paths.Path
Sourcemodule Reference = Paths.Reference
Sourcemodule Identifier = Paths.Identifier
Sourcetype 'a with_location = 'a Location_.with_location
Sourcetype style = [
  1. | `Bold
  2. | `Italic
  3. | `Emphasis
  4. | `Superscript
  5. | `Subscript
]
Sourcetype alignment = [
  1. | `Left
  2. | `Center
  3. | `Right
]
Sourcetype media = [
  1. | `Image
  2. | `Audio
  3. | `Video
]
Sourcetype raw_markup_target = string
Sourcetype leaf_inline_element = [
  1. | `Space
  2. | `Word of string
  3. | `Code_span of string
  4. | `Math_span of string
  5. | `Raw_markup of raw_markup_target * string
]
Sourcetype link_content = non_link_inline_element with_location list
Sourcetype reference_element = [
  1. | `Reference of Reference.t * link_content
]
Sourcetype inline_element = [
  1. | leaf_inline_element
  2. | `Styled of style * inline_element with_location list
  3. | reference_element
]
Sourcetype paragraph = inline_element with_location list
Sourcetype module_reference = {
  1. module_reference : Reference.Module.t;
  2. module_synopsis : paragraph option;
}

The {!modules: ...} markup. module_synopsis is initially None, it is resolved during linking.

Sourcetype 'a cell = 'a with_location list * [ `Header | `Data ]
Sourcetype 'a row = 'a cell list
Sourcetype 'a grid = 'a row list
Sourcetype 'a abstract_table = {
  1. data : 'a grid;
  2. align : alignment option list option;
}
Sourcetype media_href = [
  1. | `Reference of Reference.Asset.t
]
Sourcetype media_element = [
  1. | `Media of media_href * media * string
]
Sourcetype nestable_block_element = [
  1. | `Paragraph of paragraph
  2. | `Code_block of string option * string with_location * nestable_block_element with_location list option
  3. | `Math_block of string
  4. | `Verbatim of string
  5. | `Modules of module_reference list
  6. | `Table of nestable_block_element abstract_table
  7. | `List of [ `Unordered | `Ordered ] * nestable_block_element with_location list list
  8. | media_element
]
Sourcetype 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 [ `Code_span of string | reference_element ] * 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. | `Alert of string * string option
]
Sourcetype heading_level = [
  1. | `Title
  2. | `Section
  3. | `Subsection
  4. | `Subsubsection
  5. | `Paragraph
  6. | `Subparagraph
]
Sourcetype attached_block_element = [
  1. | nestable_block_element
  2. | `Tag of tag
]
Sourcetype heading_attrs = {
  1. heading_level : heading_level;
  2. heading_label_explicit : bool;
    (*

    Whether the label have been written by the user.

    *)
}
Sourcetype block_element = [
  1. | nestable_block_element
  2. | `Heading of heading_attrs * Identifier.Label.t * inline_element with_location list
  3. | `Tag of tag
]
Sourcetype elements = block_element with_location list
Sourcetype docs = {
  1. elements : elements;
  2. warnings_tag : string option;
}
Sourcetype docs_or_stop = [
  1. | `Docs of docs
  2. | `Stop
]
Sourceval synopsis : [> `Paragraph of 'a ] Location_.with_location list -> 'a option

The synopsis is the first element of a comment if it is a paragraph. Otherwise, there is no synopsis.

Sourceval link_content_of_inline_element : inline_element with_location -> link_content
Sourceval link_content_of_inline_elements : inline_element with_location list -> non_link_inline_element with_location list
Sourceval find_zero_heading : [> `Heading of heading_attrs * 'a * inline_element with_location list ] Location_.with_location Odoc_utils.List.t -> link_content option
Sourceval to_string : link_content -> string
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