package doc-ock-html

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Page creator

doc-ock-html
- DocOckHtml
  - Documentation
  - Html_tree
    
    Relative_link
    
    Id
    
    page_creator
  - List_targets
  - Markup
    
    Type
  - To_html_tree
  - Url
    
    Anchor
    
    Module_listing
    
    Polymorphic_variant_decl
    
    Error

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = private {

name : string;
content : [ `Html ] Tyxml.Html.elt;
children : t list;

}

val traverse : 
  f:(parents:string list -> string -> [ `Html ] Tyxml.Html.elt -> unit) ->
  t ->
  unit

type kind = [

| `Arg
| `Mod
| `Mty
| `Class
| `Cty

]

These two functions are used to track the depth while building the tree, which is needed to produce correct links.

val enter : ?kind:kind -> string -> unit

val leave : unit -> unit

Page creator

class page_creator : ?kind:kind -> path:string list -> Html_types.div_content_fun Tyxml.Html.elt
                                       list -> object ... end

val set_page_creator : 
  (?kind:kind ->
    path:string list ->
    Html_types.div_content_fun Tyxml.Html.elt list ->
    page_creator) ->
  unit

val make : (Html_types.div_content_fun Tyxml.Html.elt list * t list) -> t

make (body, children) calls "the page creator" to turn body into an [ `Html ] elt. If set_page_creator was not called, a default creator is used.

module Relative_link : sig ... end

val render_fragment : 
  (_, _, DocOck.Paths.Fragment.sort) DocOck.Paths.Fragment.raw ->
  string

val open_details : bool Pervasives.ref

Whether <details> tags should be opened by default or not. Default is true.