jon.recoil.org
this repo has no description
1(** This library is intended for search engine that do not use the Json output
2 but Odoc as a library. Most search engine will use their own representation
3 instead of {!Odoc_index.Entry.t}, and may not want to store the whole HTML
4 in their database. This library contains functions that are useful for the
5 frontend of such search engines. These functions would have their place in
6 Odoc_searc.html, but putting them there means that you need to link to a lot
7 of dependencies to use them, and js-of-ocaml is unable to detect when these
8 dependencies are unused. *)
9
10val of_strings :
11 kind:string ->
12 prefix_name:string option ->
13 name:string option ->
14 rhs:string option ->
15 typedecl_params:string option ->
16 doc:string ->
17 string
18(** [of_string] generates the html of an entry using strings associated to the
19 relevant parts of the entry. If the strings have the correct values, it will
20 return the same HTML as {!Odoc_search.Html.of_entry}. Correct values are
21 given by {!Odoc_search.Html}, and for kinds, bellow. *)
22
23val kind_doc : string
24(** Kinds *)
25
26val kind_typedecl : string
27val kind_module : string
28val kind_exception : string
29val kind_class_type : string
30val kind_class : string
31val kind_method : string
32val kind_extension_constructor : string
33val kind_module_type : string
34val kind_constructor : string
35val kind_field : string
36val kind_value : string
37val kind_extension : string