package sherlodoc

  1. Overview
  2. Docs
Search engine for OCaml documentation

Install

dune-project
 Dependency

Authors

Maintainers

Sources

odoc-3.1.0.tbz
sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914
sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05

doc/sherlodoc.db/Db/index.html

Module DbSource

Sourcemodule Entry : sig ... end
Sourcemodule Storage : sig ... end
Sourcemodule Type_polarity : sig ... end

This module provide a way to transform a type into strings, in such a way that the strings can be used for type search.

Sourcemodule Typexpr : sig ... end
Sourcemodule Occurences = Storage.Occurences
Sourcemodule String_automata : sig ... end

The type of a search database.

db_names is for text-based part of the query and db_types for the type-based part.

db_types has Entry.t array Int_map.t (Occ.t) as a payload because we want the query blabla : int -> int -> _ to return only entries that take at least two ints as arguments, an entry of type int -> string is invalid. The Int_map.t maps a number of occurences to a set of entries. See Occ. db_types still is a suffix tree, so you can search in it only for text. The way we transform types into searchable text is in Type_polarity.

OCaml

Innovation. Community. Security.