package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
type _ 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.

type sections_allowed = [
  1. | `All
  2. | `No_titles
  3. | `None
]
type alerts = [ `Tag of [ `Alert of string * string option ] ] Location_.with_location list
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 -> alerts -> (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:Stdlib.Lexing.position -> text:string -> (Comment.docs * 'tags) Error.with_warnings
val parse_reference : string -> Paths.Reference.t Error.with_errors_and_warnings
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