Module Odoc_search.Html

val of_entry : Odoc_index.Entry.t -> html list
val url : Odoc_index.Entry.t -> string

The below is intended for search engine that do not use the Json output but Odoc as a library. Most search engine will use their own representation instead of Odoc_index.Entry.t, and may not want to store the whole HTML in their database. The following functions help give correct values to store in a search database.

val of_strings : kind:string -> prefix_name:string option -> name:string option -> rhs:string option -> typedecl_params:string option -> doc:string -> html list
val names_of_id : Odoc_model.Paths.Identifier.t -> string * string

names_of_id id is ("X.Y", "foo") if id corresponds to X.Y.foo. The tuple is intended to be given respectively to the prefix_name and name arguments of Odoc_html_frontend.of_strings.

of_doc d returns the HTML associated of the documentation comment d, generated correctly for search (no links or anchors).

val html_string_of_doc : Odoc_model.Comment.elements -> string

html_string_of_doc d is the same as of_doc converted to a string.

Right-hand sides

val rhs_of_kind : Odoc_index.Entry.kind -> string option

rhs_of_kind k is the right-hand-side string associated with the metadata included in the kind k. If k is Value _, it may be ": int"

val typedecl_params_of_entry : Odoc_index.Entry.t -> string option

typedecl_params_of_entry e is Some "'a" if the entry correspond to 'a t. If the entry is not a typedecl, or if the typedecl does not have a type parameter, then it returns None.