package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (3)

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.document/Odoc_document/Doctree/Shift/index.html

Module `Doctree.Shift`

type state = {

englobing_level : int;
current_level : int;

}

val start : state

val shift : state -> int -> state * int

val enter : state -> int -> state

val walk_documentedsrc : 
  on_sub:
    ([> `Include of Types.Include.t | `Page of Types.Subpage.t ] -> int option) ->
  state ->
  Types.DocumentedSrc.t ->
  Types.DocumentedSrc.t

val subpage : 
  on_sub:
    ([> `Include of Types.Include.t | `Page of Types.Subpage.t ] -> int option) ->
  state ->
  Types.Subpage.t ->
  Types.Subpage.t

val include_ : 
  on_sub:
    ([> `Include of Types.Include.t | `Page of Types.Subpage.t ] -> int option) ->
  state ->
  Types.Include.t ->
  Types.Include.t

val walk_item : 
  on_sub:
    ([> `Include of Types.Include.t | `Page of Types.Subpage.t ] -> int option) ->
  state ->
  Types.Item.t list ->
  Types.Item.t list

val compute : 
  on_sub:
    ([> `Include of Types.Include.t | `Page of Types.Subpage.t ] -> int option) ->
  Types.Item.t list ->
  Types.Item.t list