Module `Odoc_document.Comment`

module Comment = Odoc_model.Comment

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 non_link_inline_element : 
  Comment.non_link_inline_element ->
  Types.Inline.one

val non_link_inline_element_list : 
  Comment.non_link_inline_element Comment.with_location list ->
  Types.Inline.t

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 inline_element_list : 
  Comment.inline_element Odoc_model.Location_.with_location list ->
  Types.Inline.t

val module_references : Comment.module_reference list -> Types.Block.one

val nestable_block_element : Comment.nestable_block_element -> Types.Block.one

val paragraph : Comment.paragraph -> Types.Block.one

val nestable_block_element_list : 
  Comment.nestable_block_element Odoc_model.Location_.with_location list ->
  Types.Block.t

val tag : Comment.tag -> Types.Description.one

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 heading : 
  (Comment.heading_attrs
   * [< `Label of 'a * Odoc_model.Names.LabelName.t ]
   * Comment.non_link_inline_element Comment.with_location list) ->
  Types.Item.t

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 standalone : 
  Comment.block_element Odoc_model.Location_.with_location list ->
  Types.Item.t list

val to_ir : Comment.docs -> Types.Block.t

val has_doc : 'a list -> bool

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.document/Odoc_document/Comment/index.html

Module `Odoc_document.Comment`

package odoc

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.document/Odoc_document/Comment/index.html

Module Odoc_document.Comment

Module `Odoc_document.Comment`