Module `Odoc_markdown.Renderer`Source

Sourceval is_control : char -> bool

Sourceval is_letter : char -> bool

Sourceval is_digit : char -> bool

Sourceval is_alphanum : char -> bool

Sourceval block_line_of_string : Stdlib.String.t -> string list

Sourcetype label = {

key : string;
text : string list;

}

Sourcemodule Inline : sig ... end

Sourcemodule Block : sig ... end

Sourcetype doc = Odoc_markdown.Renderer.Block.t

Sourcemodule Heterogeneous_dict : sig ... end

Sourcetype t = {

init_context : Odoc_markdown.Renderer.context -> Odoc_markdown.Renderer.doc -> unit;
inline : Odoc_markdown.Renderer.inline;
block : Odoc_markdown.Renderer.block;

}

Sourceand context = {

renderer : Odoc_markdown.Renderer.t;
mutable state : Odoc_markdown.Renderer.Heterogeneous_dict.t;
b : Stdlib.Buffer.t;

}

Source

and inline =
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.t ->
  unit

Source

and block =
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.t ->
  unit

Sourcemodule Context : sig ... end

Sourcetype indent = [

| `I of int
| `L of int * string * int * Stdlib.Uchar.t option

]

Sourcetype state = {

newline_to_output : string;
mutable start_of_text : bool;
mutable identation_stack : Odoc_markdown.Renderer.indent list;

}

Sourceval state : Odoc_markdown.Renderer.state Odoc_markdown.Renderer.Context.State.t

Sourceval get_state : Odoc_markdown.Renderer.context -> Odoc_markdown.Renderer.state

Sourceval init_context : Odoc_markdown.Renderer.context -> 'a -> unit

Sourcemodule Char_set : sig ... end

Sourceval esc_parens : Odoc_markdown.Renderer.Char_set.t

Sourceval esc_quote : Odoc_markdown.Renderer.Char_set.t

Sourceval esc_dquote : Odoc_markdown.Renderer.Char_set.t

Sourceval esc_link_label : Odoc_markdown.Renderer.Char_set.t

Sourceval buffer_add_dec_esc : Stdlib.Buffer.t -> char -> unit

Sourceval buffer_add_bslash_esc : Stdlib.Buffer.t -> char -> unit

Source

val buffer_add_escaped_string : 
  ?esc_ctrl:bool ->
  Stdlib.Buffer.t ->
  Odoc_markdown.Renderer.Char_set.t ->
  Stdlib.String.t ->
  unit

Source

val escaped_string : 
  ?esc_ctrl:bool ->
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Char_set.t ->
  Stdlib.String.t ->
  unit

Sourceval buffer_add_escaped_text : Stdlib.Buffer.t -> Stdlib.String.t -> unit

Sourceval escaped_text : Odoc_markdown.Renderer.context -> Stdlib.String.t -> unit

Sourceval nchars : Odoc_markdown.Renderer.context -> int -> char -> unit

Sourceval newline : Odoc_markdown.Renderer.context -> unit

Source

val push_indent : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.indent ->
  unit

Sourceval pop_indent : Odoc_markdown.Renderer.context -> unit

Sourceval indent : Odoc_markdown.Renderer.context -> unit

Source

val link_label_lines : 
  Odoc_markdown.Renderer.context ->
  Stdlib.String.t list ->
  unit

Source

val escaped_tight_block_lines : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Char_set.t ->
  Stdlib.String.t list ->
  unit

Sourceval block_lines : Odoc_markdown.Renderer.context -> string list -> unit

Sourceval break : Odoc_markdown.Renderer.context -> unit

Sourceval code_span : Odoc_markdown.Renderer.context -> string list -> unit

Source

val emphasis : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.t ->
  unit

Source

val strong_emphasis : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.t ->
  unit

Source

val link_title : 
  Odoc_markdown.Renderer.context ->
  char ->
  Stdlib.String.t list option ->
  unit

Source

val link : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.link ->
  unit

Source

val image : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.link ->
  unit

Sourceval text : Odoc_markdown.Renderer.context -> Stdlib.String.t -> unit

Source

val inline : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.t ->
  unit

Sourceval blank_line : Odoc_markdown.Renderer.context -> string -> unit

Source

val string_node_option : 
  Odoc_markdown.Renderer.context ->
  string option ->
  unit

Source

val code_block : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.code_block ->
  unit

Source

val heading : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.heading ->
  unit

Sourceval html_block : Odoc_markdown.Renderer.context -> string list -> unit

Source

val unordered_item : 
  Odoc_markdown.Renderer.context ->
  string ->
  Odoc_markdown.Renderer.Block.t ->
  unit

Source

val ordered_item : 
  Odoc_markdown.Renderer.context ->
  int ->
  Odoc_markdown.Renderer.Block.t ->
  int

Source

val unordered_list : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.t list ->
  unit

Source

val ordered_list : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.t list ->
  unit

Source

val paragraph : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Inline.t ->
  unit

Source

val table : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.Table.t ->
  unit

Source

val block : 
  Odoc_markdown.Renderer.context ->
  Odoc_markdown.Renderer.Block.t ->
  unit

Sourceval to_string : Odoc_markdown.Renderer.doc -> string

Module Odoc_markdown.RendererSource

Module `Odoc_markdown.Renderer`Source