package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

Dune Dependency

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

Authors

Maintainers

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.Semantics`

type _ handle_internal_tags =

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

How to handle internal tags.

type sections_allowed = [

| `All
| `No_titles
| `None

]

val 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

val 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

val parse_reference : 
  string ->
  Paths.Reference.t Error.with_errors_and_warnings