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>
  6. J
    Jules Aguillon <juloo.dsi@gmail.com>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>

Maintainers

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

Sources

odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

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

Module Odoc_model.SemanticsSource

Sourcetype _ handle_internal_tags =
  1. | Expect_status : [ `Default | `Inline | `Open | `Closed ] handle_internal_tags
  2. | Expect_canonical : [ `Dot of Paths.Path.Module.t * string ] option handle_internal_tags
  3. | Expect_none : unit handle_internal_tags

How to handle internal tags.

Sourcetype sections_allowed = [
  1. | `All
  2. | `No_titles
  3. | `None
]
Sourceval ast_to_comment : internal_tags:'tags handle_internal_tags -> sections_allowed:sections_allowed -> parent_of_sections:Paths.Identifier.LabelParent.t -> Odoc_parser.Ast.t -> (Comment.docs * 'tags) Error.with_warnings
Sourceval parse_comment : internal_tags:'tags handle_internal_tags -> sections_allowed:sections_allowed -> containing_definition:Paths.Identifier.LabelParent.t -> location:Lexing.position -> text:string -> (Comment.docs * 'tags) Error.with_warnings