package sherlodoc

  1. Overview
  2. Docs
Search engine for OCaml documentation

Install

dune-project
 Dependency

Authors

Maintainers

Sources

odoc-3.2.1.tbz
sha256=d45eb125514839fd9ac27702bb4938d1b4f3b6978e9b16ab9673ea067245affc
sha512=3555386b4770a7caa8ec903683bde5ecdc41d5e57ffaee617d5da225c747bbd1e9c1d2677f4df97e96bbdfc69f580ea83b1b92b933ea40a436a658788b677bbc

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.