package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Comment = Odoc_model.Comment
val default_lang_tag : string
val source_of_code : string -> Types.Source.token list
module Reference : sig ... end
val leaf_inline_element : Comment.leaf_inline_element -> Types.Inline.one
val link_content : Comment.non_link_inline_element Comment.with_location list -> Types.Inline.t
val inline_element : Comment.inline_element -> Types.Inline.t
val module_references : Comment.module_reference list -> Types.Block.one
val nestable_block_element : Comment.nestable_block_element -> Types.Block.one list
val nestable_block_element_list : Comment.nestable_block_element Comment.with_location list -> Types.Block.t
val attached_block_element : Comment.attached_block_element -> Types.Block.t
val block_element : Comment.block_element -> Types.Block.t
val heading_level_to_int : [< `Paragraph | `Section | `Subparagraph | `Subsection | `Subsubsection | `Title ] -> int
val item_element : Comment.block_element -> Types.Item.t list
val synopsis : decl_doc: [> `Paragraph of Comment.paragraph ] as 'a Odoc_model.Location_.with_location list -> expansion_doc:'a Odoc_model.Location_.with_location list option -> Types.Block.one list

The documentation of the expansion is used if there is no comment attached to the declaration.

val to_ir : Comment.docs -> Types.Block.one list
val has_doc : 'a list -> bool
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