Comment (reference.odoc.odoc.document.Odoc

Sourcemodule Comment = Odoc_model.Comment

Sourceval default_lang_tag : string

Sourcemodule Resources : sig ... end

Resource collection for extension handlers. Resources are collected during document generation and retrieved when building the final page.

Sourcemodule Assets : sig ... end

Asset collection for extension handlers. Assets (binary files like PNGs) are collected during document generation and written alongside the HTML output.

Sourceval source_of_code : string -> Types.Source.token list

Sourcemodule Reference : sig ... end

Sourceval leaf_inline_element : Comment.leaf_inline_element -> Types.Inline.one

Source

val non_link_inline_element : 
  Comment.non_link_inline_element ->
  Types.Inline.one

Source

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

Source

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

Sourceval inline_element : Comment.inline_element -> Types.Inline.t

Source

val inline_element_list : 
  Comment.inline_element Odoc_model.Location_.with_location list ->
  Types.Inline.t

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

Source

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

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

Source

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

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

Sourceval attached_block_element : Comment.attached_block_element -> Types.Block.t

Sourceval block_element : Comment.block_element -> Types.Block.t

Source

val heading_level_to_int : 
  [< `Paragraph
  | `Section
  | `Subparagraph
  | `Subsection
  | `Subsubsection
  | `Title ] ->
  int

Source

val heading : 
  (Comment.heading_attrs
   * [< `Label of 'a * Odoc_model.Names.LabelName.t ]
       Odoc_model.Paths.Identifier.id
   * Comment.inline_element Odoc_model.Location_.with_location list) ->
  Types.Item.t

Sourceval item_element : Comment.block_element -> Types.Item.t list

Source

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.

Source

val standalone : 
  Comment.block_element Odoc_model.Location_.with_location list ->
  Types.Item.t list

Sourceval to_ir : Comment.elements -> Types.Block.one list

Sourceval has_doc : 'a list -> bool